Releases: ianstormtaylor/slate
Releases · ianstormtaylor/slate
0.11.0
BREAKING CHANGES
- Void nodes are renderered implicitly again! Previously Slate had required that you wrap void node renderers yourself with the exposed
<Void>wrapping component. This was to allow for selection styling, but a change was made to make selection styling able to handled in Javascript. Now the<Void>wrapper will be implicitly rendered by Slate, so you do not need to worry about it, and "voidness" only needs to toggled in one place, theisVoid: trueproperty of a node.
0.10.0
BREAKING CHANGES
- Marks are now renderable as components. Previously the only supported way to render marks was by returning a
styleobject. Now you can return a style object, a class name string, or a full React component. Because of this, the DOM will be renderered slightly differently than before, resulting in an extra<span>when rendering non-component marks. This won't affect you unless you were depending on the DOM output by Slate for some reason.
0.9.0
BREAKING CHANGES
- The
wrapandunwrapmethod signatures have changed! Previously, you would passtypeanddataas separate parameters, for example:wrapBlock('code', { src: true }). This was inconsistent with other transforms, and has been updated such that a single argument ofpropertiesis passed instead. So that example could now be:wrapBlock({ type: 'code', { data: { src: true }}). You can still pass atypestring as shorthand, which will be the most frequent use case, for example:wrapBlock('code').
0.8.0
BREAKING CHANGES
- The
onKeyDownandonBeforeInputhandlers signatures have changed! Previously, some Slate handlers had a signature of(e, state, editor)and others had a signature of(e, data, state, editor). Now all handlers will be passed adataobject—which contains Slate-specific data related to the event—even if it is empty. This is helpful for future compatibility where we might need to add data to a handler that previously didn't have any, and is nicer for consistency. TheonKeyDownhandler's newdataobject contains thekeyname,codeand a series ofis*properties to make working with hotkeys easier. TheonBeforeInputhandler's newdataobject is empty. - The
Utilsexport has been removed. Previously, aKeyutility and thefindDOMNodeutility were exposed under theUtilsobject. TheKeyhas been removed in favor of thedataobject passed toonKeyDown. And thenfindDOMNodeutility has been upgraded to a top-level named export, so you'll now need to access it viaimport { findDOMNode } from 'slate'. - Void nodes now permanently have
" "as content. Previously, they contained an empty string, but this isn't technically correct, since they have content and shouldn't be considered "empty". Now they will have a single space of content. This shouldn't really affect anyone, unless you happened to be accessing that string for serialization. - Empty inline nodes are now impossible. This is to stay consistent with native
contenteditablebehavior, where although technically the elements can exist, they have odd behavior and can never be selected.
0.7.0
BREAKING CHANGES
- The
Rawserializer is no longer terse by default! Previously, theRawserializer would return a "terse" representation of the document, omitting information that wasn't strictly necessary to deserialize later, like thekeyof nodes. By default this no longer happens. You have to opt-in to the behavior by passing{ terse: true }as the secondoptionsargument of thedeserializeandserializemethods.
0.6.0
BREAKING CHANGES
- Void components are no longer rendered implicity! Previously, Slate would automatically wrap any node with
isVoid: truein a<Void>component. But doing this prevented you from customizing the wrapper, like adding aclassNameorstyleproperty. So you must now render the wrapper yourself, and it has been exported asSlate.Void. This, combined with a small change to the<Void>component's structure allows the "selected" state of void nodes to be rendered purely with CSS based on the:focusproperty of a<Void>element, which previously had to be handled in Javascript. This allows us to streamline selection-handling logic, improving performance and reducing complexity. data-offset-keyis now<key>-<index>instead of<key>:<start>-<end>. This shouldn't actually affect anyone, unless you were specifically relying on that attribute in the DOM. This change greatly reduces the number of re-renders needed, since previously any additional characters would cause a cascading change in the<start>and<end>offsets of latter text ranges.
0.5.0
BREAKING CHANGES
node.getTextNodes()is nownode.getTexts(). This is just for consistency with the other existingNodemethods likegetBlocks(),getInlines(), etc. And it's nicely shorter. 😉Nodemethods nowthrowearlier during unexpected states. This shouldn't break anything for most folks, unless a strange edge-case was going undetected previously.
0.4.0
BREAKING CHANGES
renderMark(mark, state, editor)is nowrenderMark(mark, marks, state, editor). This change allows you to render marks based on multiplemarkspresence at once on a given range of text, for example using a customBoldItalic.otffont when text has bothboldanditalicmarks.
0.3.0
BREAKING CHANGES
transform.unwrapBlock()now unwraps selectively. Previously, callingunwrapBlockwith a range representing a middle sibling would unwrap all of the siblings, removing the wrapping block entirely. Now, calling it with those same arguments will only move the middle sibling up a layer in the hierarchy, preserving the nesting on any of its siblings. This changes makes it much simpler to implement functionality like unwrapping a single list item, which previously would unwrap the entire list.
0.2.0
BREAKING CHANGES
transform.mark()is nowtransform.addMark()andtransform.unmark()is nowtransform.removeMark(). The new names make it clearer that the transforms are actions being performed, and it paves the way for adding atoggleMarkconvenience as well.