{
"$schema": "https://ui.shadcn.com/schema/registry-item.json",
"name": "api-slate-range-docs",
"title": "Range",
"description": "API reference for ranges in Plate.",
"files": [
{
"path": "../../content/docs/api/slate/range.mdx",
"content": "---\ntitle: Range\ndescription: API reference for ranges in Plate.\n---\n\nA Range is a set of points that refer to a specific span of a Plate document. They can define a span inside a single node or span across multiple nodes. A range consists of two points: an anchor (start) and a focus (end).\n\n```typescript\ntype TRange = {\n anchor: Point\n focus: Point\n}\n```\n\n- [Point](/docs/api/slate/point)\n\n## `RangeAPI`\n\n### `transform`\n\nTransform a range by an operation.\n\n\n\n \n The range to transform.\n \n \n The operation to apply to the range.\n \n \n Options for transforming the range.\n \n\n\n\n \n The direction to prefer when transforming the range.\n \n\n\n\n The transformed range, or `null` if the range was deleted.\n\n\n\n### `edges`\n\nGet the start and end points of a range.\n\n\n\n \n The range to get edges from.\n \n \n Options for retrieving edges.\n \n\n\n\n \n If true, returns points in reverse order.\n \n\n\n\n A tuple of points representing the start and end points.\n\n\n\n### `end`\n\nGet the end point of a range.\n\n\n\n \n The range to get the end point from.\n \n\n\n\n The end point of the range.\n\n\n\n### `equals`\n\nCheck if two ranges are exactly equal.\n\n\n\n \n The first range to compare.\n \n \n The second range to compare.\n \n\n\n\n `true` if the ranges are exactly equal.\n\n\n\n### `includes`\n\nCheck if a range includes a path, point, or part of another range.\n\n\n\n \n The range to check.\n \n \n The target to check for inclusion.\n \n\n\n\n `true` if the range includes the target.\n\n\n\n### `intersection`\n\nGet the intersection of two ranges.\n\n\n\n \n The first range.\n \n \n The second range.\n \n\n\n\n The intersecting range, or `null` if there is no intersection.\n\n\n\n### `isBackward`\n\nCheck if a range is backward (anchor point appears after focus point).\n\n\n\n \n The range to check.\n \n\n\n\n `true` if the range is backward.\n\n\n\n### `isCollapsed`\n\nCheck if a range is collapsed (both points refer to the same position).\n\n\n\n \n The range to check.\n \n\n\n\n `true` if the range exists and is collapsed.\n\n\n\n### `isExpanded`\n\nCheck if a range is expanded (not collapsed).\n\n\n\n \n The range to check.\n \n\n\n\n `true` if the range exists and is expanded.\n\n\n\n### `isForward`\n\nCheck if a range is forward (anchor point appears before focus point).\n\n\n\n \n The range to check.\n \n\n\n\n `true` if the range is forward.\n\n\n\n### `isRange`\n\nCheck if a value implements the `TRange` interface.\n\n\n\n \n The value to check.\n \n\n\n\n `true` if the value is a range.\n\n\n\n### `points`\n\nIterate through all point entries in a range.\n\n\n\n \n The range to iterate through.\n \n\n\n\">\n A generator that yields point entries.\n\n\n\n### `start`\n\nGet the start point of a range.\n\n\n\n \n The range to get the start point from.\n \n\n\n\n The start point of the range.\n\n\n\n### `surrounds`\n\nCheck if a range completely surrounds another range.\n\n\n\n \n The range that might surround the target.\n \n \n The target range that might be surrounded.\n \n\n\n\n `true` if the range surrounds the target.\n\n\n\n## Types\n\n### `TRange`\n\n`TRange` objects are a set of points that refer to a specific span of a Plate document. They can define a span inside a \nsingle node or span across multiple nodes.\n\n`Range` is a type alias for `TRange`.\n\n\n\n \n The start point of the range.\n \n \n The end point of the range.\n \n\n\n",
"type": "registry:file",
"target": "content/docs/plate/api/slate/range.mdx"
}
],
"type": "registry:file"
}