slate

Minor Changes

• #5528 c4c14882 Thanks @dylans! - Update dependencies to React 18, Node 20, TS 5.2, etc.

Minor Changes

• #5528 c4c14882 Thanks @dylans! - Update dependencies to React 18, Node 20, TS 5.2, etc.

Minor Changes

• #5528 c4c14882 Thanks @dylans! - Update dependencies to React 18, Node 20, TS 5.2, etc.

Minor Changes

• #5516 300dc57a Thanks @josephmr! - Retain editor selection when using ReactEditor.focus()

Patch Changes

• #5514 ff7db221 Thanks @YaoKaiLun! - Fix move_node triggers nodes re-render

Patch Changes

• #5510 13c7d271 Thanks @e1himself! - Remove an unused React ref

Patch Changes

• #5503 e308cd66 Thanks @janpaepke! - bugfix: slate breaks on load on safari < 16.4

Patch Changes

• #5497 76ba3759 Thanks @Dimitri-WEI-Lingfeng! - fix the bug that user cannot input chinese on mac wechat browser.

Patch Changes

• #5491 a5576e56 Thanks @WcaleNieWolny! - Fix firefox table selection if table is contentedtiable

Minor Changes

• #5486 8b548fb5 Thanks @WcaleNieWolny! - Fix invalid usage of the selection API in firefox

Patch Changes

• #5462 a6b606d8 Thanks @Ben-Wormald! - Update hotkeys util to use isHotkey for better support for non-latin keyboards

• #5470 4bd15ed3 Thanks @josephmr! - Fix Android caret placement regression when inputting into empty editor

Patch Changes

• #5460 53395449 Thanks @12joan! - Do not attempt to batch updates manually in React >= 18

Minor Changes

• #5451 12ff246e Thanks @gtluszcz! - Fixed occasional crashes when selecting void elements in Chrome

Patch Changes

• #5453 cde0a155 Thanks @Shiba-ligo! - fix regular expression for testing Webkit based browser.

Minor Changes

• #5437 3ad13d60 Thanks @josephmr! - Detect all WebKit based browsers for COMPAT behavior

Patch Changes

• #5443 eb7f5987 Thanks @OldDream! - fix wrong caret position during composition.

Minor Changes

• #5422 0b179909 Thanks @Chudesnov! - Prevents default focus styles from being removed in Editable

• #5421 91e388ec Thanks @e1himself! - Rename <Slate> component prop from value to initialValue to emphasize uncontrolled nature of it

Patch Changes

• #5423 042bca16 Thanks @horacioh! - fix placeholder position in Safari 16.x

Patch Changes

• #5415 01f0210b Thanks @zbeyens! - Editor.insertFragment, Editor.insertNode, Editor.insertText now accept options.
  For all insert methods, the default location is now the editor selection if at is not defined, or the end of document if editor.selection is not defined.

Patch Changes

• #5307 3243c7e3 Thanks @zbeyens! - Interface methods JSDoc should now work on IDEs.

Minor Changes

• #5307 3243c7e3 Thanks @zbeyens! - New Features:

  • All Editor and Transforms methods now call editor methods. For example: Transforms.insertBreak now calls editor.insertBreak.
  • editor.setNodes now calls setNodes, an exported function that implements the default editor behavior.
  • You can now override editor.setNodes with your own implementation.
  • You can use either Editor.setNodes or editor.setNodes in your code, and both will use your overridden behavior.

  The editor object now has many more methods:

  export interface BaseEditor {
    // Core state.
  
    children: Descendant[]
    selection: Selection
    operations: Operation[]
    marks: EditorMarks | null
  
    // Overrideable core methods.
  
    apply: (operation: Operation) => void
    getDirtyPaths: (operation: Operation) => Path[]
    getFragment: () => Descendant[]
    isElementReadOnly: (element: Element) => boolean
    isSelectable: (element: Element) => boolean
    markableVoid: (element: Element) => boolean
    normalizeNode: (
      entry: NodeEntry,
      options?: { operation?: Operation }
    ) => void
    onChange: (options?: { operation?: Operation }) => void
    shouldNormalize: ({
      iteration,
      dirtyPaths,
      operation,
    }: {
      iteration: number
      initialDirtyPathsLength: number
      dirtyPaths: Path[]
      operation?: Operation
    }) => boolean
  
    // Overrideable core transforms.
  
    addMark: OmitFirstArg<typeof Editor.addMark>
    collapse: OmitFirstArg<typeof Transforms.collapse>
    delete: OmitFirstArg<typeof Transforms.delete>
    deleteBackward: (unit: TextUnit) => void
    deleteForward: (unit: TextUnit) => void
    deleteFragment: OmitFirstArg<typeof Editor.deleteFragment>
    deselect: OmitFirstArg<typeof Transforms.deselect>
    insertBreak: OmitFirstArg<typeof Editor.insertBreak>
    insertFragment: OmitFirstArg<typeof Transforms.insertFragment>
    insertNode: OmitFirstArg<typeof Editor.insertNode>
    insertNodes: OmitFirstArg<typeof Transforms.insertNodes>
    insertSoftBreak: OmitFirstArg<typeof Editor.insertSoftBreak>
    insertText: OmitFirstArg<typeof Transforms.insertText>
    liftNodes: OmitFirstArg<typeof Transforms.liftNodes>
    mergeNodes: OmitFirstArg<typeof Transforms.mergeNodes>
    move: OmitFirstArg<typeof Transforms.move>
    moveNodes: OmitFirstArg<typeof Transforms.moveNodes>
    normalize: OmitFirstArg<typeof Editor.normalize>
    removeMark: OmitFirstArg<typeof Editor.removeMark>
    removeNodes: OmitFirstArg<typeof Transforms.removeNodes>
    select: OmitFirstArg<typeof Transforms.select>
    setNodes: <T extends Node>(
      props: Partial<T>,
      options?: {
        at?: Location
        match?: NodeMatch<T>
        mode?: MaximizeMode
        hanging?: boolean
        split?: boolean
        voids?: boolean
        compare?: PropsCompare
        merge?: PropsMerge
      }
    ) => void
    setNormalizing: OmitFirstArg<typeof Editor.setNormalizing>
    setPoint: OmitFirstArg<typeof Transforms.setPoint>
    setSelection: OmitFirstArg<typeof Transforms.setSelection>
    splitNodes: OmitFirstArg<typeof Transforms.splitNodes>
    unsetNodes: OmitFirstArg<typeof Transforms.unsetNodes>
    unwrapNodes: OmitFirstArg<typeof Transforms.unwrapNodes>
    withoutNormalizing: OmitFirstArg<typeof Editor.withoutNormalizing>
    wrapNodes: OmitFirstArg<typeof Transforms.wrapNodes>
  
    // Overrideable core queries.
  
    above: <T extends Ancestor>(
      options?: EditorAboveOptions<T>
    ) => NodeEntry<T> | undefined
    after: OmitFirstArg<typeof Editor.after>
    before: OmitFirstArg<typeof Editor.before>
    edges: OmitFirstArg<typeof Editor.edges>
    elementReadOnly: OmitFirstArg<typeof Editor.elementReadOnly>
    end: OmitFirstArg<typeof Editor.end>
    first: OmitFirstArg<typeof Editor.first>
    fragment: OmitFirstArg<typeof Editor.fragment>
    getMarks: OmitFirstArg<typeof Editor.marks>
    hasBlocks: OmitFirstArg<typeof Editor.hasBlocks>
    hasInlines: OmitFirstArg<typeof Editor.hasInlines>
    hasPath: OmitFirstArg<typeof Editor.hasPath>
    hasTexts: OmitFirstArg<typeof Editor.hasTexts>
    isBlock: OmitFirstArg<typeof Editor.isBlock>
    isEdge: OmitFirstArg<typeof Editor.isEdge>
    isEmpty: OmitFirstArg<typeof Editor.isEmpty>
    isEnd: OmitFirstArg<typeof Editor.isEnd>
    isInline: OmitFirstArg<typeof Editor.isInline>
    isNormalizing: OmitFirstArg<typeof Editor.isNormalizing>
    isStart: OmitFirstArg<typeof Editor.isStart>
    isVoid: OmitFirstArg<typeof Editor.isVoid>
    last: OmitFirstArg<typeof Editor.last>
    leaf: OmitFirstArg<typeof Editor.leaf>
    levels: <T extends Node>(
      options?: EditorLevelsOptions<T>
    ) => Generator<NodeEntry<T>, void, undefined>
    next: <T extends Descendant>(
      options?: EditorNextOptions<T>
    ) => NodeEntry<T> | undefined
    node: OmitFirstArg<typeof Editor.node>
    nodes: <T extends Node>(
      options?: EditorNodesOptions<T>
    ) => Generator<NodeEntry<T>, void, undefined>
    parent: OmitFirstArg<typeof Editor.parent>
    path: OmitFirstArg<typeof Editor.path>
    pathRef: OmitFirstArg<typeof Editor.pathRef>
    pathRefs: OmitFirstArg<typeof Editor.pathRefs>
    point: OmitFirstArg<typeof Editor.point>
    pointRef: OmitFirstArg<typeof Editor.pointRef>
    pointRefs: OmitFirstArg<typeof Editor.pointRefs>
    positions: OmitFirstArg<typeof Editor.positions>
    previous: <T extends Node>(
      options?: EditorPreviousOptions<T>
    ) => NodeEntry<T> | undefined
    range: OmitFirstArg<typeof Editor.range>
    rangeRef: OmitFirstArg<typeof Editor.rangeRef>
    rangeRefs: OmitFirstArg<typeof Editor.rangeRefs>
    start: OmitFirstArg<typeof Editor.start>
    string: OmitFirstArg<typeof Editor.string>
    unhangRange: OmitFirstArg<typeof Editor.unhangRange>
    void: OmitFirstArg<typeof Editor.void>
  }
  

  Note:

  • None of these method implementations have changed.
  • getMarks is an exception, as there is already editor.marks that stores the current marks.
  • Transforms.insertText has not been moved to editor yet: there is already an editor.insertText method with extended behavior. This may change in a future release, but this release is trying to avoid any breaking changes.
  • editor.insertText has a new argument (third): options?: TextInsertTextOptions to match Transforms.insertText.

  Bug Fixes:

  • Moving JSDoc's to the interface type to allow IDEs access to the interface methods.

Patch Changes

• #5396 bc945eb1 Thanks @Moerphy! - Correct core normalization that could cause wrong nodes to be removed

Minor Changes

• #5382 Thanks @reinvanimschoot! - Extracts history push to own function

Minor Changes

• #5374 b52e08b0 Thanks @12joan! - - Add isSelectable to editor (default true). A non-selectable element is skipped over when navigating using arrow keys.

  • Add ignoreNonSelectable to Editor.nodes, Editor.positions, Editor.after and Editor.before (default false)
  • Transforms.move ignores non-selectable elements

• #5374 b52e08b0 Thanks @12joan! - - Add isElementReadOnly to editor. A read-only element behaves much like a void with regard to selection and deletion, but renders its children the same as any other non-void node.