mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-13 18:53:59 +02:00
Code Issues Releases Wiki Activity

Add return types to documentation of ReactEditor

Browse Source
This commit is contained in:
Sunny Hirai
2023-04-13 08:47:53 -07:00
parent 3d1c6936dc
commit 5f1baec200
1 changed files with 22 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/libraries/slate-react/react-editor.md
View File

@@ -16,88 +16,90 @@ const [editor] = useState(() => withReact(withHistory(createEditor())))
### Check methods ### Check methods
#### `ReactEditor.isComposing(editor: ReactEditor)` #### `ReactEditor.isComposing(editor: ReactEditor): boolean`
Check if the user is currently composing inside the editor. Check if the user is currently composing inside the editor.
#### `ReactEditor.isFocused(editor: ReactEditor)` #### `ReactEditor.isFocused(editor: ReactEditor): boolean`
Check if the editor is focused. Check if the editor is focused.
#### `ReactEditor.isReadOnly(editor: ReactEditor)` #### `ReactEditor.isReadOnly(editor: ReactEditor): boolean`
Check if the editor is in read-only mode. Check if the editor is in read-only mode.
### Focus and selection methods ### Focus and selection methods
#### `ReactEditor.blur(editor: ReactEditor)` #### `ReactEditor.blur(editor: ReactEditor): void`
Blur the editor. Blur the editor.
#### `ReactEditor.focus(editor: ReactEditor)` #### `ReactEditor.focus(editor: ReactEditor): void`
Focus the editor. Focus the editor.
#### `ReactEditor.deselect(editor: ReactEditor)` #### `ReactEditor.deselect(editor: ReactEditor): void`
Deselect the editor. Deselect the editor.
### DOM translation methods ### DOM translation methods
#### `ReactEditor.findKey(editor: ReactEditor, node: Node)` #### `ReactEditor.findKey(editor: ReactEditor, node: Node): Key`
Find a key for a Slate node. Find a key for a Slate node.
#### `ReactEditor.findPath(editor: ReactEditor, node: Node)` Returns an instance of `Key` which looks like `{ id: string }`
#### `ReactEditor.findPath(editor: ReactEditor, node: Node): Path`
Find the path of Slate node. Find the path of Slate node.
#### `ReactEditor.hasDOMNode(editor: ReactEditor, target: DOMNode, options: { editable?: boolean } = {})` #### `ReactEditor.hasDOMNode(editor: ReactEditor, target: DOMNode, options: { editable?: boolean } = {}): boolean`
Check if a DOM node is within the editor. Check if a DOM node is within the editor.
#### `ReactEditor.toDOMNode(editor: ReactEditor, node: Node)` #### `ReactEditor.toDOMNode(editor: ReactEditor, node: Node): HTMLElement`
Find the native DOM element from a Slate node. Find the native DOM element from a Slate node.
#### `ReactEditor.toDOMPoint(editor: ReactEditor, point: Point)` #### `ReactEditor.toDOMPoint(editor: ReactEditor, point: Point): DOMPoint`
Find a native DOM selection point from a Slate point. Find a native DOM selection point from a Slate point.
#### `ReactEditor.toDOMRange(editor: ReactEditor, range: Range)` #### `ReactEditor.toDOMRange(editor: ReactEditor, range: Range): DOMRange`
Find a native DOM range from a Slate `range`. Find a native DOM range from a Slate `range`.
#### `ReactEditor.toSlateNode(editor: ReactEditor, domNode: DOMNode)` #### `ReactEditor.toSlateNode(editor: ReactEditor, domNode: DOMNode): Node`
Find a Slate node from a native DOM `element`. Find a Slate node from a native DOM `element`.
#### `ReactEditor.findEventRange(editor: ReactEditor, event: any)` #### `ReactEditor.findEventRange(editor: ReactEditor, event: any): Range`
Get the target range from a DOM `event`. Get the target range from a DOM `event`.
#### `ReactEditor.toSlatePoint(editor: ReactEditor, domPoint: DOMPoint)` #### `ReactEditor.toSlatePoint(editor: ReactEditor, domPoint: DOMPoint): Point | null`
Find a Slate point from a DOM selection's `domNode` and `domOffset`. Find a Slate point from a DOM selection's `domNode` and `domOffset`.
#### `ReactEditor.toSlateRange(editor: ReactEditor, domRange: DOMRange | DOMStaticRange | DOMSelection, options?: { exactMatch?: boolean } = {})` #### `ReactEditor.toSlateRange(editor: ReactEditor, domRange: DOMRange | DOMStaticRange | DOMSelection, options?: { exactMatch?: boolean } = {}): Range | null`
Find a Slate range from a DOM range or selection. Find a Slate range from a DOM range or selection.
### DataTransfer methods ### DataTransfer methods
#### `ReactEditor.insertData(editor: ReactEditor, data: DataTransfer)` #### `ReactEditor.insertData(editor: ReactEditor, data: DataTransfer): void`
Insert data from a `DataTransfer` into the editor. This is a proxy method to call in this order `insertFragmentData(editor: ReactEditor, data: DataTransfer)` and then `insertTextData(editor: ReactEditor, data: DataTransfer)`. Insert data from a `DataTransfer` into the editor. This is a proxy method to call in this order `insertFragmentData(editor: ReactEditor, data: DataTransfer)` and then `insertTextData(editor: ReactEditor, data: DataTransfer)`.
#### `ReactEditor.insertFragmentData(editor: ReactEditor, data: DataTransfer)` #### `ReactEditor.insertFragmentData(editor: ReactEditor, data: DataTransfer): true`
Insert fragment data from a `DataTransfer` into the editor. Returns true if some content has been effectively inserted. Insert fragment data from a `DataTransfer` into the editor. Returns true if some content has been effectively inserted.
#### `ReactEditor.insertTextData(editor: ReactEditor, data: DataTransfer)` #### `ReactEditor.insertTextData(editor: ReactEditor, data: DataTransfer): true`
Insert text data from a `DataTransfer` into the editor. Returns true if some content has been effectively inserted. Insert text data from a `DataTransfer` into the editor. Returns true if some content has been effectively inserted.
#### `ReactEditor.setFragmentData(editor: ReactEditor, data: DataTransfer, originEvent?: 'drag' | 'copy' | 'cut')` #### `ReactEditor.setFragmentData(editor: ReactEditor, data: DataTransfer, originEvent?: 'drag' | 'copy' | 'cut'): void`
Sets data from the currently selected fragment on a `DataTransfer`. Sets data from the currently selected fragment on a `DataTransfer`.