import { Text } from 'slate'

A text node in a Slate Document. Text nodes are always the bottom-most leaves in the document, just like in the DOM.

Properties

Text({
characters: Immutable.List<Character>,
key: String
})

characters

A list of Characters with associated Marks that make up the text node's content.

key

String

A unique identifier for the node.

kind

String

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

Computed Properties

text

String

A concatenated string of all of the characters in the text node.

Static Methods

Text.create

Text.create(properties: Object) => Text

Create a text from a plain Javascript object of properties.

Text.fromJSON

Text.fromJSON(object: Object) => Text

Create a text from a JSON object.

Text.isText

Text.isText(maybeText: Any) => Boolean

Returns a boolean if the passed in argument is a Text.

Instance Methods

toJSON

toJSON() => Object

Returns a JSON representation of the text.

Was this page helpful? Let us know how we did: