Interfaces

Search…
Interfaces
Slate works with pure JSON objects. All it requires is that those JSON objects conform to certain interfaces. For example, a text node in Slate must obey the Text interface:
interface Text {
  text: string
}
Which means it must have a text property with a string of content.
But any other custom properties are also allowed, and completely up to you. This lets you tailor your data to your specific domain and use case, adding whatever formatting logic you'd like, without Slate getting in the way.
This interface-based approach separates Slate from most other rich text editors which require you to work with their hand-rolled "model" classes and makes it much easier to reason about. It also means that it avoids startup time penalties related to "initializing" the data model.
Custom Properties
To take another example, the Element node interface in Slate is:
interface Element {
  children: Node[]
}
This is a very permissive interface. All it requires is that the children property gets defined containing the element's child nodes.
But you can extend elements (or any other interface) with your custom properties that are specific to your domain. For example, you might have "paragraph" and "link" elements:
const paragraph = {
  type: 'paragraph',
  children: [...],
}
​
const link = {
  type: 'link',
  url: 'https://example.com',
  children: [...]
}
The type and url properties are your custom API. Slate sees that they exist, but doesn't use them. However, when Slate renders a link element, you'll receive an object with the custom properties attached so that you can render it as:
<a href={element.url}>{element.children}</a>
When getting started with Slate, it's important to understand all of the interfaces it defines. There are a handful of interfaces that are discussed in each of the guides.
Helper Functions
In addition to the typing information, each interface in Slate also exposes a series of helper functions that make them easier to work with.
For example, when working with nodes:
import { Node } from 'slate'
​
// Get the string content of an element node.
const string = Node.string(element)
​
// Get the node at a specific path inside a root node.
const descendant = Node.get(value, path)
Or, when working with ranges:
import { Range } from 'slate'
​
// Get the start and end points of a range in order.
const [start, end] = Range.edges(range)
​
// Check if a range is collapsed to a single point.
if (Range.isCollapsed(range)) {
  // ...
}
There are many helper functions available for all common use cases when working with different interfaces. When getting started it helps to read through all of them so you can often simplify complex logic into just a handful of lines of code.
Custom Helpers
In addition to the built-in helper functions, you might want to define your custom helper functions and expose them on your custom namespaces.
For example, if your editor supports images, you might want a helper that determines if an element is an image element:
const isImageElement = element => {
  return element.type === 'image' && typeof element.url === 'string'
}
You can define these as one-off functions easily. But you might also bundle them up into namespaces, just like the core interfaces do, and use them instead.
For example:
import { Element } from 'slate'
​
// You can use `MyElement` everywhere to have access to your extensions.
export const MyElement = {
  ...Element,
  isImageElement,
  isParagraphElement,
  isQuoteElement,
}
This makes it easy to reuse domain-specific logic alongside the built-in Slate helpers.
Walkthroughs - Previous
Using the Bundled Source
Next - Concepts
Nodes
Last modified 1yr ago
Copy link
Outline
Custom Properties
Helper Functions
Custom Helpers