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

update docs

Browse Source
This commit is contained in:
Ian Storm Taylor
2016-08-25 22:55:03 -04:00
parent 010e93850e
commit a90d522ae5
4 changed files with 40 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/Summary.md
View File

@@ -1,4 +1,8 @@
- [Introduction](./Readme.md)
## Walkthroughs ## Walkthroughs
- [Installing Slate](./walkthroughs/installing-slate.md) - [Installing Slate](./walkthroughs/installing-slate.md)
@@ -35,4 +39,8 @@
- Plugins - Plugins
- [Plugins](./reference/plugins/plugins.md) - [Plugins](./reference/plugins/plugins.md)
- [Core](./reference/plugins/core.md) - [Core](./reference/plugins/core.md)
## General
- [FAQ](./concepts/faq.md) - [FAQ](./concepts/faq.md)

2
docs/reference/models/schema.md
View File

@@ -51,7 +51,7 @@ The top-level properties of a schema all give you a way to define `rules` that t
An object that defines the [`Marks`](./mark.md) in the schema by `type`. Each key in the object refers to a mark by its `type`. The value defines how Slate will render the mark, and can either be a React component, an object of styles, or a class name. An object that defines the [`Marks`](./mark.md) in the schema by `type`. Each key in the object refers to a mark by its `type`. The value defines how Slate will render the mark, and can either be a React component, an object of styles, or a class name.
### `nodes` ### `nodes`
`Object<type, Component || Function>` `Object<type, Component || Function>` <br/>
`Object<type, Rule>` `Object<type, Rule>`
```js ```js

54
docs/reference/models/transform.md
View File

@@ -102,8 +102,8 @@ Delete forward `n` characters at the current cursor. If the selection is expande
Delete everything in the current selection. Delete everything in the current selection.
### `insertBlock` ### `insertBlock`
`insertBlock(block: Block) => Transform` `insertBlock(block: Block) => Transform` <br/>
`insertBlock(properties: Object) => Transform` `insertBlock(properties: Object) => Transform` <br/>
`insertBlock(type: String) => Transform` `insertBlock(type: String) => Transform`
Insert a new block at the same level as the current block, splitting the current block to make room if it is non-empty. If the selection is expanded, it will be deleted first. Insert a new block at the same level as the current block, splitting the current block to make room if it is non-empty. If the selection is expanded, it will be deleted first.
@@ -114,7 +114,7 @@ Insert a new block at the same level as the current block, splitting the current
Insert a [`fragment`](./document.md) at the current selection. If the selection is expanded, it will be deleted first. Insert a [`fragment`](./document.md) at the current selection. If the selection is expanded, it will be deleted first.
### `insertInline` ### `insertInline`
`insertInline(inline: Inline) => Transform` `insertInline(inline: Inline) => Transform` <br/>
`insertInline(properties: Object) => Transform` `insertInline(properties: Object) => Transform`
Insert a new inline at the current cursor position, splitting the text to make room if it is non-empty. If the selection is expanded, it will be deleted first. Insert a new inline at the current cursor position, splitting the text to make room if it is non-empty. If the selection is expanded, it will be deleted first.
@@ -125,20 +125,20 @@ Insert a new inline at the current cursor position, splitting the text to make r
Insert a string of `text` at the current selection. If the selection is expanded, it will be deleted first. Insert a string of `text` at the current selection. If the selection is expanded, it will be deleted first.
### `addMark` ### `addMark`
`addMark(mark: Mark) => Transform` `addMark(mark: Mark) => Transform` <br/>
`addMark(properties: Object) => Transform` `addMark(properties: Object) => Transform` <br/>
`addMark(type: String) => Transform` `addMark(type: String) => Transform`
Add a [`mark`](./mark.md) to the characters in the current selection. For convenience, you can pass a `type` string or `properties` object to implicitly create a [`Mark`](./mark.md) of that type. Add a [`mark`](./mark.md) to the characters in the current selection. For convenience, you can pass a `type` string or `properties` object to implicitly create a [`Mark`](./mark.md) of that type.
### `setBlock` ### `setBlock`
`setBlock(properties: Object) => Transform` `setBlock(properties: Object) => Transform` <br/>
`setBlock(type: String) => Transform` `setBlock(type: String) => Transform`
Set the `properties` of the [`Block`](./block.md) in the current selection. For convenience, you can pass a `type` string to set the blocks's type only. Set the `properties` of the [`Block`](./block.md) in the current selection. For convenience, you can pass a `type` string to set the blocks's type only.
### `setInline` ### `setInline`
`setInline(properties: Object) => Transform` `setInline(properties: Object) => Transform` <br/>
`setInline(type: String) => Transform` `setInline(type: String) => Transform`
Set the `properties` of the [`Inline`](./inline.md) nodes in the current selection. For convenience, you can pass a `type` string to set the inline's type only. Set the `properties` of the [`Inline`](./inline.md) nodes in the current selection. For convenience, you can pass a `type` string to set the inline's type only.
@@ -154,15 +154,15 @@ Split the [`Block`](./block.md) in the current selection by `depth` levels. If t
Split the [`Inline`](./inline.md) node in the current selection by `depth` levels. If the selection is expanded, it will be deleted first. `depth` defaults to `Infinity`. Split the [`Inline`](./inline.md) node in the current selection by `depth` levels. If the selection is expanded, it will be deleted first. `depth` defaults to `Infinity`.
### `removeMark` ### `removeMark`
`removeMark(mark: Mark) => Transform` `removeMark(mark: Mark) => Transform` <br/>
`removeMark(properties: Object) => Transform` `removeMark(properties: Object) => Transform` <br/>
`removeMark(type: String) => Transform` `removeMark(type: String) => Transform`
Remove a [`mark`](./mark.md) from the characters in the current selection. For convenience, you can pass a `type` string or `properties` object to implicitly create a [`Mark`](./mark.md) of that type. Remove a [`mark`](./mark.md) from the characters in the current selection. For convenience, you can pass a `type` string or `properties` object to implicitly create a [`Mark`](./mark.md) of that type.
### `toggleMark` ### `toggleMark`
`toggleMark(mark: Mark) => Transform` `toggleMark(mark: Mark) => Transform` <br/>
`toggleMark(properties: Object) => Transform` `toggleMark(properties: Object) => Transform` <br/>
`toggleMark(type: String) => Transform` `toggleMark(type: String) => Transform`
Add or remove a [`mark`](./mark.md) from the characters in the current selection, depending on it already exists on any or not. For convenience, you can pass a `type` string or `properties` object to implicitly create a [`Mark`](./mark.md) of that type. Add or remove a [`mark`](./mark.md) from the characters in the current selection, depending on it already exists on any or not. For convenience, you can pass a `type` string or `properties` object to implicitly create a [`Mark`](./mark.md) of that type.
@@ -264,7 +264,7 @@ Move the current selection to a selection with merged `properties`. The `propert
Remove a [`Node`](./node.md) from the document by its `key`. Remove a [`Node`](./node.md) from the document by its `key`.
### `setNodeByKey` ### `setNodeByKey`
`setNodeByKey(key: String, properties: Object) => Transform` `setNodeByKey(key: String, properties: Object) => Transform` <br/>
`setNodeByKey(key: String, type: String) => Transform` `setNodeByKey(key: String, type: String) => Transform`
Set a dictionary of `properties` on a [`Node`](./node.md) by its `key`. For convenience, you can pass a `type` string or `properties` object. Set a dictionary of `properties` on a [`Node`](./node.md) by its `key`. For convenience, you can pass a `type` string or `properties` object.
@@ -288,8 +288,8 @@ Delete forward `n` characters at a `range`. If the `range` is expanded, this met
Delete everything in a `range`. Delete everything in a `range`.
### `insertBlockAtRange` ### `insertBlockAtRange`
`insertBlockAtRange(range: Selection, block: Block) => Transform` `insertBlockAtRange(range: Selection, block: Block) => Transform` <br/>
`insertBlockAtRange(range: Selection, properties: Object) => Transform` `insertBlockAtRange(range: Selection, properties: Object) => Transform` <br/>
`insertBlockAtRange(range: Selection, type: String) => Transform` `insertBlockAtRange(range: Selection, type: String) => Transform`
Insert a new block at the same level as the leaf block at a `range`, splitting the current block to make room if it is non-empty. If the selection is expanded, it will be deleted first. Insert a new block at the same level as the leaf block at a `range`, splitting the current block to make room if it is non-empty. If the selection is expanded, it will be deleted first.
@@ -300,7 +300,7 @@ Insert a new block at the same level as the leaf block at a `range`, splitting t
Insert a [`fragment`](./document.md) at a `range`. If the selection is expanded, it will be deleted first. Insert a [`fragment`](./document.md) at a `range`. If the selection is expanded, it will be deleted first.
### `insertInlineAtRange` ### `insertInlineAtRange`
`insertInlineAtRange(range: Selection, inline: Inline) => Transform` `insertInlineAtRange(range: Selection, inline: Inline) => Transform` <br/>
`insertInlineAtRange(range: Selection, properties: Object) => Transform` `insertInlineAtRange(range: Selection, properties: Object) => Transform`
Insert a new inline at a `range`, splitting the text to make room if it is non-empty. If the selection is expanded, it will be deleted first. Insert a new inline at a `range`, splitting the text to make room if it is non-empty. If the selection is expanded, it will be deleted first.
@@ -311,20 +311,20 @@ Insert a new inline at a `range`, splitting the text to make room if it is non-e
Insert a string of `text` at a `range`. If the selection is expanded, it will be deleted first. Insert a string of `text` at a `range`. If the selection is expanded, it will be deleted first.
### `addMarkAtRange` ### `addMarkAtRange`
`addMarkAtRange(range: Selection, mark: Mark) => Transform` `addMarkAtRange(range: Selection, mark: Mark) => Transform` <br/>
`addMarkAtRange(range: Selection, properties: Object) => Transform` `addMarkAtRange(range: Selection, properties: Object) => Transform` <br/>
`addMarkAtRange(range: Selection, type: String) => Transform` `addMarkAtRange(range: Selection, type: String) => Transform`
Add a [`mark`](./mark.md) to the characters in a `range`. For convenience, you can pass a `type` string or `properties` object to implicitly create a [`Mark`](./mark.md) of that type. Add a [`mark`](./mark.md) to the characters in a `range`. For convenience, you can pass a `type` string or `properties` object to implicitly create a [`Mark`](./mark.md) of that type.
### `setBlockAtRange` ### `setBlockAtRange`
`setBlockAtRange(range: Selection, properties: Object) => Transform` `setBlockAtRange(range: Selection, properties: Object) => Transform` <br/>
`setBlock(range: Selection, type: String) => Transform` `setBlock(range: Selection, type: String) => Transform`
Set the `properties` of the [`Block`](./block.md) in a `range`. For convenience, you can pass a `type` string to set the blocks's type only. Set the `properties` of the [`Block`](./block.md) in a `range`. For convenience, you can pass a `type` string to set the blocks's type only.
### `setInlineAtRange` ### `setInlineAtRange`
`setInlineAtRange(range: Selection, properties: Object) => Transform` `setInlineAtRange(range: Selection, properties: Object) => Transform` <br/>
`setInline(range: Selection, type: String) => Transform` `setInline(range: Selection, type: String) => Transform`
Set the `properties` of the [`Inline`](./inline.md) nodes in a `range`. For convenience, you can pass a `type` string to set the inline's type only. Set the `properties` of the [`Inline`](./inline.md) nodes in a `range`. For convenience, you can pass a `type` string to set the inline's type only.
@@ -340,39 +340,39 @@ Split the [`Block`](./block.md) in a `range` by `depth` levels. If the selection
Split the [`Inline`](./inline.md) node in a `range` by `depth` levels. If the selection is expanded, it will be deleted first. `depth` defaults to `Infinity`. Split the [`Inline`](./inline.md) node in a `range` by `depth` levels. If the selection is expanded, it will be deleted first. `depth` defaults to `Infinity`.
### `removeMarkAtRange` ### `removeMarkAtRange`
`removeMarkAtRange(range: Selection, mark: Mark) => Transform` `removeMarkAtRange(range: Selection, mark: Mark) => Transform` <br/>
`removeMarkAtRange(range: Selection, properties: Object) => Transform` `removeMarkAtRange(range: Selection, properties: Object) => Transform` <br/>
`removeMarkAtRange(range: Selection, type: String) => Transform` `removeMarkAtRange(range: Selection, type: String) => Transform`
Remove a [`mark`](./mark.md) from the characters in a `range`. For convenience, you can pass a `type` string or `properties` object to implicitly create a [`Mark`](./mark.md) of that type. Remove a [`mark`](./mark.md) from the characters in a `range`. For convenience, you can pass a `type` string or `properties` object to implicitly create a [`Mark`](./mark.md) of that type.
### `toggleMarkAtRange` ### `toggleMarkAtRange`
`toggleMarkAtRange(range: Selection, mark: Mark) => Transform` `toggleMarkAtRange(range: Selection, mark: Mark) => Transform` <br/>
`toggleMarkAtRange(range: Selection, properties: Object) => Transform` `toggleMarkAtRange(range: Selection, properties: Object) => Transform` <br/>
`toggleMarkAtRange(range: Selection, type: String) => Transform` `toggleMarkAtRange(range: Selection, type: String) => Transform`
Add or remove a [`mark`](./mark.md) from the characters in a `range`, depending on whether any of them already have the mark. For convenience, you can pass a `type` string or `properties` object to implicitly create a [`Mark`](./mark.md) of that type. Add or remove a [`mark`](./mark.md) from the characters in a `range`, depending on whether any of them already have the mark. For convenience, you can pass a `type` string or `properties` object to implicitly create a [`Mark`](./mark.md) of that type.
### `unwrapBlockAtRange` ### `unwrapBlockAtRange`
`unwrapBlockAtRange(range: Selection, properties: Object) => Transform` `unwrapBlockAtRange(range: Selection, properties: Object) => Transform` <br/>
`unwrapBlockAtRange(range: Selection, type: String) => Transform` `unwrapBlockAtRange(range: Selection, type: String) => Transform`
Unwrap all [`Block`](./block.md) nodes in a `range` that match `properties`. For convenience, you can pass a `type` string or `properties` object. Unwrap all [`Block`](./block.md) nodes in a `range` that match `properties`. For convenience, you can pass a `type` string or `properties` object.
### `unwrapInlineAtRange` ### `unwrapInlineAtRange`
`unwrapInlineAtRange(range: Selection, properties: Object) => Transform` `unwrapInlineAtRange(range: Selection, properties: Object) => Transform` <br/>
`unwrapInlineAtRange(range: Selection, type: String) => Transform` `unwrapInlineAtRange(range: Selection, type: String) => Transform`
Unwrap all [`Inline`](./inline.md) nodes in a `range` that match `properties`. For convenience, you can pass a `type` string or `properties` object. Unwrap all [`Inline`](./inline.md) nodes in a `range` that match `properties`. For convenience, you can pass a `type` string or `properties` object.
### `wrapBlockAtRange` ### `wrapBlockAtRange`
`wrapBlockAtRange(range: Selection, properties: Object) => Transform` `wrapBlockAtRange(range: Selection, properties: Object) => Transform` <br/>
`wrapBlockAtRange(range: Selection, type: String) => Transform` `wrapBlockAtRange(range: Selection, type: String) => Transform`
Wrap the [`Block`](./block.md) nodes in a `range` with a new [`Block`](./block.md) node with `properties`. For convenience, you can pass a `type` string or `properties` object. Wrap the [`Block`](./block.md) nodes in a `range` with a new [`Block`](./block.md) node with `properties`. For convenience, you can pass a `type` string or `properties` object.
### `wrapInlineAtRange` ### `wrapInlineAtRange`
`wrapInlineAtRange(range: Selection, properties: Object) => Transform` `wrapInlineAtRange(range: Selection, properties: Object) => Transform` <br/>
`wrapInlineAtRange(range: Selection, type: String) => Transform` `wrapInlineAtRange(range: Selection, type: String) => Transform`
Wrap the [`Inline`](./inline.md) nodes in a `range` with a new [`Inline`](./inline.md) node with `properties`. For convenience, you can pass a `type` string or `properties` object. Wrap the [`Inline`](./inline.md) nodes in a `range` with a new [`Inline`](./inline.md) node with `properties`. For convenience, you can pass a `type` string or `properties` object.

6
docs/reference/serializers/html.md
View File

@@ -23,7 +23,9 @@ For an example of the `Html` serializer in action, check out the [`paste-html` e
## Example ## Example
```txt ```txt
The Slate editor gives you full control over the logic you can add.\nIn its simplest form, when representing plain text, Slate is a glorified <textarea>. But you can augment it to be much more than that.\nCheck out http://slatejs.org for examples! <p>The Slate editor gives you <em>complete</em> control over the logic you can add.</p>
<p>In its simplest form, when representing plain text, Slate is a glorified <code>&laquo;textarea&raquo;</code>. But you can augment it to be much more than that.</p>
<p>Check out <a href="http://slatejs.org">http://slatejs.org</a> for examples!</p>
``` ```
@@ -111,4 +113,4 @@ The object should be one of:
The `serialize` function should return a React element representing the serialized HTML, or nothing if the rule in question doesn't know how to serialize the object, in which case the next rule in the stack will be attempted. The `serialize` function should return a React element representing the serialized HTML, or nothing if the rule in question doesn't know how to serialize the object, in which case the next rule in the stack will be attempted.
The function will be called with either a `Node`, a `Mark`, or a special `String` immutable object, with a `kind: 'string'` property and a `text` property containing the text string. In the case of the `String` property, the The function will be called with either a `Node`, a `Mark`, or a special `String` immutable object, with a `kind: 'string'` property and a `text` property containing the text string.