Editor Component

This article discusses the API and props of the core controlled contentEditable component itself, Editor. Props are defined within DraftEditorProps.

Props #

Basics #

See API Basics for an introduction.

editorState #

editorState: EditorState

The EditorState object to be rendered by the Editor.

onChange #

onChange: (editorState: EditorState) => void

The onChange function to be executed by the Editor when edits and selection changes occur.

Presentation (Optional) #

placeholder #

placeholder?: string

Optional placeholder string to display when the editor is empty.

Note: You can use CSS to style or hide your placeholder as needed. For instance, in the rich editor example, the placeholder is hidden when the user changes block styling in an empty editor. This is because the placeholder may not line up with the cursor when the style is changed.

textAlignment #

textAlignment?: DraftTextAlignment

Optionally set the overriding text alignment for this editor. This alignment value will apply to the entire contents, regardless of default text direction for input text.

You may use this if you wish to center your text or align it flush in one direction to fit it within your UI design.

If this value is not set, text alignment will be based on the characters within the editor, on a per-block basis.

textDirectionality #

textDirectionality?: DraftTextDirectionality

Optionally set the overriding text directionality for this editor. The values include 'RTL' for right-to-left text, like Hebrew or Arabic, and 'LTR' for left-to-right text, like English or Spanish. This directionality will apply to the entire contents, regardless of default text direction for input text.

If this value is not set, text directionality will be based on the characters within the editor, on a per-block basis.

blockRendererFn #

blockRendererFn?: (block: ContentBlock) => ?Object

Optionally set a function to define custom block rendering. See Advanced Topics: Block Components for details on usage.

blockStyleFn #

blockStyleFn?: (block: ContentBlock) => string

Optionally set a function to define class names to apply to the given block when it is rendered. See Advanced Topics: Block Styling for details on usage.

customStyleMap #

customStyleMap?: Object

Optionally define a map of inline styles to apply to spans of text with the specified style. See Advanced Topics: Inline Styles for details on usage.

customStyleFn #

customStyleFn?: (style: DraftInlineStyle, block: ContentBlock) => ?Object

Optionally define a function to transform inline styles to CSS objects that are applied to spans of text. See Advanced Topics: Inline Styles for details on usage.

Behavior (Optional) #

autoCapitalize?: string #

autoCapitalize?: string

Set if auto capitalization is turned on and how it behaves. More about platform availability and usage can be found on mdn.

autoComplete?: string #

autoComplete?: string

Set if auto complete is turned on and how it behaves. More about platform availability and usage can be found on mdn.

autoCorrect?: string #

autoCorrect?: string

Set if auto correct is turned on and how it behaves. More about platform availability and usage can be found on mdn.

readOnly #

readOnly?: boolean

Set whether the editor should be rendered as static DOM, with all editability disabled.

This is useful when supporting interaction within custom block components or if you just want to display content for a static use case.

Default is false.

spellCheck #

spellCheck?: boolean

Set whether spellcheck is turned on for your editor.

Note that in OSX Safari, enabling spellcheck also enables autocorrect, if the user has it turned on. Also note that spellcheck is always disabled in IE, since the events needed to observe spellcheck events are not fired in IE.

Default is false.

stripPastedStyles #

stripPastedStyles?: boolean

Set whether to remove all information except plaintext from pasted content.

This should be used if your editor does not support rich styles.

Default is false.

DOM and Accessibility (Optional) #

tabIndex #

ARIA props #

These props allow you to set accessibility properties on your editor. See DraftEditorProps for the exhaustive list of supported attributes.

editorKey #

editorKey?: string

You probably won't set editorKey on an <Editor /> manually unless you're rendering a Draft component serverside. If you are, you must set this prop to avoid server/client mismatches.

If the key is not set, it is generated automatically when the component renders and assigned as a prop of the Editor's <DraftEditorContents /> component.

If you do set this prop, the key should be unique per-editor, as it is used to determine if styles should be preserved when pasting text within an editor.

Cancelable Handlers (Optional) #

These prop functions are provided to allow custom event handling for a small set of useful events. By returning 'handled' from your handler, you indicate that the event is handled and the Draft core should do nothing more with it. By returning 'not-handled', you defer to Draft to handle the event.

handleReturn #

handleReturn?: (e: SyntheticKeyboardEvent, editorState: EditorState) => DraftHandleValue

Handle a RETURN keydown event. Example usage: Choosing a mention tag from a rendered list of results to trigger applying the mention entity to your content.

handleKeyCommand #

handleKeyCommand?: (command: string, editorState: EditorState) => DraftHandleValue

Handle the named editor command. See Advanced Topics: Key Bindings for details on usage.

handleBeforeInput #

handleBeforeInput?: (chars: string, editorState: EditorState) => DraftHandleValue

Handle the characters to be inserted from a beforeInput event. Returning 'handled' causes the default behavior of the beforeInput event to be prevented (i.e. it is the same as calling the preventDefault method on the event). Example usage: After a user has typed - at the start of a new block, you might convert that ContentBlock into an unordered-list-item.

At Facebook, we also use this to convert typed ASCII quotes into "smart" quotes, and to convert typed emoticons into images.

handlePastedText #

handlePastedText?: (text: string, html?: string, editorState: EditorState) => DraftHandleValue

Handle text and html(for rich text) that has been pasted directly into the editor. Returning true will prevent the default paste behavior.

handlePastedFiles #

handlePastedFiles?: (files: Array<Blob>) => DraftHandleValue

Handle files that have been pasted directly into the editor.

handleDroppedFiles #

handleDroppedFiles?: (selection: SelectionState, files: Array<Blob>) => DraftHandleValue

Handle files that have been dropped into the editor.

handleDrop #

handleDrop?: (selection: SelectionState, dataTransfer: Object, isInternal: DraftDragType) => DraftHandleValue

Handle other drop operations.

Key Handlers (Optional) #

These prop functions expose common useful key events. Example: At Facebook, these are used to provide keyboard interaction for mention results in inputs.

onEscape #

onEscape?: (e: SyntheticKeyboardEvent) => void

onTab #

onTab?: (e: SyntheticKeyboardEvent) => void

onUpArrow #

onUpArrow?: (e: SyntheticKeyboardEvent) => void

onRightArrow #

onRightArrow?: (e: SyntheticKeyboardEvent) => void

onDownArrow #

onDownArrow?: (e: SyntheticKeyboardEvent) => void

keyBindingFn #

keyBindingFn?: (e: SyntheticKeyboardEvent) => void

This prop lets you handle key events directly and provides an opportunity to return custom editor commands. You can find a more detailed explanation of this here.

onLeftArrow #

onLeftArrow?: (e: SyntheticKeyboardEvent) => void

Mouse events #

onFocus #

onFocus?: (e: SyntheticFocusEvent) => void

onBlur #

onBlur?: (e: SyntheticFocusEvent) => void

Methods #

focus #

focus(): void

Force focus back onto the editor node.

blur #

blur(): void

Remove focus from the editor node.