CodeX Editor Tools

CodeX Editor is a block-oriented editor. It means that entry composed with the list of Blocks of different types: Texts, Headers, Images, Quotes etc.

Tool — is a class that provide custom Block type. All Tools represented by Plugins.

Tool class structure

Constructor

Render

Save

Validate

Merge (optional)

Method that specifies how to merge two Blocks of the same type, for example on Backspace keypress. Method does accept data object in same format as the Render and it should provide logic how to combine new data with the currently stored value.

Available settings

Name	Type	Default Value	Description
`displayInToolbox`	Boolean	`false`	Pass `true` to display this `Tool` in the Editor's `Toolbox`
`iconClassName`	String	—	CSS class name for the `Toolbox` icon. Used when `displayInToolbox` is `true`
`irreplaceable`	Boolean	`false`	By default, empty `Blocks` can be replaced by other `Blocks` with the `Toolbox`. Some tools with media-content may prefer another behaviour. Pass `true` and `Toolbox` will add a new block below yours.
`contentless`	Boolean	`false`	Pass `true` for Tool which represents decorative empty `Blocks`

1.3 KiB Raw Blame History