mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-09-01 19:22:35 +02:00
Code Issues Releases Wiki Activity

Update transforms.md (#5819)

Browse Source 
1.improved grammar
2.improved puntuations
3.improved the readability
This commit is contained in:
Mohataseem Khan
2025-03-17 07:57:15 +05:30
committed by GitHub
parent a94fe72bd1
commit c183827ca8
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/api/transforms.md
View File

@@ -11,7 +11,9 @@ Transforms are helper functions operating on the document. They can be used in d
## Node options ## Node options
All transforms support a parameter `options`. This includes options specific to the transform, and general `NodeOptions` to specify which Nodes in the document that the transform is applied to. All transforms support a parameter `options`. This includes options specific to the transform and general `NodeOptions` to specify which Nodes in the document the transform is applied to.
```typescript ```typescript
interface NodeOptions { interface NodeOptions {
@@ -34,11 +36,11 @@ interface NodeOptions {
### Node transforms ### Node transforms
Transforms that operate on nodes. These transforms operate on nodes.
#### `Transforms.insertFragment(editor: Editor, fragment: Node[], options?)` #### `Transforms.insertFragment(editor: Editor, fragment: Node[], options?)`
Insert of fragment of nodes at the specified location or (if not defined) the current selection or (if not defined) the end of the document. Insert a fragment of nodes at the specified location or (if not defined) the current selection or (if not defined) the end of the document.
Options: `{at?: Location, hanging?: boolean, voids?: boolean}` Options: `{at?: Location, hanging?: boolean, voids?: boolean}`
@@ -95,7 +97,8 @@ Options supported: `NodeOptions & {split?: boolean}`. For `options.mode`, `'all'
Set properties of nodes at the specified location. If no location is specified, use the selection. Set properties of nodes at the specified location. If no location is specified, use the selection.
if `props` contains `undefined` values, the node's corresponding property will also be set to `undefined` as opposed to ignored. If `props` contains `undefined` values, the node's corresponding property will also be set to `undefined` as opposed to ignored.
Options supported: `NodeOptions & {hanging?: boolean, split?: boolean}`. For `options.mode`, `'all'` is also supported. Options supported: `NodeOptions & {hanging?: boolean, split?: boolean}`. For `options.mode`, `'all'` is also supported.