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]]
Signature:export interface EditorPluginProps<S extends StateType = StateType, Config extends {} = {}>
Properties
| Property | Type | Description |
|---|---|---|
| autofocusRef | React.RefObject<HTMLInputElement & HTMLTextAreaElement> | Ref to use for an input element. The element will receive focus, when the plugin is focused. |
| config | Config | Plugin configuration |
| editable | boolean | true if the document is currently editable |
| focused | boolean | true if the document is currently focused |
| id | string | ID of the document |
| state | StateTypeReturnType<S> | Current state of the document, see StateTypeReturnType |
Methods
| Method | Description |
|---|---|
| renderIntoSettings(children) | Allows the plugin to render into the plugin settings |
| renderIntoToolbar(children) | Allows the plugin to render buttons into the toolbar |
