DocFlux

Module: Document

A Document is a wrapper to a component where you can call the create method to create the document object. Generally you will inherit from this class to create document type specific Documents. This class will create the root component, render the component tree, then transform the component tree passing a document builder object created in createDocument. It will return the document builder object afterwards.

Members

<abstract> component

The component to render

defaultProps

Default props

propTypes

Prop types for validation

Methods

<static> create(initialProps)

Creates a document

Parameters:
Name Type Description
initialProps object

The props to pass to the component
Returns:

The document generated

Type
object

<abstract> createBuilder()

Creates the document builder for transforming

<abstract> createDocument()

Creates the document from the document builder. This Gets returned on create.