4f:I[314491,["/_next/static/immutable/chunks/3arlv5bvukoo2.js","/_next/static/immutable/chunks/39v64hmfyo-sr.js","/_next/static/immutable/chunks/2nvof3-29tvc3.js","/_next/static/immutable/chunks/3tjobt77z_9dj.js","/_next/static/immutable/chunks/04j_o97cgxn2x.js","/_next/static/immutable/chunks/3upr08c9vtj8w.js","/_next/static/immutable/chunks/1ww0328si-u8x.js","/_next/static/immutable/chunks/11mfl5ymqld9-.js","/_next/static/immutable/chunks/2xxcqy6ppds3l.js","/_next/static/immutable/chunks/3j06ow7w40nxu.js","/_next/static/immutable/chunks/31nn7jwsjvqii.js","/_next/static/immutable/chunks/43_s7jweyypoh.js","/_next/static/immutable/chunks/0p6vao205o1jc.js","/_next/static/immutable/chunks/1_kyvgkyokw92.js","/_next/static/immutable/chunks/1lo-zn37dolb5.js","/_next/static/immutable/chunks/1v8k6yxw1rg0u.js"],"FilesView"] 50:T1334,--- title: Element description: API reference for elements in Slate. --- `TElement` objects are a type of `Node` in a Plate document that contain other `TElement` nodes or `Text` nodes. ```typescript interface TElement { children: Descendant[] type: string [key: string]: unknown } ``` ## Element Behavior Elements can have different behaviors depending on the editor's configuration: ### Block vs Inline Elements can be either "block" or "inline" as defined by plugin `node.isInline`: - Block elements can only be siblings with other block elements - Inline elements can be siblings with Text nodes or other inline elements ### Void vs Non-void Elements can be either "void" or "non-void" as defined by plugin `node.isVoid`: - Non-void elements: Slate handles rendering of children (e.g., paragraph with Text and Inline children) - Void elements: Children are rendered by the Element's render code ### Markable Voids Some void elements can support marks through plugin `node.markableVoid`. For example, a mention element might need to support bold or italic formatting. ## `ElementAPI` ### `isElementType` Check if a value implements the `TElement` interface and has `elementKey` matching a specified value. Defaults to checking the `'type'` key. The value to check. The value to match against. The key to check. Defaults to `'type'`. `true` if the value is an element with the specified key matching `elementVal`. ### `isAncestor` Check if a value implements the `Ancestor` interface. The value to check. `true` if the value is an ancestor node. ### `isElement` Check if a value implements the `TElement` interface. The value to check. `true` if the value is a Plate element. ### `isElementList` Check if a value is an array of `TElement` objects. The value to check. `true` if the value is an array of elements. ### `isElementProps` Check if a set of props is a partial of `TElement`. The props to check. `true` if the props match element properties. ### `matches` Check if an element matches a set of properties. The element to check. The properties to match against. `true` if the element matches all provided properties. ## Types ### `TElement` `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. `Element` is a type alias for `TElement`. An array of child nodes that can be either elements or text nodes. A string identifier that defines the element's type (e.g., 'paragraph', 'heading', etc.). ### `ElementEntry` Element entries represent an Element node and its path. The Element node. The path to the element. ### `ElementOrTextOf` ```ts type ElementOrTextOf = ElementOf | TextOf; ``` The `ElementOrTextOf` type represents either an element or a text node from a specific editor type. ### `ElementOrTextIn` ```ts type ElementOrTextIn = ElementIn | TextIn; ``` The `ElementOrTextIn` type represents either an element or a text node from a specific value type. ### `ElementOf` `ElementOf` is a utility type to get all the element node types from a given root node type. ### `ElementIn` ```ts type ElementIn = ElementOf; ``` `ElementIn` is a utility type to get an element type from a Plate `Value` type. ```4e:["$","div",null,{"className":"mt-3 flex min-h-0 min-w-0 flex-1 flex-col gap-3","children":[null,["$","$L4f",null,{"files":[{"path":"../../content/docs/api/slate/element.mdx","content":"$50","type":"registry:file","target":"content/docs/plate/api/slate/element.mdx"}],"className":"h-[70svh] min-h-80"}]]}]