1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-02-24 17:23:07 +01:00
slate/docs/api/element.md

33 lines
921 B
Markdown
Raw Normal View History

# Element
`Element` objects are a type of node in a Slate document that contain other `Element` nodes or `Text` nodes. They can be either "blocks" or "inlines" depending on the Slate editor's configuration.
```typescript
interface Element {
children: Node[]
[key: string]: unknown
}
```
- [Static methods](static-methods)
- [Retrieval methods](#retrieval-methods)
- [Check methods](#check-methods)
## Static methods
2021-03-29 23:36:22 -07:00
### Retrieval methods
###### `Element.matches(element: Element, props: Partial<Element>): boolean`
Check if an element matches a set of `props`. Note: This checks custom properties, but it does not ensure that any children are equivalent.
### Check methods
###### `Element.isElement(value: any): value is Element`
Check if a `value` implements the `Element` interface.
###### `Element.isElementList(value: any): value is Element[]`
Check if a `value` is an array of `Element` objects.