The API reference is a Work in Progress and will be continuously improved and extended. We'd love to hear your feedback in our documentation repository.
Home > @edtr-io/internal__document-editor > DocumentEditorProps
DocumentEditorProps interface
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Allows to override the default rendering behavior of the document editor
Signature:export interface DocumentEditorProps
Properties
| Property | Type | Description |
|---|---|---|
| children | React.ReactNode | (BETA) The rendered document |
| focused | boolean | (BETA) true if the document is focused |
| hasSettings | boolean | (BETA) true if the document has rendered any settings |
| hasToolbar | boolean | (BETA) true if the document has rendered any toolbar buttons |
| PluginToolbar | PluginToolbar | (BETA) |
| settingsRef | React.RefObject<HTMLDivElement> | (BETA) The rendered settings |
| toolbarRef | React.RefObject<HTMLDivElement> | (BETA) The rendered toolbar buttons |
Methods
| Method | Description |
|---|---|
| renderSettings(children, { close })? | (BETA) (Optional) Render prop to override rendering of settings |
| renderToolbar(children)? | (BETA) (Optional) Render prop to override rendering of toolbar |
