{
"$schema": "https://ui.shadcn.com/schema/registry-item.json",
"name": "api-slate-element-docs",
"title": "Element",
"description": "API reference for elements in Slate.",
"files": [
{
"path": "../../content/docs/api/slate/element.mdx",
"content": "---\ntitle: Element\ndescription: API reference for elements in Slate.\n---\n\n`TElement` objects are a type of `Node` in a Plate document that contain other `TElement` nodes or `Text` nodes.\n\n```typescript\ninterface TElement {\n children: Descendant[]\n type: string\n [key: string]: unknown\n}\n```\n\n## Element Behavior\n\nElements can have different behaviors depending on the editor's configuration:\n\n### Block vs Inline\n\nElements can be either \"block\" or \"inline\" as defined by plugin `node.isInline`:\n\n- Block elements can only be siblings with other block elements\n- Inline elements can be siblings with Text nodes or other inline elements\n\n### Void vs Non-void\n\nElements can be either \"void\" or \"non-void\" as defined by plugin `node.isVoid`:\n\n- Non-void elements: Slate handles rendering of children (e.g., paragraph with Text and Inline children)\n- Void elements: Children are rendered by the Element's render code\n\n### Markable Voids\n\nSome void elements can support marks through plugin `node.markableVoid`. For example, a mention element might need to support bold or italic formatting.\n\n## `ElementAPI`\n\n### `isElementType`\n\nCheck if a value implements the `TElement` interface and has `elementKey` matching a specified value. Defaults to checking the `'type'` key.\n\n\n\n \n The value to check.\n \n \n The value to match against.\n \n \n The key to check. Defaults to `'type'`.\n \n\n\n\n `true` if the value is an element with the specified key matching `elementVal`.\n\n\n\n### `isAncestor`\n\nCheck if a value implements the `Ancestor` interface.\n\n\n\n \n The value to check.\n \n\n\n\n `true` if the value is an ancestor node.\n\n\n\n### `isElement`\n\nCheck if a value implements the `TElement` interface.\n\n\n\n \n The value to check.\n \n\n\n\n `true` if the value is a Plate element.\n\n\n\n### `isElementList`\n\nCheck if a value is an array of `TElement` objects.\n\n\n\n \n The value to check.\n \n\n\n\n `true` if the value is an array of elements.\n\n\n\n### `isElementProps`\n\nCheck if a set of props is a partial of `TElement`.\n\n\n\n \n The props to check.\n \n\n\n\n `true` if the props match element properties.\n\n\n\n### `matches`\n\nCheck if an element matches a set of properties.\n\n\n\n \n The element to check.\n \n \">\n The properties to match against.\n \n\n\n\n `true` if the element matches all provided properties.\n\n\n\n## Types\n\n### `TElement`\n\n`TElement` objects are a type of node in a Plate document that contain other element nodes or text nodes. They can be either \"blocks\" or \"inlines\" depending on the editor's configuration.\n\n`Element` is a type alias for `TElement`.\n\n\n\n \n An array of child nodes that can be either elements or text nodes.\n \n \n A string identifier that defines the element's type (e.g., 'paragraph', 'heading', etc.).\n \n\n\n\n### `ElementEntry`\n\nElement entries represent an Element node and its path.\n\n\n\n \n The Element node.\n \n \n The path to the element.\n \n\n\n\n### `ElementOrTextOf`\n\n```ts\ntype ElementOrTextOf = ElementOf | TextOf;\n```\n\nThe `ElementOrTextOf` type represents either an element or a text node from a specific editor type.\n\n### `ElementOrTextIn`\n\n```ts\ntype ElementOrTextIn = ElementIn | TextIn;\n```\n\nThe `ElementOrTextIn` type represents either an element or a text node from a specific value type.\n\n### `ElementOf`\n\n`ElementOf` is a utility type to get all the element node types from a given root node type.\n\n### `ElementIn`\n\n```ts\ntype ElementIn = ElementOf;\n```\n\n`ElementIn` is a utility type to get an element type from a Plate `Value` type.\n```",
"type": "registry:file",
"target": "content/docs/plate/api/slate/element.mdx"
}
],
"type": "registry:file"
}