diff --git a/apps/www/content/docs/en/api/slate/editor-api.mdx b/apps/www/content/docs/en/api/slate/editor-api.mdx index 76a345aa3e..f6369dfd12 100644 --- a/apps/www/content/docs/en/api/slate/editor-api.mdx +++ b/apps/www/content/docs/en/api/slate/editor-api.mdx @@ -158,12 +158,6 @@ editor.api.block({ highest: true }) // Get highest block at selection ``` - - - Options for getting a block. - - - Common query options for matching blocks. @@ -204,12 +198,6 @@ editor.api.block({ highest: true }) // Get highest block at selection Returns all matching blocks. - - - Options for finding and filtering block nodes in the editor. - - - Common query options for matching blocks. @@ -245,12 +233,6 @@ Returns the edge blocks above a location (default: selection). Useful for retrieving the start and end block of a range. - - - Options for finding the edge block nodes at a location. - - - Common query options for matching blocks. @@ -309,7 +291,6 @@ Get the fragment at a location or selection. Options for extracting and processing the fragment. - Types of structural nodes to unwrap. @@ -436,12 +417,6 @@ editor.api.isAt({ end: true }) // Check if at end ``` - - - Options for checking the location's position relative to various boundaries. - - - The location to check. Defaults to current selection. @@ -531,7 +506,6 @@ editor.api.isEmpty(at, { block: true }) // Check if block above location is empt Options for determining emptiness. - @@ -616,7 +590,6 @@ Check if a path is selected by the current selection. Options for checking selection. - Check if selection contains the entire path range. @@ -641,7 +614,6 @@ Get the leaf text node at a location. Options for getting the leaf. - The depth to traverse to find the leaf. @@ -661,12 +633,6 @@ Get the leaf text node at a location. Iterate through all levels at a location. This includes all ancestors up to the root editor node. - - - Options for iterating levels. - - - Common query options for matching levels. @@ -697,7 +663,6 @@ Get the last node at a location. Options for getting the last node. - Get last node at this level (0-based). @@ -740,12 +705,6 @@ Get the marks that would be added to text at the current selection. Get the matching node in the branch of the document after a location. - - - Options for getting the next node. - - - Common query options for matching nodes. @@ -784,7 +743,6 @@ Get the node at a location or find the first node that matches options. Options for getting a node. - The depth to traverse to find the node. @@ -804,12 +762,6 @@ Get the node at a location or find the first node that matches options. Iterate through all nodes in the editor that match the given options. - - - Options for finding and filtering nodes in the editor. - - - Common query options for matching nodes. @@ -854,7 +806,6 @@ Get the parent node of a location. Options for getting the parent node. - Number of levels to traverse up to find the parent. @@ -874,12 +825,6 @@ Get the parent node of a location. Get the matching node in the branch of the document before a location. - - - Options for getting the previous node. - - - Common query options for matching nodes. @@ -912,12 +857,6 @@ Get the matching node in the branch of the document before a location. Get a property value from a list of nodes. Returns `undefined` if the property value is not consistent across all nodes. - - - Options for retrieving and comparing property values across nodes. - - - The list of nodes to get the property value from. @@ -956,7 +895,6 @@ Get the text string content of a location. Options for getting text content. - Whether to include text content from void nodes. @@ -973,12 +911,6 @@ Get the text string content of a location. Match a void node in the current branch of the editor. - - - Options for finding void nodes. - - - The location to search from. Defaults to current selection. @@ -1011,7 +943,6 @@ Find the path of a Slate node in the editor. Options for finding the node's path. - Common query options for finding nodes. @@ -1067,7 +998,6 @@ Get the `start` or `end` (default is `start`) point of a location. Options for getting the point. - Which edge of the location to get the point from. @@ -1084,12 +1014,6 @@ Get the `start` or `end` (default is `start`) point of a location. Iterate through all possible point positions in the document. - - - Options for iterating point positions. - - - Where to start iterating. Defaults to editor selection. @@ -1137,12 +1061,6 @@ Returns the range spanning the given node entries. Create a range between two locations. - - - Options for creating a range. - - - The location to create the range at. Defaults to current selection. @@ -1173,7 +1091,6 @@ Get the start point of a location. Options for getting the start point. - Get the start point of the next node instead of the current one. @@ -1205,7 +1122,6 @@ Note that `unhangRange` is designed for the specific purpose of fixing triple-cl Options for un-hanging the range. - Allow placing the end of the selection in a void node. @@ -1330,7 +1246,6 @@ Create a mutable ref for a `Path`. Options for the path reference. - The direction to resolve the ref when ambiguous: @@ -1368,7 +1283,6 @@ Create a mutable ref for a `Point`. Options for the point reference. - The direction to resolve the ref when ambiguous: @@ -1406,7 +1320,6 @@ Create a mutable ref for a `Range`. Options for the range reference. - The direction to resolve the ref when ambiguous: @@ -1500,7 +1413,6 @@ Check if a DOM node is within the editor. Options for checking the DOM node. - Whether to check if the node is in an editable element. @@ -1709,12 +1621,6 @@ Find a Slate range from a DOM range. Called when there is a change in the editor. - - - Options for onChange. - - - The operation that triggered the change. @@ -1776,12 +1682,6 @@ Determines whether to remove the previous node when merging nodes. Controls whether the editor should normalize after an operation. Override this method to prevent normalizing in certain situations. - - - Options for normalizing. - - - The paths that need to be normalized. diff --git a/apps/www/content/docs/en/api/slate/editor-transforms.mdx b/apps/www/content/docs/en/api/slate/editor-transforms.mdx index 61ca0ea06e..e0efcd1b06 100644 --- a/apps/www/content/docs/en/api/slate/editor-transforms.mdx +++ b/apps/www/content/docs/en/api/slate/editor-transforms.mdx @@ -12,10 +12,6 @@ Transforms are helper functions that manipulate a Slate document. Duplicates nodes at a location and inserts them after that location. - - - - `insertNodes` options. @@ -108,10 +104,6 @@ Insert one or more nodes atomically. Lift nodes at the specified location upwards in the document tree. If necessary, the parent node is split. - - - - @@ -124,10 +116,6 @@ Lift nodes at the specified location upwards in the document tree. If necessary, Merge a node at the specified location with the previous node at the same depth. Resulting empty container nodes are removed. - - - - @@ -145,10 +133,6 @@ Merge a node at the specified location with the previous node at the same depth. Move the nodes from an origin to a destination. - - - - @@ -170,10 +154,6 @@ Move the nodes from an origin to a destination. Remove nodes at a location. - - - - @@ -218,10 +198,6 @@ Replace nodes at a location with new nodes. Reset the editor state including history, selection and children. - - - - `replaceNodes` options. @@ -263,10 +239,6 @@ Set properties on nodes. Split nodes at a location. - - - - @@ -330,10 +302,6 @@ Remove properties from nodes. Unwrap a node at a location. If necessary, the parent node is split. - - - - @@ -374,10 +342,6 @@ Wrap nodes at a location in the `element` container. Delete text at a location. - - - - @@ -423,10 +387,6 @@ Delete text forward. Delete a fragment of nodes. - - - - Direction to delete. @@ -484,10 +444,6 @@ Unset the selection. Move the selection's point forward or backward. - - - - How many units to move. Defaults to 1. @@ -640,10 +596,6 @@ editor.tf.toggleMark('subscript', { remove: 'superscript'}) // Remove superscrip Collapse the selection to a point. - - - - Edge to collapse to. Defaults to `'anchor'`. @@ -660,10 +612,6 @@ Unset the current selection. Move the selection's point. - - - - Defaults to 1. @@ -766,10 +714,6 @@ editor.tf.focus({ edge: 'endEditor' }) ``` - - - - Select this location before focusing. @@ -949,10 +893,6 @@ Normalize a node according to the editor's schema. Normalize dirty nodes in the editor. - - - - When true, forcibly re-normalize all nodes.