{
"$schema": "https://ui.shadcn.com/schema/registry-item.json",
"name": "api-slate-text-docs",
"title": "Text",
"description": "API reference for text nodes in Plate.",
"files": [
{
"path": "../../content/docs/api/slate/text.mdx",
"content": "---\ntitle: Text\ndescription: API reference for text nodes in Plate.\n---\n\nA Text node contains the actual text content of a Plate document along with any formatting properties. They are always leaf nodes in the document tree as they cannot contain any children.\n\n```ts\ntype TText = {\n text: string\n [key: string]: unknown\n}\n```\n\n## `TextApi`\n\n### `decorations`\n\n\n\n \n The text node to get leaves from.\n \n \n The array of decorated ranges to apply.\n \n\n\n\n An array of leaves and their positions. The position is undefined if there is a single leaf.\n\n\n\n### `equals`\n\n\n\n \n The first text node to compare.\n \n \n The second text node to compare.\n \n \n Additional comparison options.\n \n\n\n\n \n If `true`, the text content is not compared. This is used to check\n whether sibling text nodes can be merged based only on their\n formatting properties.\n \n\n\n\n `true` if the text nodes are equal according to the comparison rules.\n\n\n\n### `isText`\n\n\n\n \n The value to check.\n \n\n\n\n `true` if the value is a valid text node.\n\n\n\n### `isTextList`\n\n\n\n \n The value to check.\n \n\n\n\n `true` if the value is an array of text nodes.\n\n\n\n### `isTextProps`\n\n\n\n \n The props to check.\n \n\n\n\n `true` if the props match a partial text node structure.\n\n\n\n### `matches`\n\n\n\n \n The text node to check.\n \n \">\n The properties to match against.\n \n\n\n\n `true` if the text node matches the properties.\n\n\n\n## Types\n\n### `TText`\n\n`Text` is a type alias for `TText`.\n\n\n\n \n The text content of the node.\n \n \n Additional formatting properties that can be added to the text node.\n \n\n\n\n### `TextEntry` \n\nText entries represent a Text node and its path.\n\n\n\n \n The Text node.\n \n \n The path to the text node.\n \n\n\n\n### `DecoratedRange`\n\nA range object that includes decoration information. Used to apply formatting or styling to specific ranges of text within a document.\n\n### `TextOf`\n\nA utility type that extracts all possible text node types from a root node type.\n\n\n\n \n The root node type to extract text types from.\n \n\n\n\n### `TextIn`\n\nA utility type that extracts all text node types from a `Value` type.\n\n\n\n \n The `Value` type to extract text types from.\n \n\n\n\n### `MarksOf`\n\nA utility type that extracts all possible mark types from a root node type. Marks are the formatting properties that can be applied to text nodes.\n\n\n\n \n The root node type to extract mark types from.\n \n\n\n\n### `MarksIn`\n\nA utility type that extracts all mark types from a `Value` type. Similar to `MarksOf` but works specifically with editor `Value` types.\n\n\n\n \n The `Value` type to extract mark types from.\n \n\n\n\n### `MarkKeysOf`\n\nA utility type that extracts all possible mark property keys from a node type.\n\n\n\n \n The node type to extract mark keys from.\n \n\n",
"type": "registry:file",
"target": "content/docs/plate/api/slate/text.mdx"
}
],
"type": "registry:file"
}