1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-09-01 11:12:42 +02:00

refactor docs

This commit is contained in:
Ian Storm Taylor
2016-07-12 21:34:31 -07:00
parent 510eb63d8d
commit 0b8498e83a
14 changed files with 121 additions and 169 deletions

View File

@@ -1,44 +1,16 @@
# Concepts
This document explain the core concepts that Slate is built on around. It is helpful to read it through in it's entirety to get a good mental model for how Slate works.
- [Statelessness & Immutability](#statelessness-immutability)
- [The Document Model](#the-document-model)
- [The Selection Mode](#the-selection-model)
- [Transforms](#transforms)
- [Plugins](#plugins)
- [Statelessness & Immutability](./statelessness-and-immutability.md)
- [The Document Model](./the-document-model.md)
- [The Selection Model](./the-selection-model.md)
- [Transforms](./transforms.md)
- [Plugins](./plugins.md)
### Statelessness & Immutability
- all the data is immutable, for performance
- changes propagated up through the single `onChange` handler
### The Document Model
- recursive, nested tree
- document, blocks, and inlines implement node interface
- blocks and inlines can be nested to any depth
- blocks contain inlines and text
- inlines contain text
- always a text node at the leaves, for selection handling
- void nodes can't have content, but still have an empty text node
### The Selection Model
- selection is always relative to text nodes (is normalized)
- "blocks" always refers to the closest block parent
### Transforms
- no updating of document/selection outside of transforms
- wrap blocks wraps close to the text
- wrap inline wraps far from the text
### Plugins
- everything is a plugin, even core is one
- the editor's props become the highest-priority plugin

5
docs/concepts/plugins.md Normal file
View File

@@ -0,0 +1,5 @@
### Plugins
- everything is a plugin, even core is one
- the editor's props become the highest-priority plugin

View File

@@ -1,5 +1,5 @@
# Statelessness & Immutability
- all the data is immutable, for performance
- changes propagated up through the single `onChange` handler

View File

@@ -1,4 +1,13 @@
# The Document Model
- recursive, nested tree
- document, blocks, and inlines implement node interface
- blocks and inlines can be nested to any depth
- blocks contain inlines and text
- inlines contain text
- always a text node at the leaves, for selection handling
- void nodes can't have content, but still have an empty text node

View File

@@ -0,0 +1,5 @@
# The Selection Model
- selection is always relative to text nodes (is normalized)
- "blocks" always refers to the closest block parent

View File

@@ -0,0 +1,6 @@
# Transforms
- no updating of document/selection outside of transforms
- wrap blocks wraps close to the text
- wrap inline wraps far from the text