mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-28 09:29:49 +02:00
Code Issues Releases Wiki Activity

docs: Simplify heading names in Editor API docs

Browse Source
This commit is contained in:
Sunny Hirai
2021-04-23 22:57:01 -07:00
parent ea2eefefb8
commit de159f99f8
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/api/nodes/editor.md
View File

@@ -345,7 +345,7 @@ const withImages = editor => {
} }
``` ```
### Override element type methods ### Element type methods
Use these methods so that Slate can identify certain elements as [inlines](../../concepts/02-nodes.md#blocks-vs-inlines) or [voids](../../concepts/02-nodes.md#voids). Use these methods so that Slate can identify certain elements as [inlines](../../concepts/02-nodes.md#blocks-vs-inlines) or [voids](../../concepts/02-nodes.md#voids).
@@ -357,13 +357,13 @@ Check if a value is an inline `Element` object.
Check if a value is a void `Element` object. Check if a value is a void `Element` object.
### Override normalize method ### Normalize method
#### `normalizeNode(entry: NodeEntry)` #### `normalizeNode(entry: NodeEntry)`
[Normalize](../../concepts/11-normalizing.md) a Node according to the schema. [Normalize](../../concepts/11-normalizing.md) a Node according to the schema.
### Override callback method ### Callback method
#### `onChange()` #### `onChange()`
@@ -379,7 +379,7 @@ Add a custom property to the leaf text nodes in the current selection. If the se
Remove a custom property from the leaf text nodes in the current selection. Remove a custom property from the leaf text nodes in the current selection.
### Override delete methods ### Delete methods
When a user presses backspace or delete, it invokes the method based on the selection. For example, if the selection is expanded over some text and the user presses the backspace key, `deleteFragment` will be called but if the selecttion is collapsed, `deleteBackward` will be called. When a user presses backspace or delete, it invokes the method based on the selection. For example, if the selection is expanded over some text and the user presses the backspace key, `deleteFragment` will be called but if the selecttion is collapsed, `deleteBackward` will be called.
@@ -395,7 +395,7 @@ Delete content in the editor forward from the current selection.
Delete the content of the current selection. Delete the content of the current selection.
### Override insert methods ### Insert methods
#### `insertFragment(fragment: Node[])` #### `insertFragment(fragment: Node[])`
@@ -413,7 +413,7 @@ Insert a node at the current selection. If the selection is currently expanded,
Insert text at the current selection. If the selection is currently expanded, delete it first. Insert text at the current selection. If the selection is currently expanded, delete it first.
### Override operation handling method ### Operation handling method
#### `apply(operation: Operation)` #### `apply(operation: Operation)`