1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-17 20:51:20 +02:00

update changelogs

This commit is contained in:
Ian Storm Taylor
2017-10-27 13:48:30 -07:00
parent adb2678732
commit 2e74941787
9 changed files with 119 additions and 5 deletions

View File

@@ -7,6 +7,16 @@ This document maintains a list of changes to the `slate-base64-serializer` packa
---
### `0.2.0` — October 27, 2017
###### BREAKING
- **Updated to work with `slate@0.29.0`.** This is required because `slate-base64-serializer` needs access to the new `Value` model.
---
### `0.1.0` — September 17, 2017
:tada:

View File

@@ -7,6 +7,16 @@ This document maintains a list of changes to the `slate-html-serializer` package
---
### `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

View File

@@ -7,6 +7,20 @@ This document maintains a list of changes to the `slate-hyperscript` package wit
---
### `0.3.0` — October 27, 2017
###### BREAKING
- **Updated to work with `slate@0.29.0`.** This is required because `slate-hyperscript` needs access to the new `Value` model.
###### DEPRECATED
- **The `<state>` tag has been renamed to `<value>`.** This is to stay in line with the newest version of Slate where the `State` object was renamed to `Value`.
---
### `0.2.0` — October 14, 2017
###### BREAKING

View File

@@ -7,6 +7,16 @@ This document maintains a list of changes to the `slate-plain-serializer` packag
---
### `0.3.0` — October 27, 2017
###### BREAKING
- **Updated to work with `slate@0.29.0`.** This is required because `slate-plain-serializer` needs access to the new `Value` model.
---
### `0.2.0` — October 14, 2017
###### BREAKING

View File

@@ -7,6 +7,20 @@ This document maintains a list of changes to the `slate-prop-types` package with
---
### `0.3.0` — October 27, 2017
###### BREAKING
- **Updated to work with `slate@0.29.0`.** This is required because `slate-prop-types` needs access to the new `Value` model.
###### DEPRECATED
- **The `state` prop type has been renamed to `value`.** This is to stay in line with `slate-react@0.29.0` where the `State` object was renamed.
---
### `0.2.0` — October 14, 2017
###### BREAKING

View File

@@ -7,6 +7,32 @@ This document maintains a list of changes to the `slate-react` package with each
---
### `0.9.0` — October 27, 2017
###### BREAKING
- **Updated to use `slate@0.29.0`.** This is to gain access to the new `Value` model introduced in the newest version of Slate.
- **Custom components no longer receive `props.state` or `props.schema`.** These are now exposed directly on the `props.editor` instance itself as `editor.value` and `editor.schema`. This helps eliminate a common issue where because of `shouldComponentUpdate` returning `false`, the `props.state` value was actually outdated, and transforming from it would cause incorrect behaviors.
- **The `plugin.renderEditor` function's signature has changed.** Previously it received `(props, state, editor)` but it now receives just `(props, editor)`. If you need access to the editor's current value, use the new `editor.value` property. This is simply to clean up the API, since the value is already accessible on `editor`.
###### DEPRECATED
- **The "state" has been renamed to "value" everywhere.** All of the current references are maintained as deprecations, so you should be able to upgrade and see warnings logged instead of being greeted with a broken editor. This is to reduce the confusion between React's "state" and Slate's editor value, and in an effort to further mimic the native DOM APIs.
- **The editor `getSchema()`, `getStack()` and `getState()` methods are deprecated.** These have been replaced by property getters on the editor instance itself—`editor.schema`, `editor.stack` and `editor.value`, respectively. This is to reduce confusion with React's own `setState`, and to make accessing these commonly used properties more convenient.
###### NEW
- **Added a new `editor.value` getter property.** This now mimics the DOM for things like `input.value` and `textarea.value`, and is the new way to access the editor's current value.
- **Added new `editor.schema` and `editor.stack` getters.** Similarly to the new `value` getter, these two new getters give you access to the editor's current schema and stack.
---
### `0.8.0` — October 25, 2017
###### BREAKING

View File

@@ -7,6 +7,18 @@ This document maintains a list of changes to the `slate-simulator` package with
---
### `0.3.0` — October 27, 2017
###### DEPRECATED
- **The `props.state` prop has been renamed to `props.value`.** This is to stay in line with `slate-react@0.9.0` where the same change was made to the `<Editor>`.
- **The `simulator.state` property is now `simulator.value`** This is to stay in line with `slate@0.29.0` where the same change as made to the `Change` objects.
---
### `0.2.0` — October 25, 2017
###### BREAKING

View File

@@ -41,17 +41,17 @@ class Simulator {
this.stack = stack
this.value = value
if (props.state) {
logger.deprecate('slate-simulator@0.3.0', 'The `state` prop has been renamed to `value`.')
this.value = props.state
}
Object.defineProperty(this, 'state', {
get() {
logger.deprecate('slate-simulator@0.3.0', 'The `simulator.state` property has been renamed to `simulator.value`.')
return this.value
}
})
if (props.state) {
logger.deprecate('slate-simulator@0.3.0', 'The `state` prop has been renamed to `value`.')
this.value = props.state
}
}
}

View File

@@ -7,6 +7,24 @@ This document maintains a list of changes to the `slate` package with each new v
---
### `0.29.0` — October 27, 2017
###### BREAKING
- **The `set_state` operation has been renamed `set_value`**. This shouldn't affect almost anyone, but in the event that you were relying on the low-level operation types you'll need to update this.
###### DEPRECATED
- **The "state" has been renamed to "value" everywhere.** All of the current references are maintained as deprecations, so you should be able to upgrade and see warnings logged instead of being greeted with a broken editor. This is to reduce the confusion between React's "state" and Slate's editor value, and in an effort to further mimic the native DOM APIs.
###### NEW
- **Added the new `Value` model to replace `State`.** The new model is exactly the same, but with a new name. There is also a shimmed `State` model exported that warns when used, to ease migration.
---
### `0.28.0` — October 25, 2017
###### BREAKING