mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-21 14:41:23 +02:00
Code Issues Releases Wiki Activity

Text documentation update (#2758)

Browse Source 
`text` property is no longer computed. Add `marks` field.
This commit is contained in:
Dan Schuman
2019-05-10 10:47:58 -07:00
committed by Ian Storm Taylor
parent 5bef253855
commit 376015df6c
1 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/reference/slate/text.md
View File

@@ -11,6 +11,8 @@ A text node in a Slate [`Document`](./document.md). Text nodes are always the bo
```js ```js
Text({ Text({
key: String, key: String,
text: String,
marks: Immutable.List<Mark>,
}) })
``` ```
@@ -20,20 +22,24 @@ Text({
A unique identifier for the node. A unique identifier for the node.
### `text`
`String`
The text contents of this node.
### `marks`
`Immutable.List<Mark>,`
A list of marks for this node.
### `object` ### `object`
`String` `String`
An immutable string value of `'text'` for easily separating this node from [`Inline`](./inline.md) or [`Block`](./block.md) nodes. An immutable string value of `'text'` for easily separating this node from [`Inline`](./inline.md) or [`Block`](./block.md) nodes.
## Computed Properties
### `text`
`String`
A concatenated string of all of the characters in the text node.
## Static Methods ## Static Methods
### `Text.create` ### `Text.create`