@portabletext/editor 3.3.2 → 3.3.4

package/src/behaviors/behavior.abstract.insert.ts

@@ -1,525 +0,0 @@
-import {isSelectionExpanded} from '../selectors'
-import {getFocusTextBlock} from '../selectors/selector.get-focus-text-block'
-import {getLastBlock} from '../selectors/selector.get-last-block'
-import {getBlockEndPoint} from '../utils/util.get-block-end-point'
-import {getBlockStartPoint} from '../utils/util.get-block-start-point'
-import {isEmptyTextBlock} from '../utils/util.is-empty-text-block'
-import {isEqualSelectionPoints} from '../utils/util.is-equal-selection-points'
-import {sliceTextBlock} from '../utils/util.slice-text-block'
-import {raise} from './behavior.types.action'
-import {defineBehavior} from './behavior.types.behavior'
-
-export const abstractInsertBehaviors = [
-  defineBehavior({
-    on: 'insert.blocks',
-    guard: ({event}) => {
-      const onlyBlock =
-        event.blocks.length === 1 ? event.blocks.at(0) : undefined
-
-      if (!onlyBlock) {
-        return false
-      }
-
-      return {onlyBlock}
-    },
-    actions: [
-      ({event}, {onlyBlock}) => [
-        raise({
-          type: 'insert.block',
-          block: onlyBlock,
-          placement: event.placement,
-          select: event.select ?? 'end',
-        }),
-      ],
-    ],
-  }),
-  defineBehavior({
-    on: 'insert.blocks',
-    guard: ({snapshot, event}) => {
-      if (event.placement !== 'before') {
-        return false
-      }
-
-      const firstBlockKey =
-        event.blocks.at(0)?._key ?? snapshot.context.keyGenerator()
-      const lastBlockKey =
-        event.blocks.at(-1)?._key ?? snapshot.context.keyGenerator()
-
-      return {firstBlockKey, lastBlockKey}
-    },
-    actions: [
-      ({snapshot, event}, {firstBlockKey, lastBlockKey}) => [
-        ...event.blocks.map((block, index) =>
-          raise({
-            type: 'insert.block',
-            block,
-            placement: index === 0 ? 'before' : 'after',
-            select: index !== event.blocks.length - 1 ? 'end' : 'none',
-          }),
-        ),
-        ...(event.select === 'none'
-          ? [
-              raise({
-                type: 'select',
-                at: snapshot.context.selection,
-              }),
-            ]
-          : event.select === 'start'
-            ? [
-                raise({
-                  type: 'select.block',
-                  at: [{_key: firstBlockKey}],
-                  select: 'start',
-                }),
-              ]
-            : [
-                raise({
-                  type: 'select.block',
-                  at: [{_key: lastBlockKey}],
-                  select: 'end',
-                }),
-              ]),
-      ],
-    ],
-  }),
-  defineBehavior({
-    on: 'insert.blocks',
-    guard: ({snapshot, event}) => {
-      if (event.placement !== 'after') {
-        return false
-      }
-
-      const firstBlockKey =
-        event.blocks.at(0)?._key ?? snapshot.context.keyGenerator()
-      const lastBlockKey =
-        event.blocks.at(-1)?._key ?? snapshot.context.keyGenerator()
-
-      return {firstBlockKey, lastBlockKey}
-    },
-    actions: [
-      ({snapshot, event}, {firstBlockKey, lastBlockKey}) => [
-        ...event.blocks.map((block, index) =>
-          raise({
-            type: 'insert.block',
-            block,
-            placement: 'after',
-            select: index !== event.blocks.length - 1 ? 'end' : 'none',
-          }),
-        ),
-        ...(event.select === 'none'
-          ? [
-              raise({
-                type: 'select',
-                at: snapshot.context.selection,
-              }),
-            ]
-          : event.select === 'start'
-            ? [
-                raise({
-                  type: 'select.block',
-                  at: [{_key: firstBlockKey}],
-                  select: 'start',
-                }),
-              ]
-            : [
-                raise({
-                  type: 'select.block',
-                  at: [{_key: lastBlockKey}],
-                  select: 'end',
-                }),
-              ]),
-      ],
-    ],
-  }),
-  defineBehavior({
-    on: 'insert.blocks',
-    guard: ({snapshot, event}) => {
-      if (event.placement !== 'auto') {
-        return false
-      }
-
-      const focusTextBlock = getFocusTextBlock(snapshot)
-
-      if (!focusTextBlock) {
-        return false
-      }
-
-      if (!isEmptyTextBlock(snapshot.context, focusTextBlock.node)) {
-        return false
-      }
-
-      const firstBlockKey =
-        event.blocks.at(0)?._key ?? snapshot.context.keyGenerator()
-      const lastBlockKey =
-        event.blocks.at(-1)?._key ?? snapshot.context.keyGenerator()
-
-      return {focusTextBlock, firstBlockKey, lastBlockKey}
-    },
-    actions: [
-      ({event}, {firstBlockKey, lastBlockKey}) => [
-        ...event.blocks.map((block, index) =>
-          raise({
-            type: 'insert.block',
-            block,
-            placement: index === 0 ? 'auto' : 'after',
-            select: index !== event.blocks.length - 1 ? 'end' : 'none',
-          }),
-        ),
-        ...(event.select === 'none' || event.select === 'start'
-          ? [
-              raise({
-                type: 'select.block',
-                at: [{_key: firstBlockKey}],
-                select: 'start',
-              }),
-            ]
-          : [
-              raise({
-                type: 'select.block',
-                at: [{_key: lastBlockKey}],
-                select: 'end',
-              }),
-            ]),
-      ],
-    ],
-  }),
-  defineBehavior({
-    on: 'insert.blocks',
-    guard: ({snapshot, event}) => {
-      if (event.placement !== 'auto') {
-        return false
-      }
-
-      const focusTextBlock = getFocusTextBlock(snapshot)
-
-      if (!focusTextBlock || !snapshot.context.selection) {
-        return false
-      }
-
-      const focusBlockStartPoint = getBlockStartPoint({
-        context: snapshot.context,
-        block: focusTextBlock,
-      })
-      const focusBlockEndPoint = getBlockEndPoint({
-        context: snapshot.context,
-        block: focusTextBlock,
-      })
-      const focusTextBlockAfter = sliceTextBlock({
-        context: {
-          schema: snapshot.context.schema,
-          selection: {
-            anchor: snapshot.context.selection.focus,
-            focus: focusBlockEndPoint,
-          },
-        },
-        block: focusTextBlock.node,
-      })
-      const firstBlockKey =
-        event.blocks.at(0)?._key ?? snapshot.context.keyGenerator()
-
-      return {
-        firstBlockKey,
-        focusBlockStartPoint,
-        focusBlockEndPoint,
-        focusTextBlockAfter,
-        selection: snapshot.context.selection,
-      }
-    },
-    actions: [
-      (
-        {event},
-        {
-          focusBlockEndPoint,
-          focusTextBlockAfter,
-          selection,
-          firstBlockKey,
-          focusBlockStartPoint,
-        },
-      ) => [
-        ...event.blocks.flatMap((block, index) =>
-          index === 0
-            ? [
-                ...(isEqualSelectionPoints(selection.focus, focusBlockEndPoint)
-                  ? []
-                  : [
-                      raise({
-                        type: 'delete',
-                        at: {
-                          anchor: selection.focus,
-                          focus: focusBlockEndPoint,
-                        },
-                      }),
-                    ]),
-                raise({
-                  type: 'insert.block',
-                  block,
-                  placement: 'auto',
-                  select: 'end',
-                }),
-              ]
-            : index === event.blocks.length - 1
-              ? [
-                  raise({
-                    type: 'insert.block',
-                    block,
-                    placement: 'after',
-                    select: 'end',
-                  }),
-                  raise({
-                    type: 'insert.block',
-                    block: focusTextBlockAfter,
-                    placement: 'auto',
-                    select: event.select === 'end' ? 'none' : 'end',
-                  }),
-                ]
-              : [
-                  raise({
-                    type: 'insert.block',
-                    block,
-                    placement: 'after',
-                    select: 'end',
-                  }),
-                ],
-        ),
-        ...(event.select === 'none'
-          ? [
-              raise({
-                type: 'select',
-                at: selection,
-              }),
-            ]
-          : event.select === 'start'
-            ? [
-                isEqualSelectionPoints(selection.focus, focusBlockStartPoint)
-                  ? raise({
-                      type: 'select.block',
-                      at: [{_key: firstBlockKey}],
-                      select: 'start',
-                    })
-                  : raise({
-                      type: 'select',
-                      at: {
-                        anchor: selection.focus,
-                        focus: selection.focus,
-                      },
-                    }),
-              ]
-            : []),
-      ],
-    ],
-  }),
-  defineBehavior({
-    on: 'insert.blocks',
-    guard: ({event}) => event.placement === 'auto',
-    actions: [
-      ({event}) =>
-        event.blocks.map((block, index) =>
-          raise({
-            type: 'insert.block',
-            block,
-            placement: index === 0 ? 'auto' : 'after',
-            select: event.select ?? 'end',
-          }),
-        ),
-    ],
-  }),
-  defineBehavior({
-    on: 'insert.break',
-    actions: [() => [raise({type: 'split'})]],
-  }),
-  defineBehavior({
-    on: 'insert.child',
-    guard: ({snapshot}) => {
-      const lastBlock = getLastBlock(snapshot)
-
-      if (!lastBlock) {
-        return false
-      }
-
-      if (snapshot.context.selection) {
-        return false
-      }
-
-      const lastBlockEndPoint = getBlockEndPoint({
-        context: snapshot.context,
-        block: lastBlock,
-      })
-
-      return {lastBlockEndPoint}
-    },
-    actions: [
-      ({event}, {lastBlockEndPoint}) => [
-        raise({
-          type: 'select',
-          at: {
-            anchor: lastBlockEndPoint,
-            focus: lastBlockEndPoint,
-          },
-        }),
-        raise(event),
-      ],
-    ],
-  }),
-  defineBehavior({
-    on: 'insert.child',
-    guard: ({snapshot}) => {
-      const focusTextBlock = getFocusTextBlock(snapshot)
-
-      return snapshot.context.selection && !focusTextBlock
-    },
-    actions: [
-      ({snapshot, event}) => [
-        raise({
-          type: 'insert.block',
-          block: {
-            _type: snapshot.context.schema.block.name,
-            children: [
-              {
-                _type: snapshot.context.schema.span.name,
-                text: '',
-                marks: [],
-              },
-            ],
-          },
-          placement: 'auto',
-          select: 'end',
-        }),
-        raise(event),
-      ],
-    ],
-  }),
-  defineBehavior({
-    on: 'insert.inline object',
-    actions: [
-      ({event}) => [
-        raise({
-          type: 'insert.child',
-          child: {
-            _type: event.inlineObject.name,
-            ...event.inlineObject.value,
-          },
-        }),
-      ],
-    ],
-  }),
-  defineBehavior({
-    on: 'insert.soft break',
-    actions: [() => [raise({type: 'insert.text', text: '\n'})]],
-  }),
-  defineBehavior({
-    on: 'insert.span',
-    guard: ({snapshot}) => !getFocusTextBlock(snapshot),
-    actions: [
-      ({snapshot, event}) => [
-        raise({
-          type: 'insert.block',
-          block: {
-            _type: snapshot.context.schema.block.name,
-            children: [
-              {
-                _type: snapshot.context.schema.span.name,
-                text: '',
-                marks: [],
-              },
-            ],
-          },
-          placement: 'auto',
-          select: 'end',
-        }),
-        raise(event),
-      ],
-    ],
-  }),
-  defineBehavior({
-    on: 'insert.span',
-    guard: ({snapshot, event}) => {
-      const focusTextBlock = getFocusTextBlock(snapshot)
-      const markDefs =
-        event.annotations?.map((annotation) => ({
-          _type: annotation.name,
-          _key: snapshot.context.keyGenerator(),
-          ...annotation.value,
-        })) ?? []
-
-      return {markDefs, focusTextBlock}
-    },
-    actions: [
-      ({snapshot, event}, {markDefs, focusTextBlock}) => [
-        ...(focusTextBlock
-          ? [
-              raise({
-                type: 'block.set',
-                at: focusTextBlock.path,
-                props: {
-                  markDefs: [
-                    ...(focusTextBlock.node.markDefs ?? []),
-                    ...markDefs,
-                  ],
-                },
-              }),
-            ]
-          : []),
-        raise({
-          type: 'insert.child',
-          child: {
-            _type: snapshot.context.schema.span.name,
-            text: event.text,
-            marks: [
-              ...(event.decorators ?? []),
-              ...markDefs.map((markDef) => markDef._key),
-            ],
-          },
-        }),
-      ],
-    ],
-  }),
-
-  /**
-   * If there's an expanded selection, then we delete the selection before we
-   * insert the text.
-   */
-  defineBehavior({
-    on: 'insert.text',
-    guard: ({snapshot}) => {
-      return isSelectionExpanded(snapshot)
-    },
-    actions: [({event}) => [raise({type: 'delete'}), raise(event)]],
-  }),
-
-  /**
-   * If there's no selection, then we select the end of the editor before we
-   * we insert the text.
-   */
-  defineBehavior({
-    on: 'insert.text',
-    guard: ({snapshot}) => {
-      if (snapshot.context.selection) {
-        return false
-      }
-
-      const lastBlok = getLastBlock(snapshot)
-
-      if (!lastBlok) {
-        return false
-      }
-
-      const endPoint = getBlockEndPoint({
-        context: snapshot.context,
-        block: lastBlok,
-      })
-      return {endPoint}
-    },
-    actions: [
-      ({event}, {endPoint}) => [
-        raise({
-          type: 'select',
-          at: {
-            anchor: endPoint,
-            focus: endPoint,
-          },
-        }),
-        raise(event),
-      ],
-    ],
-  }),
-]

package/src/behaviors/behavior.abstract.keyboard.ts

@@ -1,189 +0,0 @@
-import {createKeyboardShortcut} from '@portabletext/keyboard-shortcuts'
-import {isTextBlock} from '@portabletext/schema'
-import {defaultKeyboardShortcuts} from '../keyboard-shortcuts/default-keyboard-shortcuts'
-import {getFocusBlock} from '../selectors/selector.get-focus-block'
-import {getFocusInlineObject} from '../selectors/selector.get-focus-inline-object'
-import {getPreviousBlock} from '../selectors/selector.get-previous-block'
-import {isSelectionCollapsed} from '../selectors/selector.is-selection-collapsed'
-import {isSelectionExpanded} from '../selectors/selector.is-selection-expanded'
-import {getBlockEndPoint} from '../utils/util.get-block-end-point'
-import {isEmptyTextBlock} from '../utils/util.is-empty-text-block'
-import {raise} from './behavior.types.action'
-import {defineBehavior} from './behavior.types.behavior'
-
-const shiftLeft = createKeyboardShortcut({
-  default: [
-    {
-      key: 'ArrowLeft',
-      shift: true,
-      meta: false,
-      ctrl: false,
-      alt: false,
-    },
-  ],
-})
-
-export const abstractKeyboardBehaviors = [
-  /**
-   * When Backspace is pressed on an inline object, Slate will raise a
-   * `delete.backward` event with `unit: 'block'`. This is wrong and this
-   * Behavior adjusts that.
-   */
-  defineBehavior({
-    on: 'keyboard.keydown',
-    guard: ({snapshot, event}) =>
-      defaultKeyboardShortcuts.backspace.guard(event.originEvent) &&
-      isSelectionCollapsed(snapshot) &&
-      getFocusInlineObject(snapshot),
-    actions: [() => [raise({type: 'delete.backward', unit: 'character'})]],
-  }),
-
-  /**
-   * When Delete is pressed on an inline object, Slate will raise a
-   * `delete.forward` event with `unit: 'block'`. This is wrong and this
-   * Behavior adjusts that.
-   */
-  defineBehavior({
-    on: 'keyboard.keydown',
-    guard: ({snapshot, event}) =>
-      defaultKeyboardShortcuts.delete.guard(event.originEvent) &&
-      isSelectionCollapsed(snapshot) &&
-      getFocusInlineObject(snapshot),
-    actions: [() => [raise({type: 'delete.forward', unit: 'character'})]],
-  }),
-
-  defineBehavior({
-    on: 'keyboard.keydown',
-    guard: ({event}) =>
-      defaultKeyboardShortcuts.deleteWord.backward.guard(event.originEvent),
-    actions: [() => [raise({type: 'delete.backward', unit: 'word'})]],
-  }),
-
-  defineBehavior({
-    on: 'keyboard.keydown',
-    guard: ({event}) =>
-      defaultKeyboardShortcuts.deleteWord.forward.guard(event.originEvent),
-    actions: [() => [raise({type: 'delete.forward', unit: 'word'})]],
-  }),
-
-  /**
-   * Allow raising an `insert.break` event when pressing Enter on an inline
-   * object.
-   */
-  defineBehavior({
-    on: 'keyboard.keydown',
-    guard: ({snapshot, event}) =>
-      defaultKeyboardShortcuts.break.guard(event.originEvent) &&
-      isSelectionCollapsed(snapshot) &&
-      getFocusInlineObject(snapshot),
-    actions: [() => [raise({type: 'insert.break'})]],
-  }),
-
-  /**
-   * On Firefox, Enter might collapse the selection. To mitigate this, we
-   * `raise` an `insert.break` event manually.
-   */
-  defineBehavior({
-    on: 'keyboard.keydown',
-    guard: ({snapshot, event}) =>
-      defaultKeyboardShortcuts.break.guard(event.originEvent) &&
-      isSelectionExpanded(snapshot),
-    actions: [() => [raise({type: 'insert.break'})]],
-  }),
-
-  /**
-   * On WebKit, Shift+Enter results in an `insertParagraph` input event rather
-   * than an `insertLineBreak` input event. This Behavior makes sure we catch
-   * that `keyboard.keydown` event beforehand and raise an `insert.soft break` manually.
-   */
-  defineBehavior({
-    on: 'keyboard.keydown',
-    guard: ({event}) =>
-      defaultKeyboardShortcuts.lineBreak.guard(event.originEvent),
-    actions: [() => [raise({type: 'insert.soft break'})]],
-  }),
-
-  /**
-   * Manual handling of undo shortcuts.
-   */
-  defineBehavior({
-    on: 'keyboard.keydown',
-    guard: ({event}) =>
-      defaultKeyboardShortcuts.history.undo.guard(event.originEvent),
-    actions: [() => [raise({type: 'history.undo'})]],
-  }),
-
-  /**
-   * Manual handling of redo shortcuts.
-   */
-  defineBehavior({
-    on: 'keyboard.keydown',
-    guard: ({event}) =>
-      defaultKeyboardShortcuts.history.redo.guard(event.originEvent),
-    actions: [() => [raise({type: 'history.redo'})]],
-  }),
-
-  /**
-   * Fix edge case where Shift+ArrowLeft didn't reduce a selection hanging
-   * onto an empty text block.
-   */
-  defineBehavior({
-    on: 'keyboard.keydown',
-    guard: ({snapshot, event}) => {
-      if (!snapshot.context.selection || !shiftLeft.guard(event.originEvent)) {
-        return false
-      }
-
-      const focusBlock = getFocusBlock(snapshot)
-
-      if (!focusBlock) {
-        return false
-      }
-
-      const previousBlock = getPreviousBlock({
-        ...snapshot,
-        context: {
-          ...snapshot.context,
-          selection: {
-            anchor: {
-              path: focusBlock.path,
-              offset: 0,
-            },
-            focus: {
-              path: focusBlock.path,
-              offset: 0,
-            },
-          },
-        },
-      })
-
-      if (!previousBlock) {
-        return false
-      }
-
-      const hanging =
-        isTextBlock(snapshot.context, focusBlock.node) &&
-        snapshot.context.selection.focus.offset === 0
-
-      if (hanging && isEmptyTextBlock(snapshot.context, focusBlock.node)) {
-        return {previousBlock, selection: snapshot.context.selection}
-      }
-
-      return false
-    },
-    actions: [
-      ({snapshot}, {previousBlock, selection}) => [
-        raise({
-          type: 'select',
-          at: {
-            anchor: selection.anchor,
-            focus: getBlockEndPoint({
-              context: snapshot.context,
-              block: previousBlock,
-            }),
-          },
-        }),
-      ],
-    ],
-  }),
-]