mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-02-24 09:13:24 +01:00
51 lines
932 B
Markdown
51 lines
932 B
Markdown
|
|
||
|
# `Character`
|
||
|
|
||
|
```js
|
||
|
import { Character } from 'slate'
|
||
|
```
|
||
|
|
||
|
A character in a [`Text`](./text.md) node.
|
||
|
|
||
|
Characters are how Slate associates [`Marks`](./mark.md) with a range of text, for formatting.
|
||
|
|
||
|
- [Properties](#properties)
|
||
|
- [`marks`](#marks)
|
||
|
- [`text`](#text)
|
||
|
- [Static Methods](#static-methods)
|
||
|
- [`Character.create`](#character-create)
|
||
|
- [`Character.createList`](#character-createlist)
|
||
|
|
||
|
|
||
|
## Properties
|
||
|
|
||
|
```js
|
||
|
Character({
|
||
|
marks: Immutable.Set<Mark>,
|
||
|
text: String
|
||
|
})
|
||
|
```
|
||
|
|
||
|
### `marks`
|
||
|
`Immutable.Set`
|
||
|
|
||
|
A set of [`Marks`](./mark.md) 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`.
|