1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-09 00:36:41 +02:00

docs: specify default value of edge in Editor.point as start (#5765)

Clarify in the documentation that the default value for `edge` in `Editor.point` is `start`.
This is helpful for developers who are not deeply familiar with the framework but need to quickly use it for development.
They no longer need to inspect the source code or experiment with sample code to understand the default behavior.
This commit is contained in:
Pengfei Han
2024-11-27 02:49:43 +08:00
committed by GitHub
parent 40686c2ebb
commit 6bc5758358

View File

@@ -165,7 +165,7 @@ Options: `{depth?: number, edge?: 'start' | 'end'}`
#### `Editor.point(editor: Editor, at: Location, options?) => Point`
Get the start or end point of a location.
Get the `start` or `end` (default is `start`) point of a location.
Options: `{edge?: 'start' | 'end'}`