import { Character } from 'slate'

A character in a Text node.

Characters are how Slate associates Marks with a range of text, for formatting.

Properties

Character({
marks: Immutable.Set<Mark>,
text: String
})

kind

String

A string with a value of 'character'.

marks

Immutable.Set

A set of Marks attached to the character.

text

String

The text string of the character.

Static Methods

Character.create

Character.create(properties: Object) => Character

Create a character from a plain Javascript object of properties.

Character.createList

Character.createList(array: Array) => List

Create a list of characters from a plain Javascript array.

Character.fromJSON

Character.fromJSON(object: Object) => Character

Create a character from a JSON object.

Character.isCharacter

Character.isCharacter(maybeCharacter: Any) => Boolean

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

Instance Methods

toJSON

toJSON() => Object

Returns a JSON representation of the character.

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