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__plugin > EditorPluginProps

EditorPluginProps interface

Props for the component of an [[EditorPlugin]]

export interface EditorPluginProps<S extends StateType = StateType, Config extends {} = {}>


autofocusRefReact.RefObject<HTMLInputElement & HTMLTextAreaElement>Ref to use for an input element. The element will receive focus, when the plugin is focused.
configConfigPlugin configuration
editablebooleantrue if the document is currently editable
focusedbooleantrue if the document is currently focused
idstringID of the document
stateStateTypeReturnType<S>Current state of the document, see StateTypeReturnType


renderIntoSettings(children)Allows the plugin to render into the plugin settings
renderIntoToolbar(children)Allows the plugin to render buttons into the toolbar