2021-04-01 23:20:52 +00:00
|
|
|
# Table of contents
|
|
|
|
|
|
2021-04-01 18:13:48 -07:00
|
|
|
- [Introduction](Introduction.md)
|
2016-08-25 22:32:17 -04:00
|
|
|
|
2017-09-11 18:11:45 -07:00
|
|
|
## Walkthroughs
|
2016-08-25 22:32:17 -04:00
|
|
|
|
2021-04-01 18:13:48 -07:00
|
|
|
- [Installing Slate](walkthroughs/01-installing-slate.md)
|
|
|
|
|
- [Adding Event Handlers](walkthroughs/02-adding-event-handlers.md)
|
|
|
|
|
- [Defining Custom Elements](walkthroughs/03-defining-custom-elements.md)
|
|
|
|
|
- [Applying Custom Formatting](walkthroughs/04-applying-custom-formatting.md)
|
|
|
|
|
- [Executing Commands](walkthroughs/05-executing-commands.md)
|
|
|
|
|
- [Saving to a Database](walkthroughs/06-saving-to-a-database.md)
|
|
|
|
|
- [Using the Bundled Source](walkthroughs/xx-using-the-bundled-source.md)
|
Next (#3093)
* remove some key usage from core, refactor Operations.apply
* undeprecate some methods
* convert more key usage to paths
* update deprecations
* convert selection commands to use all paths
* refactor word boundary selection logic
* convert many at-range commands to use paths
* convert wrapBlock and wrapInline to not use keys
* cleanup
* remove chainability from editor
* simplify commands, queries and middleware
* convert deleteAtRange
* remove key usage from schema, deprecate *ByKey methods
* migrate *ByKey tests, remove index from *ByPath signatures
* rename at-current-range tests
* deprecate mode key usage, migrate more tests away from keys
* deprecate range and point methods which rely on keys to work
* refactor insertBlock, without fixing warnings
* add pathRef/pointRef, fix insertBlock/Inline deprecations, work on insertFragment
* refactor insertFragment
* get rich-text example rendering
* fix lint
* refactor query files, fix more tests
* remove unused queries, refactor others
* deprecate splitDescendantsByPath
* merge master
* add typescript, convert slate, slate-hyperscript, slate-plain-serializer
* add Point, Path, Range, Annotation tests
* add Annotation, Change, Element, Fragment, Mark, Range, Selection, Value interfaces tests
* add Operation and Text tests
* add Node tests
* get operations and normalization tests working for slate
* get *AtPath command tests passing
* rename *AtPath command tests
* rename
* get *AtPoint tests working
* rename
* rename
* add value queries tests
* add element, mark and path queries tests
* convert most on-selection tests
* convert on-selection commands
* rename
* get addMarks and delete commands working
* rename
* rename
* rename
* refactor value.positions(), work on delete tests
* progress on delete tests
* more delete work
* finish delete tests
* start converting to at-based commands
* restructure query tests
* restructure operations tests
* more work converting to multi-purpose commands
* lots of progress on converting to at-based commands
* add unwrapNodes
* remove setValue
* more progress
* refactor node commands to use consistent matching logic
* cleanup, get non-fragment commands passing
* remove annotations and isAtomic
* rename surround/pluck to cover/uncover
* add location concept, change at-path to from-path for iterables
* refactor batches
* add location-based queries
* refactor hanging logic
* more location query work
* renaming
* use getMatch more
* add split to wrap/unwrap
* flip levels/ancestors ordering
* switch splitNodes to use levels
* change split to always:false by default
* fix tests
* add more queries tests
* fixing more delete logic
* add more splitNodes tests
* get rest of delete tests passing
* fix location-based logic in some commands
* cleanup
* get previous packages tests passing again
* add slate-history package
* start slate-schema work
* start of react working
* rendering fixes
* get rich and plain text examples working
* get image example working with hooks and dropping
* refactor onDrop to be internal
* inline more event handlers
* refactor lots of event-related logic
* change rendering to use render props
* delete unused stuff
* cleanup dom utils
* remove unused deps
* remove unnecessary packages, add placeholder
* remove slate-react-placeholder package
* remove unused dep
* remove unnecessary tests, fix readonly example
* convert checklists example
* switch to next from webpack
* get link example working
* convert more examples
* preserve keys, memoized leafs/texts, fix node lookup
* fix to always useLayoutEffect for ordering
* fix annotations to be maps, memoize elements
* remove Change interface
* remove String interface
* rename Node.entries to Node.nodes
* remove unnecessary value queries
* default to selection when iterating, cleanup
* remove unused files
* update scroll into view logic
* fix undoing, remove constructor types
* dont sync selection while composing
* add workflows
* remove unused deps
* convert mentions example
* tweaks
* convert remaining examples
* rename h to jsx, update schema
* fix schema tests
* fix slate-schema logic and tests
* really fix slate-schema and forced-layout example
* get start of insertFragment tests working
* remove Fragment interface
* remove debugger
* get all non-skipped tests passing
* cleanup deps
* run prettier
* configure eslint for typescript
* more eslint fixes...
* more passing
* update some docs
* fix examples
* port windows undo hotkey change
* fix deps, add basic firefox support
* add event overriding, update walkthroughs
* add commands, remove classes, cleanup examples
* cleanup rollup config
* update tests
* rename queries tests
* update other tests
* update walkthroughs
* cleanup interface exports
* cleanup, change mark transforms to require location
* undo mark transform change
* more
* fix tests
* fix example
* update walkthroughs
* update docs
* update docs
* remove annotations
* remove value, move selection and children to editor
* add migrating doc
* fix lint
* fix tests
* fix DOM types aliasing
* add next export
* update deps, fix prod build
* fix prod build
* update scripts
* update docs and changelogs
* update workflow and pull request template
2019-11-27 20:54:42 -05:00
|
|
|
|
|
|
|
|
## Concepts
|
|
|
|
|
|
2021-04-01 18:13:48 -07:00
|
|
|
- [Interfaces](concepts/01-interfaces.md)
|
|
|
|
|
- [Nodes](concepts/02-nodes.md)
|
|
|
|
|
- [Locations](concepts/03-locations.md)
|
2021-04-07 18:03:57 -04:00
|
|
|
- [Transforms](concepts/04-transforms.md)
|
2021-04-01 18:13:48 -07:00
|
|
|
- [Operations](concepts/05-operations.md)
|
2021-04-07 18:03:57 -04:00
|
|
|
- [Commands](concepts/06-commands.md)
|
|
|
|
|
- [Editor](concepts/07-editor.md)
|
|
|
|
|
- [Plugins](concepts/08-plugins.md)
|
|
|
|
|
- [Rendering](concepts/09-rendering.md)
|
|
|
|
|
- [Serializing](concepts/10-serializing.md)
|
|
|
|
|
- [Normalizing](concepts/11-normalizing.md)
|
|
|
|
|
- [TypeScript](concepts/12-typescript.md)
|
2021-04-01 18:13:48 -07:00
|
|
|
- [Migrating](concepts/xx-migrating.md)
|
2017-10-17 20:30:11 -07:00
|
|
|
|
2020-03-05 09:30:29 -08:00
|
|
|
## API
|
|
|
|
|
|
2021-04-01 18:13:48 -07:00
|
|
|
- [Transforms](api/transforms.md)
|
|
|
|
|
- [Node Types](api/nodes/README.md)
|
|
|
|
|
- [Editor](api/nodes/editor.md)
|
|
|
|
|
- [Element](api/nodes/element.md)
|
|
|
|
|
- [Node](api/nodes/node.md)
|
|
|
|
|
- [Text](api/nodes/text.md)
|
|
|
|
|
- [Location Types](api/locations/README.md)
|
|
|
|
|
- [Location](api/locations/location.md)
|
|
|
|
|
- [Path](api/locations/path.md)
|
|
|
|
|
- [Point](api/locations/point.md)
|
|
|
|
|
- [PointRef](api/locations/point-ref.md)
|
|
|
|
|
- [Range](api/locations/range.md)
|
|
|
|
|
- [RangeRef](api/locations/range-ref.md)
|
|
|
|
|
- [Operation](api/operation.md)
|
2020-03-05 09:30:29 -08:00
|
|
|
|
2020-05-01 15:16:36 -04:00
|
|
|
## Libraries
|
|
|
|
|
|
2021-04-01 18:13:48 -07:00
|
|
|
- [Slate React](libraries/slate-react.md)
|
|
|
|
|
- [Slate History](libraries/slate-history.md)
|
|
|
|
|
- [Slate Hyperscript](libraries/slate-hyperscript.md)
|
2020-05-01 15:16:36 -04:00
|
|
|
|
2017-09-11 18:11:45 -07:00
|
|
|
## General
|
2017-03-31 17:18:13 -07:00
|
|
|
|
2021-04-01 18:13:48 -07:00
|
|
|
- [Resources](general/resources.md)
|
|
|
|
|
- [Contributing](general/contributing.md)
|
|
|
|
|
- [Changelog](general/changelog.md)
|
|
|
|
|
- [FAQ](general/faq.md)
|
