{
"$schema": "https://ui.shadcn.com/schema/registry-item.json",
"name": "api-slate-point-docs",
"title": "Point",
"description": "API reference for points in Plate.",
"files": [
{
"path": "../../content/docs/api/slate/point.mdx",
"content": "---\ntitle: Point\ndescription: API reference for points in Plate.\n---\n\nA Point represents a specific location in a Plate document. It consists of a path to a text node and an offset within that text node's content.\n\n```typescript\ntype Point = {\n path: Path\n offset: number\n}\n```\n\n- [Path](/docs/api/slate/path)\n\n## `PointAPI`\n\n### `get`\n\nGet a point from a location.\n\n\n\n \n The location to get the point from. Can be a `TRange`, `Point`, or `Path`.\n \n \n Additional options for point retrieval.\n \n\n\n\n \n If true and the location is a range, returns the focus point instead of the anchor point.\n \n\n\n\n The point at the specified location, or `undefined` if not found.\n\n\n\n### `transform`\n\nTransform a point by an operation.\n\n\n\n \n The point to transform.\n \n \n The operation to apply.\n \n \n Options for transforming the point.\n \n\n\n\n \n The direction to prefer when transforming the point.\n \n\n\n\n The transformed point, or `null` if the point was deleted.\n\n\n\n### `compare`\n\nCompare a point to another.\n\n\n\n \n The first point to compare.\n \n \n The second point to compare.\n \n\n\n\n `-1` if before, `0` if at the same location, `1` if after.\n\n\n\n### `equals`\n\nCheck if two points are exactly equal.\n\n\n\n \n The first point to compare.\n \n \n The second point to compare.\n \n\n\n\n `true` if the points are equal, `false` otherwise.\n\n\n\n### `isAfter`\n\nCheck if a point is after another.\n\n\n\n \n The point to check.\n \n \n The point to compare against.\n \n\n\n\n `true` if the first point is after the second.\n\n\n\n### `isBefore`\n\nCheck if a point is before another.\n\n\n\n \n The point to check.\n \n \n The point to compare against.\n \n\n\n\n `true` if the first point is before the second.\n\n\n\n### `isPoint`\n\nCheck if a value implements the `Point` interface.\n\n\n\n \n The value to check.\n \n\n\n\n `true` if the value is a point.\n\n\n\n## Types\n\n### `Point`\n\nA point represents a specific location in a Plate document.\n\n\n\n \n The index of the character in the text node.\n \n \n The path to the text node.\n \n\n\n### `PointEntry`\n\nA point entry is returned when iterating over `Point` objects that belong to a range.\n\n\n\n \n The point location.\n \n \n Indicates whether this point is the anchor or focus of a range.\n \n\n",
"type": "registry:file",
"target": "content/docs/plate/api/slate/point.mdx"
}
],
"type": "registry:file"
}