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

export interface DocumentEditorProps


childrenReact.ReactNode(BETA) The rendered document
focusedboolean(BETA) true if the document is focused
hasSettingsboolean(BETA) true if the document has rendered any settings
hasToolbarboolean(BETA) true if the document has rendered any toolbar buttons
settingsRefReact.RefObject<HTMLDivElement>(BETA) The rendered settings
toolbarRefReact.RefObject<HTMLDivElement>(BETA) The rendered toolbar buttons


renderSettings(children, { close })?(BETA) (Optional) Render prop to override rendering of settings
renderToolbar(children)?(BETA) (Optional) Render prop to override rendering of toolbar