1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-03-06 13:59:47 +01:00

32 lines
1.0 KiB
Markdown
Raw Normal View History

# `slate-plain-serializer`
2016-07-17 15:37:05 -07:00
```js
import Plain from 'slate-plain-serializer'
2016-07-17 15:37:05 -07:00
```
A serializer that converts a Slate [`Value`](../slate/value.md) to and from a plain text string.
2016-07-17 15:37:05 -07:00
## Example
```txt
The Slate editor gives you full control over the logic you can add.\n
In its simplest form, when representing plain text, Slate is a glorified <textarea>. But you can augment it to be much more than that.\n
Check out http://slatejs.org for examples!
```
## Methods
### `Plain.deserialize`
`Plain.deserialize(string: String, [options: Object]) => Value`
2016-07-17 15:37:05 -07:00
Deserialize a plain text `string` into a [`Value`](../slate/value.md). A series of blocks will be created by splitting the input string on `\n` characters. Each block is given a type of `'line'`.
2016-07-17 15:37:05 -07:00
If you pass `toJSON: true` as an option, the return value will be a JSON object instead of a [`Value`](../slate/value.md) object.
2016-07-17 15:37:05 -07:00
### `Plain.serialize`
`Plain.serialize(value: Value) => String`
2016-07-17 15:37:05 -07:00
Serialize a `value` into a plain text string. Each direct child block of the document will be separated by a `\n` character.