slate/docs/reference/models/inline.md

Inline

import { Inline } from 'slate'

A inline node in a Slate Document. Inline nodes implement the Node interface.

Inline nodes may contain nested inline nodes and text nodes—just like in the DOM. They always contain at least one text node child.

• Properties
  • data
  • isVoid
  • key
  • nodes
  • type
• Computed Properties
  • kind
  • length
  • text
• Static Methods
  • Inline.create
  • Inline.createList
• Node Methods

Properties

Inline({
  data: Data,
  isVoid: Boolean,
  key: String,
  nodes: Immutable.List<Node>,
  type: String
})

data

Immutable.Map

Arbitrary data associated with the node. Defaults to an empty Map.

isVoid

Boolean

Whether the node is a "void" node, meaning that it has no child content (eg. emoji, icons, etc.). Defaults to false.

Note that even though a node may be "void", it will still contain a single, empty Text node for consistency across other operations. However, when rendered by Slate that single Text node will not be visible.

key

String

A unique identifier for the node.

nodes

Immutable.List

A list of child nodes. Defaults to a list with a single text node child.

type

String

The custom type of the node (eg. link or hashtag).

Computed Properties

kind

String

An immutable string value of 'inline' for easily separating this node from Block or Text nodes.

length

Number

The sum of the lengths of all of the descendant Text nodes of this node.

text

String

A concatenated string of all of the descendant Text nodes of this node.

Static Methods

Inline.create

Inline.create(properties: Object) => Block

Create a block from a plain Javascript object of properties.

Inline.createList

Inline.createList(array: Array) => List

Create a list of inline nodes from a plain Javascript array.

Node Methods

Inlines implement the Node interface. For information about all of the node methods, see the Node reference.