@portabletext/editor 3.3.3 → 3.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/_chunks-dts/index.d.ts +21 -1667
- package/lib/index.js +511 -9010
- package/lib/index.js.map +1 -1
- package/package.json +14 -15
- package/src/behaviors/_exports/index.ts +0 -1
- package/src/behaviors/behavior.abstract.annotation.ts +0 -77
- package/src/behaviors/behavior.abstract.decorator.ts +0 -39
- package/src/behaviors/behavior.abstract.delete.ts +0 -273
- package/src/behaviors/behavior.abstract.deserialize.ts +0 -232
- package/src/behaviors/behavior.abstract.insert.ts +0 -525
- package/src/behaviors/behavior.abstract.keyboard.ts +0 -189
- package/src/behaviors/behavior.abstract.list-item.ts +0 -70
- package/src/behaviors/behavior.abstract.move.ts +0 -79
- package/src/behaviors/behavior.abstract.select.ts +0 -118
- package/src/behaviors/behavior.abstract.serialize.ts +0 -96
- package/src/behaviors/behavior.abstract.split.ts +0 -170
- package/src/behaviors/behavior.abstract.style.ts +0 -55
- package/src/behaviors/behavior.abstract.ts +0 -139
- package/src/behaviors/behavior.config.ts +0 -7
- package/src/behaviors/behavior.core.annotations.ts +0 -62
- package/src/behaviors/behavior.core.block-element.ts +0 -116
- package/src/behaviors/behavior.core.block-objects.ts +0 -285
- package/src/behaviors/behavior.core.decorators.ts +0 -44
- package/src/behaviors/behavior.core.dnd.ts +0 -356
- package/src/behaviors/behavior.core.insert-break.ts +0 -266
- package/src/behaviors/behavior.core.insert.ts +0 -52
- package/src/behaviors/behavior.core.lists.ts +0 -691
- package/src/behaviors/behavior.core.ts +0 -44
- package/src/behaviors/behavior.perform-event.ts +0 -354
- package/src/behaviors/behavior.types.action.ts +0 -102
- package/src/behaviors/behavior.types.behavior.ts +0 -83
- package/src/behaviors/behavior.types.event.ts +0 -667
- package/src/behaviors/behavior.types.guard.ts +0 -11
- package/src/behaviors/index.ts +0 -17
- package/src/converters/converter.json.ts +0 -53
- package/src/converters/converter.portable-text.deserialize.test.ts +0 -680
- package/src/converters/converter.portable-text.ts +0 -75
- package/src/converters/converter.text-html.deserialize.test.ts +0 -406
- package/src/converters/converter.text-html.serialize.test.ts +0 -246
- package/src/converters/converter.text-html.ts +0 -87
- package/src/converters/converter.text-markdown.ts +0 -67
- package/src/converters/converter.text-plain.test.ts +0 -245
- package/src/converters/converter.text-plain.ts +0 -126
- package/src/converters/converter.types.ts +0 -72
- package/src/converters/converters.core.ts +0 -18
- package/src/editor/Editable.tsx +0 -1012
- package/src/editor/PortableTextEditor.tsx +0 -791
- package/src/editor/components/drop-indicator.tsx +0 -17
- package/src/editor/components/render-block-object.tsx +0 -121
- package/src/editor/components/render-default-object.tsx +0 -21
- package/src/editor/components/render-element.tsx +0 -88
- package/src/editor/components/render-inline-object.tsx +0 -129
- package/src/editor/components/render-leaf.tsx +0 -64
- package/src/editor/components/render-span.tsx +0 -303
- package/src/editor/components/render-text-block.tsx +0 -265
- package/src/editor/components/render-text.tsx +0 -18
- package/src/editor/components/use-core-block-element-behaviors.ts +0 -39
- package/src/editor/create-editor.ts +0 -323
- package/src/editor/create-slate-editor.tsx +0 -64
- package/src/editor/editor-actor-context.ts +0 -4
- package/src/editor/editor-context.tsx +0 -7
- package/src/editor/editor-dom.ts +0 -220
- package/src/editor/editor-machine.ts +0 -751
- package/src/editor/editor-provider.tsx +0 -111
- package/src/editor/editor-schema.ts +0 -6
- package/src/editor/editor-selector.ts +0 -89
- package/src/editor/editor-snapshot.ts +0 -68
- package/src/editor/event-to-change.tsx +0 -49
- package/src/editor/hooks/usePortableTextEditor.ts +0 -25
- package/src/editor/hooks/usePortableTextEditorSelection.tsx +0 -28
- package/src/editor/mutation-machine.ts +0 -322
- package/src/editor/plugins/create-with-event-listeners.ts +0 -271
- package/src/editor/plugins/createWithEditableAPI.ts +0 -529
- package/src/editor/plugins/createWithHotKeys.ts +0 -68
- package/src/editor/plugins/createWithObjectKeys.ts +0 -289
- package/src/editor/plugins/createWithPatches.ts +0 -272
- package/src/editor/plugins/createWithPortableTextMarkModel.ts +0 -559
- package/src/editor/plugins/createWithSchemaTypes.ts +0 -121
- package/src/editor/plugins/slate-plugin.update-selection.ts +0 -51
- package/src/editor/plugins/slate-plugin.update-value.ts +0 -46
- package/src/editor/plugins/with-plugins.ts +0 -69
- package/src/editor/range-decorations-machine.ts +0 -421
- package/src/editor/relay-actor-context.ts +0 -4
- package/src/editor/relay-machine.ts +0 -152
- package/src/editor/sync-machine.ts +0 -961
- package/src/editor/use-editor.ts +0 -27
- package/src/editor/validate-selection-machine.test.ts +0 -47
- package/src/editor/validate-selection-machine.ts +0 -149
- package/src/editor/weakMaps.ts +0 -15
- package/src/editor/with-normalizing-node.ts +0 -14
- package/src/editor/with-performing-behavior-operation.ts +0 -21
- package/src/editor/withChanges.ts +0 -13
- package/src/editor/without-normalizing-conditional.ts +0 -13
- package/src/editor/withoutPatching.ts +0 -14
- package/src/editor.ts +0 -59
- package/src/history/behavior.operation.history.redo.ts +0 -67
- package/src/history/behavior.operation.history.undo.ts +0 -71
- package/src/history/event.history.undo.test.tsx +0 -672
- package/src/history/history.preserving-keys.test.tsx +0 -112
- package/src/history/remote-patches.ts +0 -20
- package/src/history/slate-plugin.history.ts +0 -142
- package/src/history/slate-plugin.redoing.ts +0 -21
- package/src/history/slate-plugin.undoing.ts +0 -21
- package/src/history/slate-plugin.without-history.ts +0 -23
- package/src/history/transform-operation.ts +0 -245
- package/src/history/undo-redo-collaboration.test.tsx +0 -541
- package/src/history/undo-redo.feature +0 -125
- package/src/history/undo-redo.test.tsx +0 -195
- package/src/history/undo-step.ts +0 -148
- package/src/index.ts +0 -107
- package/src/internal-utils/__tests__/ranges.test.ts +0 -23
- package/src/internal-utils/__tests__/values.test.ts +0 -110
- package/src/internal-utils/apply-operation-to-portable-text.test.ts +0 -1861
- package/src/internal-utils/apply-operation-to-portable-text.ts +0 -615
- package/src/internal-utils/applyPatch.ts +0 -644
- package/src/internal-utils/block-keys.ts +0 -9
- package/src/internal-utils/build-index-maps.test.ts +0 -464
- package/src/internal-utils/build-index-maps.ts +0 -131
- package/src/internal-utils/collapse-selection.ts +0 -36
- package/src/internal-utils/compound-client-rect.ts +0 -28
- package/src/internal-utils/create-placeholder-block.ts +0 -21
- package/src/internal-utils/create-test-snapshot.ts +0 -28
- package/src/internal-utils/debug.ts +0 -12
- package/src/internal-utils/editor-selection.test.ts +0 -44
- package/src/internal-utils/editor-selection.ts +0 -56
- package/src/internal-utils/event-position.ts +0 -318
- package/src/internal-utils/global-scope.ts +0 -27
- package/src/internal-utils/globally-scoped-context.ts +0 -39
- package/src/internal-utils/is-hotkey.test.ts +0 -114
- package/src/internal-utils/is-hotkey.ts +0 -209
- package/src/internal-utils/mime-type.ts +0 -1
- package/src/internal-utils/move-range-by-operation.ts +0 -19
- package/src/internal-utils/operation-to-patches.test.ts +0 -522
- package/src/internal-utils/operation-to-patches.ts +0 -571
- package/src/internal-utils/portable-text-node.ts +0 -209
- package/src/internal-utils/schema.ts +0 -8
- package/src/internal-utils/selection-block-keys.ts +0 -20
- package/src/internal-utils/selection-focus-text.ts +0 -40
- package/src/internal-utils/selection-text.test.ts +0 -32
- package/src/internal-utils/selection-text.ts +0 -21
- package/src/internal-utils/selection.ts +0 -77
- package/src/internal-utils/sibling-utils.ts +0 -55
- package/src/internal-utils/slate-utils.test.tsx +0 -121
- package/src/internal-utils/slate-utils.ts +0 -417
- package/src/internal-utils/split-string.ts +0 -12
- package/src/internal-utils/stop-actor.ts +0 -43
- package/src/internal-utils/string-overlap.test.ts +0 -14
- package/src/internal-utils/string-overlap.ts +0 -28
- package/src/internal-utils/string-utils.ts +0 -7
- package/src/internal-utils/text-block-key.test.ts +0 -41
- package/src/internal-utils/text-block-key.ts +0 -26
- package/src/internal-utils/text-marks.test.ts +0 -41
- package/src/internal-utils/text-marks.ts +0 -22
- package/src/internal-utils/text-selection.test.ts +0 -211
- package/src/internal-utils/text-selection.ts +0 -121
- package/src/internal-utils/to-slate-range.test.ts +0 -278
- package/src/internal-utils/to-slate-range.ts +0 -171
- package/src/internal-utils/validateValue.ts +0 -443
- package/src/internal-utils/value-annotations.ts +0 -33
- package/src/internal-utils/values.test.ts +0 -282
- package/src/internal-utils/values.ts +0 -266
- package/src/keyboard-shortcuts/default-keyboard-shortcuts.ts +0 -146
- package/src/operations/behavior.operation.annotation.add.ts +0 -99
- package/src/operations/behavior.operation.annotation.remove.ts +0 -150
- package/src/operations/behavior.operation.block.set.ts +0 -104
- package/src/operations/behavior.operation.block.unset.ts +0 -54
- package/src/operations/behavior.operation.child.set.ts +0 -107
- package/src/operations/behavior.operation.child.unset.ts +0 -116
- package/src/operations/behavior.operation.decorator.add.ts +0 -131
- package/src/operations/behavior.operation.delete.ts +0 -294
- package/src/operations/behavior.operation.insert.block.ts +0 -495
- package/src/operations/behavior.operation.insert.child.ts +0 -129
- package/src/operations/behavior.operation.insert.text.ts +0 -8
- package/src/operations/behavior.operation.move.backward.ts +0 -12
- package/src/operations/behavior.operation.move.block.ts +0 -44
- package/src/operations/behavior.operation.move.forward.ts +0 -11
- package/src/operations/behavior.operation.select.ts +0 -27
- package/src/operations/behavior.operations.ts +0 -221
- package/src/plugins/_exports/index.ts +0 -1
- package/src/plugins/index.ts +0 -3
- package/src/plugins/plugin.behavior.tsx +0 -24
- package/src/plugins/plugin.editor-ref.tsx +0 -17
- package/src/plugins/plugin.event-listener.tsx +0 -68
- package/src/plugins/plugin.internal.auto-close-brackets.test.tsx +0 -71
- package/src/plugins/plugin.internal.auto-close-brackets.ts +0 -62
- package/src/plugins/plugin.internal.change-ref.tsx +0 -19
- package/src/plugins/plugin.internal.portable-text-editor-ref.tsx +0 -16
- package/src/plugins/plugin.internal.slate-editor-ref.tsx +0 -15
- package/src/priority/priority.core.ts +0 -3
- package/src/priority/priority.sort.test.ts +0 -319
- package/src/priority/priority.sort.ts +0 -123
- package/src/priority/priority.types.ts +0 -24
- package/src/selectors/_exports/index.ts +0 -1
- package/src/selectors/drag-selection.test.ts +0 -578
- package/src/selectors/drag-selection.ts +0 -118
- package/src/selectors/index.ts +0 -54
- package/src/selectors/selector.get-active-annotation-marks.ts +0 -12
- package/src/selectors/selector.get-active-annotations.ts +0 -36
- package/src/selectors/selector.get-active-decorators.ts +0 -29
- package/src/selectors/selector.get-active-list-item.ts +0 -38
- package/src/selectors/selector.get-active-style.ts +0 -38
- package/src/selectors/selector.get-anchor-block.ts +0 -22
- package/src/selectors/selector.get-anchor-child.ts +0 -36
- package/src/selectors/selector.get-anchor-span.ts +0 -17
- package/src/selectors/selector.get-anchor-text-block.ts +0 -18
- package/src/selectors/selector.get-block-offsets.ts +0 -34
- package/src/selectors/selector.get-caret-word-selection.test.ts +0 -284
- package/src/selectors/selector.get-caret-word-selection.ts +0 -134
- package/src/selectors/selector.get-first-block.ts +0 -14
- package/src/selectors/selector.get-focus-block-object.ts +0 -18
- package/src/selectors/selector.get-focus-block.ts +0 -23
- package/src/selectors/selector.get-focus-child.ts +0 -36
- package/src/selectors/selector.get-focus-inline-object.ts +0 -17
- package/src/selectors/selector.get-focus-list-block.ts +0 -18
- package/src/selectors/selector.get-focus-span.ts +0 -18
- package/src/selectors/selector.get-focus-text-block.ts +0 -18
- package/src/selectors/selector.get-last-block.ts +0 -16
- package/src/selectors/selector.get-mark-state.test.ts +0 -325
- package/src/selectors/selector.get-mark-state.ts +0 -263
- package/src/selectors/selector.get-next-block.ts +0 -29
- package/src/selectors/selector.get-next-inline-object.ts +0 -53
- package/src/selectors/selector.get-next-inline-objects.ts +0 -50
- package/src/selectors/selector.get-next-span.ts +0 -56
- package/src/selectors/selector.get-previous-block.ts +0 -29
- package/src/selectors/selector.get-previous-inline-object.ts +0 -50
- package/src/selectors/selector.get-previous-inline-objects.ts +0 -47
- package/src/selectors/selector.get-previous-span.ts +0 -53
- package/src/selectors/selector.get-selected-blocks.ts +0 -61
- package/src/selectors/selector.get-selected-spans.test.ts +0 -347
- package/src/selectors/selector.get-selected-spans.ts +0 -155
- package/src/selectors/selector.get-selected-text-blocks.ts +0 -73
- package/src/selectors/selector.get-selected-value.test.ts +0 -834
- package/src/selectors/selector.get-selected-value.ts +0 -66
- package/src/selectors/selector.get-selection-end-block.ts +0 -33
- package/src/selectors/selector.get-selection-end-child.ts +0 -33
- package/src/selectors/selector.get-selection-end-point.ts +0 -17
- package/src/selectors/selector.get-selection-start-block.ts +0 -33
- package/src/selectors/selector.get-selection-start-child.ts +0 -33
- package/src/selectors/selector.get-selection-start-point.ts +0 -17
- package/src/selectors/selector.get-selection-text.test.ts +0 -421
- package/src/selectors/selector.get-selection-text.ts +0 -27
- package/src/selectors/selector.get-selection.ts +0 -9
- package/src/selectors/selector.get-text-after.ts +0 -46
- package/src/selectors/selector.get-text-before.ts +0 -46
- package/src/selectors/selector.get-value.ts +0 -11
- package/src/selectors/selector.is-active-annotation.test.ts +0 -320
- package/src/selectors/selector.is-active-annotation.ts +0 -52
- package/src/selectors/selector.is-active-decorator.test.ts +0 -136
- package/src/selectors/selector.is-active-decorator.ts +0 -24
- package/src/selectors/selector.is-active-list-item.ts +0 -13
- package/src/selectors/selector.is-active-style.ts +0 -13
- package/src/selectors/selector.is-at-the-end-of-block.ts +0 -30
- package/src/selectors/selector.is-at-the-start-of-block.ts +0 -30
- package/src/selectors/selector.is-overlapping-selection.test.ts +0 -304
- package/src/selectors/selector.is-overlapping-selection.ts +0 -181
- package/src/selectors/selector.is-point-after-selection.ts +0 -97
- package/src/selectors/selector.is-point-before-selection.ts +0 -97
- package/src/selectors/selector.is-selecting-entire-blocks.ts +0 -43
- package/src/selectors/selector.is-selection-collapsed.ts +0 -17
- package/src/selectors/selector.is-selection-expanded.test.ts +0 -63
- package/src/selectors/selector.is-selection-expanded.ts +0 -9
- package/src/test/_exports/index.ts +0 -1
- package/src/test/gherkin-parameter-types.ts +0 -112
- package/src/test/index.ts +0 -1
- package/src/test/vitest/_exports/index.ts +0 -1
- package/src/test/vitest/index.ts +0 -3
- package/src/test/vitest/step-context.ts +0 -13
- package/src/test/vitest/step-definitions.tsx +0 -960
- package/src/test/vitest/test-editor.tsx +0 -198
- package/src/type-utils.ts +0 -29
- package/src/types/block-offset.ts +0 -9
- package/src/types/block-with-optional-key.ts +0 -25
- package/src/types/editor.ts +0 -509
- package/src/types/options.ts +0 -13
- package/src/types/paths.ts +0 -35
- package/src/types/slate-editor.ts +0 -50
- package/src/types/slate.ts +0 -27
- package/src/utils/_exports/index.ts +0 -1
- package/src/utils/asserters.ts +0 -9
- package/src/utils/index.ts +0 -24
- package/src/utils/key-generator.ts +0 -33
- package/src/utils/parse-blocks.test.ts +0 -836
- package/src/utils/parse-blocks.ts +0 -504
- package/src/utils/util.at-the-beginning-of-block.ts +0 -32
- package/src/utils/util.block-offset-to-block-selection-point.ts +0 -28
- package/src/utils/util.block-offset-to-selection-point.ts +0 -33
- package/src/utils/util.block-offset.test.ts +0 -375
- package/src/utils/util.block-offset.ts +0 -136
- package/src/utils/util.block-offsets-to-selection.ts +0 -38
- package/src/utils/util.child-selection-point-to-block-offset.ts +0 -51
- package/src/utils/util.get-block-end-point.ts +0 -35
- package/src/utils/util.get-block-start-point.ts +0 -31
- package/src/utils/util.get-selection-end-point.ts +0 -20
- package/src/utils/util.get-selection-start-point.ts +0 -20
- package/src/utils/util.get-text-block-text.ts +0 -8
- package/src/utils/util.is-empty-text-block.ts +0 -21
- package/src/utils/util.is-equal-selection-points.ts +0 -13
- package/src/utils/util.is-equal-selections.ts +0 -20
- package/src/utils/util.is-keyed-segment.ts +0 -8
- package/src/utils/util.is-selection-collapsed.ts +0 -16
- package/src/utils/util.is-selection-expanded.ts +0 -13
- package/src/utils/util.merge-text-blocks.ts +0 -40
- package/src/utils/util.reverse-selection.ts +0 -26
- package/src/utils/util.selection-point-to-block-offset.ts +0 -30
- package/src/utils/util.selection-point.ts +0 -22
- package/src/utils/util.slice-blocks.ts +0 -221
- package/src/utils/util.slice-text-block.test.ts +0 -190
- package/src/utils/util.slice-text-block.ts +0 -89
- package/src/utils/util.split-text-block.ts +0 -54
package/src/editor/Editable.tsx
DELETED
|
@@ -1,1012 +0,0 @@
|
|
|
1
|
-
import {useActorRef, useSelector} from '@xstate/react'
|
|
2
|
-
import {noop} from 'lodash'
|
|
3
|
-
import {
|
|
4
|
-
forwardRef,
|
|
5
|
-
useCallback,
|
|
6
|
-
useContext,
|
|
7
|
-
useEffect,
|
|
8
|
-
useMemo,
|
|
9
|
-
useState,
|
|
10
|
-
type ClipboardEvent,
|
|
11
|
-
type FocusEventHandler,
|
|
12
|
-
type KeyboardEvent,
|
|
13
|
-
type TextareaHTMLAttributes,
|
|
14
|
-
} from 'react'
|
|
15
|
-
import {Editor, Transforms, type Text} from 'slate'
|
|
16
|
-
import {
|
|
17
|
-
ReactEditor,
|
|
18
|
-
Editable as SlateEditable,
|
|
19
|
-
useSlate,
|
|
20
|
-
type RenderElementProps,
|
|
21
|
-
type RenderLeafProps,
|
|
22
|
-
} from 'slate-react'
|
|
23
|
-
import {debugWithName} from '../internal-utils/debug'
|
|
24
|
-
import {getEventPosition} from '../internal-utils/event-position'
|
|
25
|
-
import {normalizeSelection} from '../internal-utils/selection'
|
|
26
|
-
import {slateRangeToSelection} from '../internal-utils/slate-utils'
|
|
27
|
-
import {toSlateRange} from '../internal-utils/to-slate-range'
|
|
28
|
-
import type {
|
|
29
|
-
EditorSelection,
|
|
30
|
-
OnCopyFn,
|
|
31
|
-
OnPasteFn,
|
|
32
|
-
RangeDecoration,
|
|
33
|
-
RenderAnnotationFunction,
|
|
34
|
-
RenderBlockFunction,
|
|
35
|
-
RenderChildFunction,
|
|
36
|
-
RenderDecoratorFunction,
|
|
37
|
-
RenderListItemFunction,
|
|
38
|
-
RenderPlaceholderFunction,
|
|
39
|
-
RenderStyleFunction,
|
|
40
|
-
ScrollSelectionIntoViewFunction,
|
|
41
|
-
} from '../types/editor'
|
|
42
|
-
import type {HotkeyOptions} from '../types/options'
|
|
43
|
-
import {isEmptyTextBlock} from '../utils'
|
|
44
|
-
import {parseBlocks} from '../utils/parse-blocks'
|
|
45
|
-
import {RenderElement} from './components/render-element'
|
|
46
|
-
import {RenderLeaf} from './components/render-leaf'
|
|
47
|
-
import {RenderText, type RenderTextProps} from './components/render-text'
|
|
48
|
-
import {EditorActorContext} from './editor-actor-context'
|
|
49
|
-
import {usePortableTextEditor} from './hooks/usePortableTextEditor'
|
|
50
|
-
import {createWithHotkeys} from './plugins/createWithHotKeys'
|
|
51
|
-
import {rangeDecorationsMachine} from './range-decorations-machine'
|
|
52
|
-
import {RelayActorContext} from './relay-actor-context'
|
|
53
|
-
import {validateSelectionMachine} from './validate-selection-machine'
|
|
54
|
-
|
|
55
|
-
const debug = debugWithName('component:Editable')
|
|
56
|
-
|
|
57
|
-
/**
|
|
58
|
-
* @public
|
|
59
|
-
*/
|
|
60
|
-
export type PortableTextEditableProps = Omit<
|
|
61
|
-
TextareaHTMLAttributes<HTMLDivElement>,
|
|
62
|
-
'onPaste' | 'onCopy' | 'onBeforeInput'
|
|
63
|
-
> & {
|
|
64
|
-
ref?: React.Ref<HTMLDivElement>
|
|
65
|
-
hotkeys?: HotkeyOptions
|
|
66
|
-
onBeforeInput?: (event: InputEvent) => void
|
|
67
|
-
onPaste?: OnPasteFn
|
|
68
|
-
onCopy?: OnCopyFn
|
|
69
|
-
rangeDecorations?: RangeDecoration[]
|
|
70
|
-
renderAnnotation?: RenderAnnotationFunction
|
|
71
|
-
renderBlock?: RenderBlockFunction
|
|
72
|
-
renderChild?: RenderChildFunction
|
|
73
|
-
renderDecorator?: RenderDecoratorFunction
|
|
74
|
-
renderListItem?: RenderListItemFunction
|
|
75
|
-
renderPlaceholder?: RenderPlaceholderFunction
|
|
76
|
-
renderStyle?: RenderStyleFunction
|
|
77
|
-
scrollSelectionIntoView?: ScrollSelectionIntoViewFunction
|
|
78
|
-
selection?: EditorSelection
|
|
79
|
-
spellCheck?: boolean
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
/**
|
|
83
|
-
* @public
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
* The core component that renders the editor. Must be placed within the {@link EditorProvider} component.
|
|
87
|
-
*
|
|
88
|
-
* @example
|
|
89
|
-
* ```tsx
|
|
90
|
-
* import { PortableTextEditable, EditorProvider } from '@portabletext/editor'
|
|
91
|
-
*
|
|
92
|
-
* function MyComponent() {
|
|
93
|
-
* return (
|
|
94
|
-
* <EditorProvider>
|
|
95
|
-
* <PortableTextEditable />
|
|
96
|
-
* </EditorProvider>
|
|
97
|
-
* )
|
|
98
|
-
* }
|
|
99
|
-
* ```
|
|
100
|
-
* @group Components
|
|
101
|
-
*/
|
|
102
|
-
export const PortableTextEditable = forwardRef<
|
|
103
|
-
Omit<HTMLDivElement, 'as' | 'onPaste' | 'onBeforeInput'>,
|
|
104
|
-
PortableTextEditableProps
|
|
105
|
-
>(function PortableTextEditable(props, forwardedRef) {
|
|
106
|
-
const {
|
|
107
|
-
hotkeys,
|
|
108
|
-
onBlur,
|
|
109
|
-
onFocus,
|
|
110
|
-
onBeforeInput,
|
|
111
|
-
onPaste,
|
|
112
|
-
onCopy,
|
|
113
|
-
onCut,
|
|
114
|
-
onClick,
|
|
115
|
-
onDragStart,
|
|
116
|
-
onDrag,
|
|
117
|
-
onDragEnd,
|
|
118
|
-
onDragEnter,
|
|
119
|
-
onDragOver,
|
|
120
|
-
onDrop,
|
|
121
|
-
onDragLeave,
|
|
122
|
-
rangeDecorations,
|
|
123
|
-
renderAnnotation,
|
|
124
|
-
renderBlock,
|
|
125
|
-
renderChild,
|
|
126
|
-
renderDecorator,
|
|
127
|
-
renderListItem,
|
|
128
|
-
renderPlaceholder,
|
|
129
|
-
renderStyle,
|
|
130
|
-
selection: propsSelection,
|
|
131
|
-
scrollSelectionIntoView,
|
|
132
|
-
spellCheck,
|
|
133
|
-
...restProps
|
|
134
|
-
} = props
|
|
135
|
-
|
|
136
|
-
const portableTextEditor = usePortableTextEditor()
|
|
137
|
-
const [hasInvalidValue, setHasInvalidValue] = useState(false)
|
|
138
|
-
|
|
139
|
-
const editorActor = useContext(EditorActorContext)
|
|
140
|
-
const relayActor = useContext(RelayActorContext)
|
|
141
|
-
const readOnly = useSelector(editorActor, (s) =>
|
|
142
|
-
s.matches({'edit mode': 'read only'}),
|
|
143
|
-
)
|
|
144
|
-
const slateEditor = useSlate()
|
|
145
|
-
const validateSelectionActor = useActorRef(validateSelectionMachine, {
|
|
146
|
-
input: {
|
|
147
|
-
slateEditor,
|
|
148
|
-
},
|
|
149
|
-
})
|
|
150
|
-
|
|
151
|
-
const rangeDecorationsActor = useActorRef(rangeDecorationsMachine, {
|
|
152
|
-
input: {
|
|
153
|
-
rangeDecorations: rangeDecorations ?? [],
|
|
154
|
-
readOnly,
|
|
155
|
-
schema: editorActor.getSnapshot().context.schema,
|
|
156
|
-
slateEditor,
|
|
157
|
-
skipSetup: !editorActor.getSnapshot().matches({setup: 'setting up'}),
|
|
158
|
-
},
|
|
159
|
-
})
|
|
160
|
-
const decorate = useSelector(
|
|
161
|
-
rangeDecorationsActor,
|
|
162
|
-
(s) => s.context.decorate?.fn,
|
|
163
|
-
)
|
|
164
|
-
|
|
165
|
-
useEffect(() => {
|
|
166
|
-
rangeDecorationsActor.send({
|
|
167
|
-
type: 'update read only',
|
|
168
|
-
readOnly,
|
|
169
|
-
})
|
|
170
|
-
}, [rangeDecorationsActor, readOnly])
|
|
171
|
-
|
|
172
|
-
useEffect(() => {
|
|
173
|
-
rangeDecorationsActor.send({
|
|
174
|
-
type: 'range decorations updated',
|
|
175
|
-
rangeDecorations: rangeDecorations ?? [],
|
|
176
|
-
})
|
|
177
|
-
}, [rangeDecorationsActor, rangeDecorations])
|
|
178
|
-
|
|
179
|
-
// Output a minimal React editor inside Editable when in readOnly mode.
|
|
180
|
-
// NOTE: make sure all the plugins used here can be safely run over again at any point.
|
|
181
|
-
// There will be a problem if they redefine editor methods and then calling the original method within themselves.
|
|
182
|
-
useMemo(() => {
|
|
183
|
-
// React/UI-specific plugins
|
|
184
|
-
if (readOnly) {
|
|
185
|
-
return slateEditor
|
|
186
|
-
}
|
|
187
|
-
const withHotKeys = createWithHotkeys(
|
|
188
|
-
editorActor,
|
|
189
|
-
portableTextEditor,
|
|
190
|
-
hotkeys,
|
|
191
|
-
)
|
|
192
|
-
|
|
193
|
-
return withHotKeys(slateEditor)
|
|
194
|
-
}, [editorActor, hotkeys, portableTextEditor, readOnly, slateEditor])
|
|
195
|
-
|
|
196
|
-
const renderElement = useCallback(
|
|
197
|
-
(eProps: RenderElementProps) => (
|
|
198
|
-
<RenderElement
|
|
199
|
-
{...eProps}
|
|
200
|
-
readOnly={readOnly}
|
|
201
|
-
renderBlock={renderBlock}
|
|
202
|
-
renderChild={renderChild}
|
|
203
|
-
renderListItem={renderListItem}
|
|
204
|
-
renderStyle={renderStyle}
|
|
205
|
-
spellCheck={spellCheck}
|
|
206
|
-
/>
|
|
207
|
-
),
|
|
208
|
-
[
|
|
209
|
-
spellCheck,
|
|
210
|
-
readOnly,
|
|
211
|
-
renderBlock,
|
|
212
|
-
renderChild,
|
|
213
|
-
renderListItem,
|
|
214
|
-
renderStyle,
|
|
215
|
-
],
|
|
216
|
-
)
|
|
217
|
-
|
|
218
|
-
const renderLeaf = useCallback(
|
|
219
|
-
(
|
|
220
|
-
leafProps: RenderLeafProps & {
|
|
221
|
-
leaf: Text & {placeholder?: boolean; rangeDecoration?: RangeDecoration}
|
|
222
|
-
},
|
|
223
|
-
) => (
|
|
224
|
-
<RenderLeaf
|
|
225
|
-
{...leafProps}
|
|
226
|
-
readOnly={readOnly}
|
|
227
|
-
renderAnnotation={renderAnnotation}
|
|
228
|
-
renderChild={renderChild}
|
|
229
|
-
renderDecorator={renderDecorator}
|
|
230
|
-
renderPlaceholder={renderPlaceholder}
|
|
231
|
-
/>
|
|
232
|
-
),
|
|
233
|
-
[
|
|
234
|
-
readOnly,
|
|
235
|
-
renderAnnotation,
|
|
236
|
-
renderChild,
|
|
237
|
-
renderDecorator,
|
|
238
|
-
renderPlaceholder,
|
|
239
|
-
],
|
|
240
|
-
)
|
|
241
|
-
|
|
242
|
-
const renderText = useCallback(
|
|
243
|
-
(props: RenderTextProps) => <RenderText {...props} />,
|
|
244
|
-
[],
|
|
245
|
-
)
|
|
246
|
-
|
|
247
|
-
const restoreSelectionFromProps = useCallback(() => {
|
|
248
|
-
if (propsSelection) {
|
|
249
|
-
debug(`Selection from props ${JSON.stringify(propsSelection)}`)
|
|
250
|
-
const normalizedSelection = normalizeSelection(
|
|
251
|
-
propsSelection,
|
|
252
|
-
slateEditor.value,
|
|
253
|
-
)
|
|
254
|
-
if (normalizedSelection !== null) {
|
|
255
|
-
debug(
|
|
256
|
-
`Normalized selection from props ${JSON.stringify(normalizedSelection)}`,
|
|
257
|
-
)
|
|
258
|
-
const slateRange = toSlateRange({
|
|
259
|
-
context: {
|
|
260
|
-
schema: editorActor.getSnapshot().context.schema,
|
|
261
|
-
value: slateEditor.value,
|
|
262
|
-
selection: normalizedSelection,
|
|
263
|
-
},
|
|
264
|
-
blockIndexMap: slateEditor.blockIndexMap,
|
|
265
|
-
})
|
|
266
|
-
if (slateRange) {
|
|
267
|
-
Transforms.select(slateEditor, slateRange)
|
|
268
|
-
// Output selection here in those cases where the editor selection was the same, and there are no set_selection operations made.
|
|
269
|
-
// The selection is usually automatically emitted to change$ by the withPortableTextSelections plugin whenever there is a set_selection operation applied.
|
|
270
|
-
if (!slateEditor.operations.some((o) => o.type === 'set_selection')) {
|
|
271
|
-
editorActor.send({
|
|
272
|
-
type: 'update selection',
|
|
273
|
-
selection: normalizedSelection,
|
|
274
|
-
})
|
|
275
|
-
}
|
|
276
|
-
slateEditor.onChange()
|
|
277
|
-
}
|
|
278
|
-
}
|
|
279
|
-
}
|
|
280
|
-
}, [editorActor, propsSelection, slateEditor])
|
|
281
|
-
|
|
282
|
-
// Restore selection from props when the editor has been initialized properly with it's value
|
|
283
|
-
useEffect(() => {
|
|
284
|
-
const onReady = editorActor.on('ready', () => {
|
|
285
|
-
rangeDecorationsActor.send({
|
|
286
|
-
type: 'ready',
|
|
287
|
-
})
|
|
288
|
-
|
|
289
|
-
restoreSelectionFromProps()
|
|
290
|
-
})
|
|
291
|
-
|
|
292
|
-
const onInvalidValue = editorActor.on('invalid value', () => {
|
|
293
|
-
setHasInvalidValue(true)
|
|
294
|
-
})
|
|
295
|
-
|
|
296
|
-
const onValueChanged = editorActor.on('value changed', () => {
|
|
297
|
-
setHasInvalidValue(false)
|
|
298
|
-
})
|
|
299
|
-
|
|
300
|
-
return () => {
|
|
301
|
-
onReady.unsubscribe()
|
|
302
|
-
onInvalidValue.unsubscribe()
|
|
303
|
-
onValueChanged.unsubscribe()
|
|
304
|
-
}
|
|
305
|
-
}, [rangeDecorationsActor, editorActor, restoreSelectionFromProps])
|
|
306
|
-
|
|
307
|
-
// Restore selection from props when it changes
|
|
308
|
-
useEffect(() => {
|
|
309
|
-
if (propsSelection && !hasInvalidValue) {
|
|
310
|
-
restoreSelectionFromProps()
|
|
311
|
-
}
|
|
312
|
-
}, [hasInvalidValue, propsSelection, restoreSelectionFromProps])
|
|
313
|
-
|
|
314
|
-
// Handle from props onCopy function
|
|
315
|
-
const handleCopy = useCallback(
|
|
316
|
-
(event: ClipboardEvent<HTMLDivElement>): void | ReactEditor => {
|
|
317
|
-
if (onCopy) {
|
|
318
|
-
const result = onCopy(event)
|
|
319
|
-
// CopyFn may return something to avoid doing default stuff
|
|
320
|
-
if (result !== undefined) {
|
|
321
|
-
event.preventDefault()
|
|
322
|
-
}
|
|
323
|
-
} else if (event.nativeEvent.clipboardData) {
|
|
324
|
-
// Prevent Slate from handling the event
|
|
325
|
-
event.stopPropagation()
|
|
326
|
-
event.preventDefault()
|
|
327
|
-
|
|
328
|
-
const selection = slateEditor.selection
|
|
329
|
-
? slateRangeToSelection({
|
|
330
|
-
schema: editorActor.getSnapshot().context.schema,
|
|
331
|
-
editor: slateEditor,
|
|
332
|
-
range: slateEditor.selection,
|
|
333
|
-
})
|
|
334
|
-
: undefined
|
|
335
|
-
const position = selection ? {selection} : undefined
|
|
336
|
-
|
|
337
|
-
if (!position) {
|
|
338
|
-
console.warn('Could not find position for copy event')
|
|
339
|
-
return
|
|
340
|
-
}
|
|
341
|
-
|
|
342
|
-
editorActor.send({
|
|
343
|
-
type: 'behavior event',
|
|
344
|
-
behaviorEvent: {
|
|
345
|
-
type: 'clipboard.copy',
|
|
346
|
-
originEvent: {
|
|
347
|
-
dataTransfer: event.nativeEvent.clipboardData,
|
|
348
|
-
},
|
|
349
|
-
position,
|
|
350
|
-
},
|
|
351
|
-
editor: slateEditor,
|
|
352
|
-
nativeEvent: event,
|
|
353
|
-
})
|
|
354
|
-
}
|
|
355
|
-
},
|
|
356
|
-
[onCopy, editorActor, slateEditor],
|
|
357
|
-
)
|
|
358
|
-
|
|
359
|
-
const handleCut = useCallback(
|
|
360
|
-
(event: ClipboardEvent<HTMLDivElement>) => {
|
|
361
|
-
if (onCut) {
|
|
362
|
-
const result = onCut(event)
|
|
363
|
-
// CutFn may return something to avoid doing default stuff
|
|
364
|
-
if (result !== undefined) {
|
|
365
|
-
event.preventDefault()
|
|
366
|
-
}
|
|
367
|
-
} else if (event.nativeEvent.clipboardData) {
|
|
368
|
-
// Prevent Slate from handling the event
|
|
369
|
-
event.stopPropagation()
|
|
370
|
-
event.preventDefault()
|
|
371
|
-
|
|
372
|
-
const selection = editorActor.getSnapshot().context.selection
|
|
373
|
-
const position = selection ? {selection} : undefined
|
|
374
|
-
|
|
375
|
-
if (!position) {
|
|
376
|
-
console.warn('Could not find position for cut event')
|
|
377
|
-
return
|
|
378
|
-
}
|
|
379
|
-
|
|
380
|
-
editorActor.send({
|
|
381
|
-
type: 'behavior event',
|
|
382
|
-
behaviorEvent: {
|
|
383
|
-
type: 'clipboard.cut',
|
|
384
|
-
originEvent: {
|
|
385
|
-
dataTransfer: event.nativeEvent.clipboardData,
|
|
386
|
-
},
|
|
387
|
-
position,
|
|
388
|
-
},
|
|
389
|
-
editor: slateEditor,
|
|
390
|
-
nativeEvent: event,
|
|
391
|
-
})
|
|
392
|
-
}
|
|
393
|
-
},
|
|
394
|
-
[onCut, editorActor, slateEditor],
|
|
395
|
-
)
|
|
396
|
-
|
|
397
|
-
// Handle incoming pasting events in the editor
|
|
398
|
-
const handlePaste = useCallback(
|
|
399
|
-
(event: ClipboardEvent<HTMLDivElement>): Promise<void> | void => {
|
|
400
|
-
const value = slateEditor.value
|
|
401
|
-
const ptRange = slateEditor.selection
|
|
402
|
-
? slateRangeToSelection({
|
|
403
|
-
schema: editorActor.getSnapshot().context.schema,
|
|
404
|
-
editor: slateEditor,
|
|
405
|
-
range: slateEditor.selection,
|
|
406
|
-
})
|
|
407
|
-
: null
|
|
408
|
-
const path = ptRange?.focus.path || []
|
|
409
|
-
const onPasteResult = onPaste?.({
|
|
410
|
-
event,
|
|
411
|
-
value,
|
|
412
|
-
path,
|
|
413
|
-
schemaTypes: portableTextEditor.schemaTypes,
|
|
414
|
-
})
|
|
415
|
-
|
|
416
|
-
if (onPasteResult || !slateEditor.selection) {
|
|
417
|
-
event.preventDefault()
|
|
418
|
-
|
|
419
|
-
// Resolve it as promise (can be either async promise or sync return value)
|
|
420
|
-
relayActor.send({type: 'loading'})
|
|
421
|
-
|
|
422
|
-
Promise.resolve(onPasteResult)
|
|
423
|
-
.then((result) => {
|
|
424
|
-
debug('Custom paste function from client resolved', result)
|
|
425
|
-
|
|
426
|
-
if (!result || !result.insert) {
|
|
427
|
-
debug('No result from custom paste handler, pasting normally')
|
|
428
|
-
|
|
429
|
-
const selection = editorActor.getSnapshot().context.selection
|
|
430
|
-
const position = selection ? {selection} : undefined
|
|
431
|
-
|
|
432
|
-
if (!position) {
|
|
433
|
-
console.warn('Could not find position for paste event')
|
|
434
|
-
return
|
|
435
|
-
}
|
|
436
|
-
|
|
437
|
-
editorActor.send({
|
|
438
|
-
type: 'behavior event',
|
|
439
|
-
behaviorEvent: {
|
|
440
|
-
type: 'clipboard.paste',
|
|
441
|
-
originEvent: {
|
|
442
|
-
dataTransfer: event.clipboardData,
|
|
443
|
-
},
|
|
444
|
-
position,
|
|
445
|
-
},
|
|
446
|
-
editor: slateEditor,
|
|
447
|
-
nativeEvent: event,
|
|
448
|
-
})
|
|
449
|
-
} else if (result.insert) {
|
|
450
|
-
editorActor.send({
|
|
451
|
-
type: 'behavior event',
|
|
452
|
-
behaviorEvent: {
|
|
453
|
-
type: 'insert.blocks',
|
|
454
|
-
blocks: parseBlocks({
|
|
455
|
-
context: {
|
|
456
|
-
keyGenerator:
|
|
457
|
-
editorActor.getSnapshot().context.keyGenerator,
|
|
458
|
-
schema: editorActor.getSnapshot().context.schema,
|
|
459
|
-
},
|
|
460
|
-
blocks: result.insert,
|
|
461
|
-
options: {
|
|
462
|
-
normalize: false,
|
|
463
|
-
removeUnusedMarkDefs: true,
|
|
464
|
-
validateFields: false,
|
|
465
|
-
},
|
|
466
|
-
}),
|
|
467
|
-
placement: 'auto',
|
|
468
|
-
},
|
|
469
|
-
editor: slateEditor,
|
|
470
|
-
})
|
|
471
|
-
} else {
|
|
472
|
-
console.warn(
|
|
473
|
-
'Your onPaste function returned something unexpected:',
|
|
474
|
-
result,
|
|
475
|
-
)
|
|
476
|
-
}
|
|
477
|
-
})
|
|
478
|
-
.catch((error) => {
|
|
479
|
-
console.warn(error)
|
|
480
|
-
|
|
481
|
-
return error
|
|
482
|
-
})
|
|
483
|
-
.finally(() => {
|
|
484
|
-
relayActor.send({type: 'done loading'})
|
|
485
|
-
})
|
|
486
|
-
} else if (event.nativeEvent.clipboardData) {
|
|
487
|
-
// Prevent Slate from handling the event
|
|
488
|
-
event.preventDefault()
|
|
489
|
-
event.stopPropagation()
|
|
490
|
-
|
|
491
|
-
const selection = editorActor.getSnapshot().context.selection
|
|
492
|
-
const position = selection ? {selection} : undefined
|
|
493
|
-
|
|
494
|
-
if (!position) {
|
|
495
|
-
console.warn('Could not find position for paste event')
|
|
496
|
-
return
|
|
497
|
-
}
|
|
498
|
-
|
|
499
|
-
editorActor.send({
|
|
500
|
-
type: 'behavior event',
|
|
501
|
-
behaviorEvent: {
|
|
502
|
-
type: 'clipboard.paste',
|
|
503
|
-
originEvent: {
|
|
504
|
-
dataTransfer: event.nativeEvent.clipboardData,
|
|
505
|
-
},
|
|
506
|
-
position,
|
|
507
|
-
},
|
|
508
|
-
editor: slateEditor,
|
|
509
|
-
nativeEvent: event,
|
|
510
|
-
})
|
|
511
|
-
}
|
|
512
|
-
|
|
513
|
-
debug('No result from custom paste handler, pasting normally')
|
|
514
|
-
},
|
|
515
|
-
[editorActor, onPaste, portableTextEditor, relayActor, slateEditor],
|
|
516
|
-
)
|
|
517
|
-
|
|
518
|
-
const handleOnFocus: FocusEventHandler<HTMLDivElement> = useCallback(
|
|
519
|
-
(event) => {
|
|
520
|
-
if (onFocus) {
|
|
521
|
-
onFocus(event)
|
|
522
|
-
}
|
|
523
|
-
|
|
524
|
-
if (!event.isDefaultPrevented()) {
|
|
525
|
-
relayActor.send({type: 'focused', event})
|
|
526
|
-
|
|
527
|
-
if (
|
|
528
|
-
!slateEditor.selection &&
|
|
529
|
-
slateEditor.children.length === 1 &&
|
|
530
|
-
isEmptyTextBlock(
|
|
531
|
-
editorActor.getSnapshot().context,
|
|
532
|
-
slateEditor.value.at(0),
|
|
533
|
-
)
|
|
534
|
-
) {
|
|
535
|
-
Transforms.select(slateEditor, Editor.start(slateEditor, []))
|
|
536
|
-
slateEditor.onChange()
|
|
537
|
-
}
|
|
538
|
-
}
|
|
539
|
-
},
|
|
540
|
-
[editorActor, onFocus, relayActor, slateEditor],
|
|
541
|
-
)
|
|
542
|
-
|
|
543
|
-
const handleClick = useCallback(
|
|
544
|
-
(event: React.MouseEvent<HTMLDivElement, MouseEvent>) => {
|
|
545
|
-
if (onClick) {
|
|
546
|
-
onClick(event)
|
|
547
|
-
}
|
|
548
|
-
|
|
549
|
-
if (event.isDefaultPrevented() || event.isPropagationStopped()) {
|
|
550
|
-
return
|
|
551
|
-
}
|
|
552
|
-
|
|
553
|
-
const position = getEventPosition({
|
|
554
|
-
editorActor,
|
|
555
|
-
slateEditor,
|
|
556
|
-
event: event.nativeEvent,
|
|
557
|
-
})
|
|
558
|
-
|
|
559
|
-
if (position) {
|
|
560
|
-
editorActor.send({
|
|
561
|
-
type: 'behavior event',
|
|
562
|
-
behaviorEvent: {
|
|
563
|
-
type: 'mouse.click',
|
|
564
|
-
position,
|
|
565
|
-
},
|
|
566
|
-
editor: slateEditor,
|
|
567
|
-
nativeEvent: event,
|
|
568
|
-
})
|
|
569
|
-
}
|
|
570
|
-
},
|
|
571
|
-
[onClick, editorActor, slateEditor],
|
|
572
|
-
)
|
|
573
|
-
|
|
574
|
-
const handleOnBlur: FocusEventHandler<HTMLDivElement> = useCallback(
|
|
575
|
-
(event) => {
|
|
576
|
-
if (onBlur) {
|
|
577
|
-
onBlur(event)
|
|
578
|
-
}
|
|
579
|
-
if (!event.isPropagationStopped()) {
|
|
580
|
-
relayActor.send({type: 'blurred', event})
|
|
581
|
-
}
|
|
582
|
-
},
|
|
583
|
-
[relayActor, onBlur],
|
|
584
|
-
)
|
|
585
|
-
|
|
586
|
-
const handleOnBeforeInput = useCallback(
|
|
587
|
-
(event: InputEvent) => {
|
|
588
|
-
if (onBeforeInput) {
|
|
589
|
-
onBeforeInput(event)
|
|
590
|
-
}
|
|
591
|
-
},
|
|
592
|
-
[onBeforeInput],
|
|
593
|
-
)
|
|
594
|
-
|
|
595
|
-
const handleKeyDown = useCallback(
|
|
596
|
-
(event: KeyboardEvent<HTMLDivElement>) => {
|
|
597
|
-
if (props.onKeyDown) {
|
|
598
|
-
props.onKeyDown(event)
|
|
599
|
-
}
|
|
600
|
-
if (!event.isDefaultPrevented()) {
|
|
601
|
-
slateEditor.pteWithHotKeys(event)
|
|
602
|
-
}
|
|
603
|
-
if (!event.isDefaultPrevented()) {
|
|
604
|
-
editorActor.send({
|
|
605
|
-
type: 'behavior event',
|
|
606
|
-
behaviorEvent: {
|
|
607
|
-
type: 'keyboard.keydown',
|
|
608
|
-
originEvent: {
|
|
609
|
-
key: event.key,
|
|
610
|
-
code: event.code,
|
|
611
|
-
altKey: event.altKey,
|
|
612
|
-
ctrlKey: event.ctrlKey,
|
|
613
|
-
metaKey: event.metaKey,
|
|
614
|
-
shiftKey: event.shiftKey,
|
|
615
|
-
},
|
|
616
|
-
},
|
|
617
|
-
editor: slateEditor,
|
|
618
|
-
nativeEvent: event,
|
|
619
|
-
})
|
|
620
|
-
}
|
|
621
|
-
},
|
|
622
|
-
[props, editorActor, slateEditor],
|
|
623
|
-
)
|
|
624
|
-
|
|
625
|
-
const handleKeyUp = useCallback(
|
|
626
|
-
(event: KeyboardEvent<HTMLDivElement>) => {
|
|
627
|
-
if (props.onKeyUp) {
|
|
628
|
-
props.onKeyUp(event)
|
|
629
|
-
}
|
|
630
|
-
if (!event.isDefaultPrevented()) {
|
|
631
|
-
editorActor.send({
|
|
632
|
-
type: 'behavior event',
|
|
633
|
-
behaviorEvent: {
|
|
634
|
-
type: 'keyboard.keyup',
|
|
635
|
-
originEvent: {
|
|
636
|
-
key: event.key,
|
|
637
|
-
code: event.code,
|
|
638
|
-
altKey: event.altKey,
|
|
639
|
-
ctrlKey: event.ctrlKey,
|
|
640
|
-
metaKey: event.metaKey,
|
|
641
|
-
shiftKey: event.shiftKey,
|
|
642
|
-
},
|
|
643
|
-
},
|
|
644
|
-
editor: slateEditor,
|
|
645
|
-
nativeEvent: event,
|
|
646
|
-
})
|
|
647
|
-
}
|
|
648
|
-
},
|
|
649
|
-
[props, editorActor, slateEditor],
|
|
650
|
-
)
|
|
651
|
-
|
|
652
|
-
const scrollSelectionIntoViewToSlate = useMemo(() => {
|
|
653
|
-
// Use slate-react default scroll into view
|
|
654
|
-
if (scrollSelectionIntoView === undefined) {
|
|
655
|
-
return undefined
|
|
656
|
-
}
|
|
657
|
-
// Disable scroll into view totally
|
|
658
|
-
if (scrollSelectionIntoView === null) {
|
|
659
|
-
return noop
|
|
660
|
-
}
|
|
661
|
-
// Translate PortableTextEditor prop fn to Slate plugin fn
|
|
662
|
-
return (_editor: ReactEditor, domRange: Range) => {
|
|
663
|
-
scrollSelectionIntoView(portableTextEditor, domRange)
|
|
664
|
-
}
|
|
665
|
-
}, [portableTextEditor, scrollSelectionIntoView])
|
|
666
|
-
|
|
667
|
-
useEffect(() => {
|
|
668
|
-
const window = ReactEditor.getWindow(slateEditor)
|
|
669
|
-
|
|
670
|
-
const onDragEnd = () => {
|
|
671
|
-
editorActor.send({type: 'dragend'})
|
|
672
|
-
}
|
|
673
|
-
const onDrop = () => {
|
|
674
|
-
editorActor.send({type: 'drop'})
|
|
675
|
-
}
|
|
676
|
-
|
|
677
|
-
window.document.addEventListener('dragend', onDragEnd)
|
|
678
|
-
window.document.addEventListener('drop', onDrop)
|
|
679
|
-
|
|
680
|
-
return () => {
|
|
681
|
-
window.document.removeEventListener('dragend', onDragEnd)
|
|
682
|
-
window.document.removeEventListener('drop', onDrop)
|
|
683
|
-
}
|
|
684
|
-
}, [slateEditor, editorActor])
|
|
685
|
-
|
|
686
|
-
const handleDragStart = useCallback(
|
|
687
|
-
(event: React.DragEvent<HTMLDivElement>) => {
|
|
688
|
-
onDragStart?.(event)
|
|
689
|
-
|
|
690
|
-
if (event.isDefaultPrevented() || event.isPropagationStopped()) {
|
|
691
|
-
return
|
|
692
|
-
}
|
|
693
|
-
|
|
694
|
-
const position = getEventPosition({
|
|
695
|
-
editorActor,
|
|
696
|
-
slateEditor,
|
|
697
|
-
event: event.nativeEvent,
|
|
698
|
-
})
|
|
699
|
-
|
|
700
|
-
if (!position) {
|
|
701
|
-
console.warn('Could not find position for dragstart event')
|
|
702
|
-
return
|
|
703
|
-
}
|
|
704
|
-
|
|
705
|
-
editorActor.send({
|
|
706
|
-
type: 'dragstart',
|
|
707
|
-
origin: position,
|
|
708
|
-
})
|
|
709
|
-
|
|
710
|
-
editorActor.send({
|
|
711
|
-
type: 'behavior event',
|
|
712
|
-
behaviorEvent: {
|
|
713
|
-
type: 'drag.dragstart',
|
|
714
|
-
originEvent: {
|
|
715
|
-
clientX: event.clientX,
|
|
716
|
-
clientY: event.clientY,
|
|
717
|
-
dataTransfer: event.dataTransfer,
|
|
718
|
-
},
|
|
719
|
-
position,
|
|
720
|
-
},
|
|
721
|
-
editor: slateEditor,
|
|
722
|
-
})
|
|
723
|
-
|
|
724
|
-
// Prevent Slate from handling the event
|
|
725
|
-
return true
|
|
726
|
-
},
|
|
727
|
-
[onDragStart, editorActor, slateEditor],
|
|
728
|
-
)
|
|
729
|
-
|
|
730
|
-
const handleDrag = useCallback(
|
|
731
|
-
(event: React.DragEvent<HTMLDivElement>) => {
|
|
732
|
-
onDrag?.(event)
|
|
733
|
-
|
|
734
|
-
if (event.isDefaultPrevented() || event.isPropagationStopped()) {
|
|
735
|
-
return
|
|
736
|
-
}
|
|
737
|
-
|
|
738
|
-
const position = getEventPosition({
|
|
739
|
-
editorActor,
|
|
740
|
-
slateEditor,
|
|
741
|
-
event: event.nativeEvent,
|
|
742
|
-
})
|
|
743
|
-
|
|
744
|
-
if (!position) {
|
|
745
|
-
return
|
|
746
|
-
}
|
|
747
|
-
|
|
748
|
-
editorActor.send({
|
|
749
|
-
type: 'behavior event',
|
|
750
|
-
behaviorEvent: {
|
|
751
|
-
type: 'drag.drag',
|
|
752
|
-
originEvent: {
|
|
753
|
-
dataTransfer: event.dataTransfer,
|
|
754
|
-
},
|
|
755
|
-
},
|
|
756
|
-
editor: slateEditor,
|
|
757
|
-
})
|
|
758
|
-
|
|
759
|
-
// Prevent Slate from handling the event
|
|
760
|
-
return true
|
|
761
|
-
},
|
|
762
|
-
[onDrag, editorActor, slateEditor],
|
|
763
|
-
)
|
|
764
|
-
|
|
765
|
-
const handleDragEnd = useCallback(
|
|
766
|
-
(event: React.DragEvent<HTMLDivElement>) => {
|
|
767
|
-
onDragEnd?.(event)
|
|
768
|
-
|
|
769
|
-
if (event.isDefaultPrevented() || event.isPropagationStopped()) {
|
|
770
|
-
return
|
|
771
|
-
}
|
|
772
|
-
|
|
773
|
-
editorActor.send({
|
|
774
|
-
type: 'behavior event',
|
|
775
|
-
behaviorEvent: {
|
|
776
|
-
type: 'drag.dragend',
|
|
777
|
-
originEvent: {
|
|
778
|
-
dataTransfer: event.dataTransfer,
|
|
779
|
-
},
|
|
780
|
-
},
|
|
781
|
-
editor: slateEditor,
|
|
782
|
-
})
|
|
783
|
-
|
|
784
|
-
// Prevent Slate from handling the event
|
|
785
|
-
return true
|
|
786
|
-
},
|
|
787
|
-
[onDragEnd, editorActor, slateEditor],
|
|
788
|
-
)
|
|
789
|
-
|
|
790
|
-
const handleDragEnter = useCallback(
|
|
791
|
-
(event: React.DragEvent<HTMLDivElement>) => {
|
|
792
|
-
onDragEnter?.(event)
|
|
793
|
-
|
|
794
|
-
if (event.isDefaultPrevented() || event.isPropagationStopped()) {
|
|
795
|
-
return
|
|
796
|
-
}
|
|
797
|
-
|
|
798
|
-
const position = getEventPosition({
|
|
799
|
-
editorActor,
|
|
800
|
-
slateEditor,
|
|
801
|
-
event: event.nativeEvent,
|
|
802
|
-
})
|
|
803
|
-
|
|
804
|
-
if (!position) {
|
|
805
|
-
return
|
|
806
|
-
}
|
|
807
|
-
|
|
808
|
-
editorActor.send({
|
|
809
|
-
type: 'behavior event',
|
|
810
|
-
behaviorEvent: {
|
|
811
|
-
type: 'drag.dragenter',
|
|
812
|
-
originEvent: {
|
|
813
|
-
dataTransfer: event.dataTransfer,
|
|
814
|
-
},
|
|
815
|
-
position,
|
|
816
|
-
},
|
|
817
|
-
editor: slateEditor,
|
|
818
|
-
})
|
|
819
|
-
|
|
820
|
-
// Prevent Slate from handling the event
|
|
821
|
-
return true
|
|
822
|
-
},
|
|
823
|
-
[onDragEnter, editorActor, slateEditor],
|
|
824
|
-
)
|
|
825
|
-
|
|
826
|
-
const handleDragOver = useCallback(
|
|
827
|
-
(event: React.DragEvent<HTMLDivElement>) => {
|
|
828
|
-
onDragOver?.(event)
|
|
829
|
-
|
|
830
|
-
if (event.isDefaultPrevented() || event.isPropagationStopped()) {
|
|
831
|
-
return
|
|
832
|
-
}
|
|
833
|
-
|
|
834
|
-
const position = getEventPosition({
|
|
835
|
-
editorActor,
|
|
836
|
-
slateEditor,
|
|
837
|
-
event: event.nativeEvent,
|
|
838
|
-
})
|
|
839
|
-
|
|
840
|
-
if (!position) {
|
|
841
|
-
return
|
|
842
|
-
}
|
|
843
|
-
|
|
844
|
-
editorActor.send({
|
|
845
|
-
type: 'behavior event',
|
|
846
|
-
behaviorEvent: {
|
|
847
|
-
type: 'drag.dragover',
|
|
848
|
-
originEvent: {
|
|
849
|
-
dataTransfer: event.dataTransfer,
|
|
850
|
-
},
|
|
851
|
-
dragOrigin: editorActor.getSnapshot().context.internalDrag?.origin,
|
|
852
|
-
position,
|
|
853
|
-
},
|
|
854
|
-
editor: slateEditor,
|
|
855
|
-
nativeEvent: event,
|
|
856
|
-
})
|
|
857
|
-
|
|
858
|
-
// Prevent Slate from handling the event
|
|
859
|
-
return true
|
|
860
|
-
},
|
|
861
|
-
[onDragOver, editorActor, slateEditor],
|
|
862
|
-
)
|
|
863
|
-
|
|
864
|
-
const handleDrop = useCallback(
|
|
865
|
-
(event: React.DragEvent<HTMLDivElement>) => {
|
|
866
|
-
onDrop?.(event)
|
|
867
|
-
|
|
868
|
-
if (event.isDefaultPrevented() || event.isPropagationStopped()) {
|
|
869
|
-
return
|
|
870
|
-
}
|
|
871
|
-
|
|
872
|
-
const position = getEventPosition({
|
|
873
|
-
editorActor,
|
|
874
|
-
slateEditor,
|
|
875
|
-
event: event.nativeEvent,
|
|
876
|
-
})
|
|
877
|
-
|
|
878
|
-
if (!position) {
|
|
879
|
-
console.warn('Could not find position for drop event')
|
|
880
|
-
return
|
|
881
|
-
}
|
|
882
|
-
|
|
883
|
-
editorActor.send({
|
|
884
|
-
type: 'behavior event',
|
|
885
|
-
behaviorEvent: {
|
|
886
|
-
type: 'drag.drop',
|
|
887
|
-
originEvent: {
|
|
888
|
-
dataTransfer: event.dataTransfer,
|
|
889
|
-
},
|
|
890
|
-
dragOrigin: editorActor.getSnapshot().context.internalDrag?.origin,
|
|
891
|
-
position,
|
|
892
|
-
},
|
|
893
|
-
editor: slateEditor,
|
|
894
|
-
nativeEvent: event,
|
|
895
|
-
})
|
|
896
|
-
|
|
897
|
-
// Prevent Slate from handling the event
|
|
898
|
-
return true
|
|
899
|
-
},
|
|
900
|
-
[onDrop, editorActor, slateEditor],
|
|
901
|
-
)
|
|
902
|
-
|
|
903
|
-
const handleDragLeave = useCallback(
|
|
904
|
-
(event: React.DragEvent<HTMLDivElement>) => {
|
|
905
|
-
onDragLeave?.(event)
|
|
906
|
-
|
|
907
|
-
if (event.isDefaultPrevented() || event.isPropagationStopped()) {
|
|
908
|
-
return
|
|
909
|
-
}
|
|
910
|
-
|
|
911
|
-
const position = getEventPosition({
|
|
912
|
-
editorActor,
|
|
913
|
-
slateEditor,
|
|
914
|
-
event: event.nativeEvent,
|
|
915
|
-
})
|
|
916
|
-
|
|
917
|
-
if (!position) {
|
|
918
|
-
return
|
|
919
|
-
}
|
|
920
|
-
|
|
921
|
-
editorActor.send({
|
|
922
|
-
type: 'behavior event',
|
|
923
|
-
behaviorEvent: {
|
|
924
|
-
type: 'drag.dragleave',
|
|
925
|
-
originEvent: {
|
|
926
|
-
dataTransfer: event.dataTransfer,
|
|
927
|
-
},
|
|
928
|
-
},
|
|
929
|
-
editor: slateEditor,
|
|
930
|
-
})
|
|
931
|
-
|
|
932
|
-
// Prevent Slate from handling the event
|
|
933
|
-
return true
|
|
934
|
-
},
|
|
935
|
-
[onDragLeave, editorActor, slateEditor],
|
|
936
|
-
)
|
|
937
|
-
|
|
938
|
-
const callbackRef = useCallback(
|
|
939
|
-
(editorElement: HTMLDivElement | null) => {
|
|
940
|
-
if (typeof forwardedRef === 'function') {
|
|
941
|
-
forwardedRef(editorElement)
|
|
942
|
-
} else if (forwardedRef) {
|
|
943
|
-
forwardedRef.current = editorElement
|
|
944
|
-
}
|
|
945
|
-
|
|
946
|
-
if (editorElement) {
|
|
947
|
-
// Observe mutations (child list and subtree) to this component's DOM,
|
|
948
|
-
// and make sure the editor selection is valid when that happens.
|
|
949
|
-
const mutationObserver = new MutationObserver(() => {
|
|
950
|
-
validateSelectionActor.send({
|
|
951
|
-
type: 'validate selection',
|
|
952
|
-
editorElement,
|
|
953
|
-
})
|
|
954
|
-
})
|
|
955
|
-
|
|
956
|
-
mutationObserver.observe(editorElement, {
|
|
957
|
-
attributeOldValue: false,
|
|
958
|
-
attributes: false,
|
|
959
|
-
characterData: false,
|
|
960
|
-
childList: true,
|
|
961
|
-
subtree: true,
|
|
962
|
-
})
|
|
963
|
-
|
|
964
|
-
return () => {
|
|
965
|
-
mutationObserver.disconnect()
|
|
966
|
-
}
|
|
967
|
-
}
|
|
968
|
-
},
|
|
969
|
-
[forwardedRef, validateSelectionActor],
|
|
970
|
-
)
|
|
971
|
-
|
|
972
|
-
if (!portableTextEditor) {
|
|
973
|
-
return null
|
|
974
|
-
}
|
|
975
|
-
|
|
976
|
-
return hasInvalidValue ? null : (
|
|
977
|
-
<SlateEditable
|
|
978
|
-
{...restProps}
|
|
979
|
-
ref={callbackRef}
|
|
980
|
-
data-read-only={readOnly}
|
|
981
|
-
autoFocus={false}
|
|
982
|
-
className={restProps.className || 'pt-editable'}
|
|
983
|
-
decorate={decorate}
|
|
984
|
-
onBlur={handleOnBlur}
|
|
985
|
-
onCopy={handleCopy}
|
|
986
|
-
onCut={handleCut}
|
|
987
|
-
onClick={handleClick}
|
|
988
|
-
onDOMBeforeInput={handleOnBeforeInput}
|
|
989
|
-
onDragStart={handleDragStart}
|
|
990
|
-
onDrag={handleDrag}
|
|
991
|
-
onDragEnd={handleDragEnd}
|
|
992
|
-
onDragEnter={handleDragEnter}
|
|
993
|
-
onDragOver={handleDragOver}
|
|
994
|
-
onDrop={handleDrop}
|
|
995
|
-
onDragLeave={handleDragLeave}
|
|
996
|
-
onFocus={handleOnFocus}
|
|
997
|
-
onKeyDown={handleKeyDown}
|
|
998
|
-
onKeyUp={handleKeyUp}
|
|
999
|
-
onPaste={handlePaste}
|
|
1000
|
-
readOnly={readOnly}
|
|
1001
|
-
// We have implemented our own placeholder logic with decorations.
|
|
1002
|
-
// This 'renderPlaceholder' should not be used.
|
|
1003
|
-
renderPlaceholder={undefined}
|
|
1004
|
-
renderElement={renderElement}
|
|
1005
|
-
renderLeaf={renderLeaf}
|
|
1006
|
-
renderText={renderText}
|
|
1007
|
-
scrollSelectionIntoView={scrollSelectionIntoViewToSlate}
|
|
1008
|
-
/>
|
|
1009
|
-
)
|
|
1010
|
-
})
|
|
1011
|
-
|
|
1012
|
-
PortableTextEditable.displayName = 'ForwardRef(PortableTextEditable)'
|