mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-03-08 23:09:47 +01:00
01405be31b
#### Is this adding or improving a _feature_ or fixing a _bug_? Feature. #### What's the new behavior? This pull request adds paths to `Range` objects, including the selection. The paths and keys are kept in sync automatically, so that you can use whichever is ideal for your use case. This should allow us to use paths for lots of the internal logic, which are much quicker to work with than keys since they avoid having to lookup the key in the document and can just traverse right to the node in question. #### How does this change work? `Range` objects have two new properties: ```js range.anchorPath range.focusPath ``` (Eventually these will be `range.anchor.path` and `range.focus.path` when points are introduced.) When operations occur and whenever ranges are created/normalized, the paths are updated and kept in sync with the keys. #### Have you checked that...? <!-- Please run through this checklist for your pull request: --> * [x] The new code matches the existing patterns and styles. * [x] The tests pass with `yarn test`. * [x] The linter passes with `yarn lint`. (Fix errors with `yarn prettier`.) * [x] The relevant examples still work. (Run examples with `yarn watch`.) #### Does this fix any issues or need any specific reviewers? Fixes: https://github.com/ianstormtaylor/slate/issues/1408 Fixes: https://github.com/ianstormtaylor/slate/issues/1567
52 lines
2.1 KiB
Markdown
52 lines
2.1 KiB
Markdown
# Changelog
|
|
|
|
This document maintains a list of changes to the `slate-html-serializer` package with each new version. Until `1.0.0` is released, breaking changes will be added as minor version bumps, and smaller changes won't be accounted for since the library is moving quickly.
|
|
|
|
---
|
|
|
|
### `0.6.0` — March 22, 2018
|
|
|
|
###### BREAKING
|
|
|
|
**Returning `null` now ignores the node.** Previously it would be treated the same as `undefined`, which will move on to the next rule in the stack. Now it ignores the node and moves onto the next node instead.
|
|
|
|
---
|
|
|
|
### `0.5.0` — January 4, 2018
|
|
|
|
###### BREAKING
|
|
|
|
**The `kind` property of Slate objects has been renamed to `object`.** This is to reduce the confusion over the difference between "kind" and "type" which are practically synonyms. The "object" name was chosen to match the Stripe API, since it seems like a sensible choice and reads much more nicely when looking through JSON.
|
|
|
|
**Serializing with `parse5` is no longer possible.** The codebase previously made concessions to allow this, but it was never a good idea because `parse5` does not match the `DOMParser` behavior exactly. Instead, you should use `jsdom` to get a matching behavior, otherwise your serialization rules need to account for two slightly different syntax trees.
|
|
|
|
---
|
|
|
|
### `0.4.0` — October 27, 2017
|
|
|
|
###### BREAKING
|
|
|
|
**Remove all previously deprecated code paths.** This helps to reduce some of the complexity in Slate by not having to handle these code paths anymore. And it helps to reduce file size. When upgrading, it's _highly_ recommended that you upgrade to the previous version first and ensure there are no deprecation warnings being logged, then upgrade to this version.
|
|
|
|
---
|
|
|
|
### `0.3.0` — October 27, 2017
|
|
|
|
###### BREAKING
|
|
|
|
**Updated to work with `slate@0.29.0`.** This is required because `slate-html-serializer` needs access to the new `Value` model.
|
|
|
|
---
|
|
|
|
### `0.2.0` — October 14, 2017
|
|
|
|
###### BREAKING
|
|
|
|
**Updated work with `slate@0.27.0`.** The new version of Slate renames the old `Range` model to `Leaf`, and the old `Selection` model to `Range`.
|
|
|
|
---
|
|
|
|
### `0.1.0` — September 17, 2017
|
|
|
|
:tada:
|