4.9 KiB
<Editor>
import { Editor } from 'slate'
The top-level React component that renders the Slate editor itself.
Properties
<Editor
className={string}
onChange={Function}
plugins={Array}
readOnly={Boolean}
state={State}
style={Object}
/>
className
String
An optional class name to apply to the content editable element.
onChange
Function onChange(state: State)
A change handler that will be called with the newly-changed editor state. You should usually pass the newly changed state back into the editor through its state property. This hook allows you to add persistence logic to your editor.
onDocumentChange
Function onDocumentChange(document: Document, state: State)
A convenience handler property that will only be called for changes in state where the document has changed. It is called with the changed document and state.
onSelectionChange
Function onSelectionChange(selection: Selection, state: State)
A convenience handler property that will only be called for changes in state where the selection has changed. It is called with the changed selection and state.
plugins
Array
An array of Plugins that define the editor's behavior.
readOnly
Boolean
Whether the editor should be in "read-only" mode, where all of the rendering is the same, but the user is prevented from editing the editor's content.
state
State
A State object representing the current state of the editor.
style
Object
An optional dictionary of styles to apply to the content editable element.
tabIndex
Indicates if it should participate to sequential keyboard navigation.
role
ARIA property to define the role of the editor, it defaults to textbox when editable.
Placeholder Properties
<Editor
placeholder={String || Element}
placeholderClassName={String}
placeholderStyle={Object}
/>
placeholder
String || Element
A placeholder string (or React element) that will be rendered as the default block type's placeholder.
placeholderClassName
String
An optional class name to apply to the default block type's placeholder.
placeholderStyle
Object
An optional dictionary of styles to apply to the default block type's placeholder. If placeholder is a string, and no class name or style dictionary is passed, this property will default to { opacity: '0.333' }.
Plugin-like Properties
In addition to its own properties, the editor allows passing any of the properties that a plugin defines as well.
These properties are actually just a convenience—an implicit plugin definition. Internally, they are grouped together and turned into a plugin that is given first priority in the plugin stack.
For example, these two snippets of code are equivalent:
const plugins = [
somePlugin
]
<Editor
onKeyDown={myKeyHandler}
plugins={plugins}
state={state}
/>
const editorPlugin = {
onKeyDown: myKeyHandler
}
const plugins = [
editorPlugin,
somePlugin
]
<Editor
plugins={plugins}
state={state}
/>
onBeforeInput
onBlur
onFocus
onCopy
onCut
onDrop
onKeyDown
onPaste
onSelect
schema
To see how these properties behave, check out the Plugins reference.
Methods
blur
blur() => Void
Programmatically blur the editor.
focus
focus() => Void
Programmatically focus the editor.
getSchema
getSchema() => Schema
Return the editor's current schema.
getState
getState() => State
Return the editor's current state.
onChange
onChange(state: State) => Void
Effectively the same as setState. Invoking this method will update the state of the editor, running it through all of it's plugins, and passing it the parent component, before it cycles back down as the new state property of the editor.