editoad v0.2.0

This project was bootstrapped with Create React App.

You can find the most recent version of the Create React App scripts guide here.

Docs

masterReducer

The entry point reducer for the application. All state changes that are non-visual start here.

Parameters

• state State (optional, default defaultState)
• action Object

Returns State

editorReducer

Reducer for editor data.

Parameters

• state Editor
• action Object
• rootState State

Returns Editor

documentReducer

Reducer for Document data.

Parameters

• state Document
• action Action
• rootState State

Returns Document

newRow

Returns a new Row.

Parameters

• type RowTypes

Returns Row

newColumn

Returns a new Column.

Parameters

• type ContentTypes
• value string
• options Object

Returns Column

Layout elements define the layout of the page. Layout elements are the containers for Block elements.

blockElements

Block elements are the elements that fit inside layout elements. They are the content of the page.

Type: {}

Button

Extends React.Component

View and edit properties for a selected element.

Divider

Extends React.Component

View and edit properties for a selected element.

HTML

Extends React.Component

View and edit properties for a selected element.

Image

Extends React.Component

View and edit properties for a selected element.

Text

Extends React.Component

View and edit properties for a selected element.

QuillToolbar

Extends React.PureComponent

View and edit properties for a selected element.

Empty

Extends React.Component

Empty Block element.

collect

Specifies which props to inject into the Document component.

Parameters

• connect Object
• monitor Object

collect

Specifies which props to inject into the Document component.

Parameters

• connect Object
• monitor Object

collect

Specifies the props to inject into the Block Component.

Parameters

• connect Object
• monitor Object

Returns Object

collect

Specifies the props to inject into your component.

Parameters

• connect Object
• monitor Object

Returns Object

collect

Specifies which props to inject into the Document component.

Parameters

• connect Object
• monitor Object

TableCell

Extends React.Component

View and edit properties for a selected element.

Parameters

• props

App

Extends React.Component

Container Component for the application

ActionBar

Extends React.Component

Component with shortcuts to common commands

getCode

Get the code from the hidden DOM element rendering the generated document

Returns {type: string, code: string}

addLayout

Add Layout element to the Document.

Parameters

• layoutType string
• insertAtIndex number

Returns {type: string, layoutType: string, insertAtIndex: number}

addBlock

Add Block element to the Document.

Parameters

• blockType string
• insertAtRowIndex number
• insertAtCellIndex number

Returns {type: string, blockType: string, insertAtRowIndex: number, insertAtCellIndex: number}

editEditorSize

Set the size of the editor (in pixels)

Parameters

• size number

Returns {type: string, size: number}

editSelectedElement

Select an element by ID, setting it's to edit mode.

Parameters

• element_id string
• rowIndex number
• cellIndex number

Returns {type: string, element_id: string, rowIndex: number, cellIndex: number}

editBlockValue

Edit the value of a block/cell.

Parameters

• value (string | number)

Returns {type: string, value: (string | number)}

Drawer

Extends React.Component

View and edit the settings for an editor element.

Implements the drag source contract.

Block

React DnD wrapper for Block list element.

Type: React.ComponentType<any>

BuildingBlocks

Extends React.Component

Lists all Block elements. Drag and Drop functionality.

Implements the drag source contract.

Layouts

Extends React.Component

List of ready-made layouts/rows users can use to build to templates. Drag and drop functionality.

Properties

Extends React.Component

View and edit properties for a selected element.

Settings

Extends React.Component

View and edit properties for a selected element.

Editor

Extends React.Component

View and modify the document.

Document

Extends React.Component

The document to be edited. Document is shown in the Editor component and is a visualisation of the created form.

Parameters

• props Object

Table

Extends React.Component

View and edit properties for a selected element.

Fonts

Extends React.PureComponent

View and edit properties for a selected element.