@portabletext/editor 2.6.0 → 2.6.1
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.
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { Patch, Patch as Patch$1 } from "@portabletext/patches";
|
|
2
2
|
import * as _sanity_types5 from "@sanity/types";
|
|
3
3
|
import { ArrayDefinition, ArraySchemaType, BlockDecoratorDefinition, BlockListDefinition, BlockStyleDefinition, ObjectSchemaType, Path, PortableTextBlock, PortableTextBlock as PortableTextBlock$1, PortableTextChild, PortableTextChild as PortableTextChild$1, PortableTextListBlock, PortableTextObject, PortableTextObject as PortableTextObject$1, PortableTextSpan, PortableTextSpan as PortableTextSpan$1, PortableTextTextBlock, PortableTextTextBlock as PortableTextTextBlock$1, TypedObject } from "@sanity/types";
|
|
4
|
-
import * as
|
|
4
|
+
import * as _portabletext_schema6 from "@portabletext/schema";
|
|
5
5
|
import { AnnotationDefinition, AnnotationSchemaType, BaseDefinition, BlockObjectDefinition, BlockObjectSchemaType, DecoratorDefinition, DecoratorSchemaType, FieldDefinition, InlineObjectDefinition, InlineObjectSchemaType, ListDefinition, ListSchemaType, Schema, SchemaDefinition, SchemaDefinition as SchemaDefinition$1, StyleDefinition, StyleSchemaType, defineSchema } from "@portabletext/schema";
|
|
6
6
|
import * as xstate227 from "xstate";
|
|
7
7
|
import { ActorRef, ActorRefFrom, EventObject, Snapshot } from "xstate";
|
|
8
8
|
import { BaseRange, Descendant, Operation } from "slate";
|
|
9
|
-
import * as
|
|
9
|
+
import * as react12 from "react";
|
|
10
10
|
import React$1, { BaseSyntheticEvent, ClipboardEvent, Component, FocusEvent, JSX, KeyboardEvent as KeyboardEvent$1, MutableRefObject, PropsWithChildren, ReactElement, RefObject, TextareaHTMLAttributes } from "react";
|
|
11
11
|
import * as xstate_guards12 from "xstate/guards";
|
|
12
12
|
import { Observable, Subject } from "rxjs";
|
|
@@ -215,7 +215,7 @@ declare class PortableTextEditor extends Component<PortableTextEditorProps<Inter
|
|
|
215
215
|
componentDidUpdate(prevProps: PortableTextEditorProps): void;
|
|
216
216
|
componentWillUnmount(): void;
|
|
217
217
|
setEditable: (editable: EditableAPI) => void;
|
|
218
|
-
render():
|
|
218
|
+
render(): react12.JSX.Element;
|
|
219
219
|
/**
|
|
220
220
|
* @deprecated
|
|
221
221
|
* Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
|
|
@@ -573,6 +573,7 @@ type HotkeyOptions = {
|
|
|
573
573
|
* @public
|
|
574
574
|
*/
|
|
575
575
|
type PortableTextEditableProps = Omit<TextareaHTMLAttributes<HTMLDivElement>, 'onPaste' | 'onCopy' | 'onBeforeInput'> & {
|
|
576
|
+
ref?: React.RefObject<HTMLDivElement>;
|
|
576
577
|
hotkeys?: HotkeyOptions;
|
|
577
578
|
onBeforeInput?: (event: InputEvent) => void;
|
|
578
579
|
onPaste?: OnPasteFn;
|
|
@@ -609,23 +610,7 @@ type PortableTextEditableProps = Omit<TextareaHTMLAttributes<HTMLDivElement>, 'o
|
|
|
609
610
|
* ```
|
|
610
611
|
* @group Components
|
|
611
612
|
*/
|
|
612
|
-
declare const PortableTextEditable:
|
|
613
|
-
hotkeys?: HotkeyOptions;
|
|
614
|
-
onBeforeInput?: (event: InputEvent) => void;
|
|
615
|
-
onPaste?: OnPasteFn;
|
|
616
|
-
onCopy?: OnCopyFn;
|
|
617
|
-
rangeDecorations?: RangeDecoration[];
|
|
618
|
-
renderAnnotation?: RenderAnnotationFunction;
|
|
619
|
-
renderBlock?: RenderBlockFunction;
|
|
620
|
-
renderChild?: RenderChildFunction;
|
|
621
|
-
renderDecorator?: RenderDecoratorFunction;
|
|
622
|
-
renderListItem?: RenderListItemFunction;
|
|
623
|
-
renderPlaceholder?: RenderPlaceholderFunction;
|
|
624
|
-
renderStyle?: RenderStyleFunction;
|
|
625
|
-
scrollSelectionIntoView?: ScrollSelectionIntoViewFunction;
|
|
626
|
-
selection?: EditorSelection;
|
|
627
|
-
spellCheck?: boolean;
|
|
628
|
-
} & react20.RefAttributes<Omit<HTMLDivElement, "as" | "onPaste" | "onBeforeInput">>>;
|
|
613
|
+
declare const PortableTextEditable: react12.ForwardRefExoticComponent<Omit<PortableTextEditableProps, "ref"> & react12.RefAttributes<Omit<HTMLDivElement, "as" | "onPaste" | "onBeforeInput">>>;
|
|
629
614
|
type DecoratedRange = BaseRange & {
|
|
630
615
|
rangeDecoration: RangeDecoration;
|
|
631
616
|
};
|
|
@@ -1354,7 +1339,7 @@ declare const editorMachine: xstate227.StateMachine<{
|
|
|
1354
1339
|
initialValue?: Array<PortableTextBlock>;
|
|
1355
1340
|
}, xstate227.NonReducibleUnknown, InternalPatchEvent | MutationEvent | PatchesEvent | {
|
|
1356
1341
|
type: "blurred";
|
|
1357
|
-
event:
|
|
1342
|
+
event: react12.FocusEvent<HTMLDivElement, Element>;
|
|
1358
1343
|
} | {
|
|
1359
1344
|
type: "done loading";
|
|
1360
1345
|
} | {
|
|
@@ -1366,7 +1351,7 @@ declare const editorMachine: xstate227.StateMachine<{
|
|
|
1366
1351
|
data: unknown;
|
|
1367
1352
|
} | {
|
|
1368
1353
|
type: "focused";
|
|
1369
|
-
event:
|
|
1354
|
+
event: react12.FocusEvent<HTMLDivElement, Element>;
|
|
1370
1355
|
} | {
|
|
1371
1356
|
type: "invalid value";
|
|
1372
1357
|
resolution: InvalidValueResolution | null;
|
|
@@ -1521,7 +1506,7 @@ declare const editorMachine: xstate227.StateMachine<{
|
|
|
1521
1506
|
}, xstate227.AnyEventObject>;
|
|
1522
1507
|
}) => {
|
|
1523
1508
|
behaviors: Set<{
|
|
1524
|
-
behavior: Behavior<"*" | "split" | `custom.${string}` | "annotation.add" | "annotation.remove" | "block.set" | "block.unset" | "child.set" | "child.unset" | "decorator.add" | "decorator.remove" | "delete" | "history.redo" | "history.undo" | "insert.inline object" | "insert.block" | "insert.span" | "insert.text" | "move.backward" | "move.block" | "move.forward" | "select" | "annotation.set" | "annotation.toggle" | "decorator.toggle" | "delete.backward" | "delete.block" | "delete.child" | "delete.forward" | "delete.text" | "deserialize" | "deserialize.data" | "deserialization.success" | "deserialization.failure" | "insert.blocks" | "insert.break" | "insert.soft break" | "list item.add" | "list item.remove" | "list item.toggle" | "move.block down" | "move.block up" | "select.previous block" | "select.next block" | "serialize" | "serialize.data" | "serialization.success" | "serialization.failure" | "style.add" | "style.remove" | "style.toggle" | "clipboard.copy" | "clipboard.cut" | "clipboard.paste" | "drag.dragstart" | "drag.drag" | "drag.dragend" | "drag.dragenter" | "drag.dragover" | "drag.dragleave" | "drag.drop" | "input.*" | "keyboard.keydown" | "keyboard.keyup" | "mouse.click" | "
|
|
1509
|
+
behavior: Behavior<"*" | "split" | `custom.${string}` | "annotation.add" | "annotation.remove" | "block.set" | "block.unset" | "child.set" | "child.unset" | "decorator.add" | "decorator.remove" | "delete" | "history.redo" | "history.undo" | "insert.inline object" | "insert.block" | "insert.span" | "insert.text" | "move.backward" | "move.block" | "move.forward" | "select" | "annotation.set" | "annotation.toggle" | "decorator.toggle" | "delete.backward" | "delete.block" | "delete.child" | "delete.forward" | "delete.text" | "deserialize" | "deserialize.data" | "deserialization.success" | "deserialization.failure" | "insert.blocks" | "insert.break" | "insert.soft break" | "list item.add" | "list item.remove" | "list item.toggle" | "move.block down" | "move.block up" | "select.previous block" | "select.next block" | "serialize" | "serialize.data" | "serialization.success" | "serialization.failure" | "style.add" | "style.remove" | "style.toggle" | "clipboard.copy" | "clipboard.cut" | "clipboard.paste" | "drag.dragstart" | "drag.drag" | "drag.dragend" | "drag.dragenter" | "drag.dragover" | "drag.dragleave" | "drag.drop" | "input.*" | "keyboard.keydown" | "keyboard.keyup" | "mouse.click" | "history.*" | "split.*" | "delete.*" | "select.*" | "deserialize.*" | "serialize.*" | "annotation.*" | "block.*" | "child.*" | "decorator.*" | "insert.*" | "move.*" | "deserialization.*" | "list item.*" | "serialization.*" | "style.*" | "clipboard.*" | "drag.*" | "keyboard.*" | "mouse.*", true, {
|
|
1525
1510
|
type: StrictExtract<"split" | "annotation.add" | "annotation.remove" | "block.set" | "block.unset" | "child.set" | "child.unset" | "decorator.add" | "decorator.remove" | "delete" | "history.redo" | "history.undo" | "insert.inline object" | "insert.block" | "insert.span" | "insert.text" | "move.backward" | "move.block" | "move.forward" | "select" | "annotation.set" | "annotation.toggle" | "decorator.toggle" | "delete.backward" | "delete.block" | "delete.child" | "delete.forward" | "delete.text" | "deserialize" | "deserialize.data" | "deserialization.success" | "deserialization.failure" | "insert.blocks" | "insert.break" | "insert.soft break" | "list item.add" | "list item.remove" | "list item.toggle" | "move.block down" | "move.block up" | "select.previous block" | "select.next block" | "serialize" | "serialize.data" | "serialization.success" | "serialization.failure" | "style.add" | "style.remove" | "style.toggle", "annotation.add">;
|
|
1526
1511
|
annotation: {
|
|
1527
1512
|
name: string;
|
|
@@ -1799,7 +1784,7 @@ declare const editorMachine: xstate227.StateMachine<{
|
|
|
1799
1784
|
keyGenerator: () => string;
|
|
1800
1785
|
pendingEvents: never[];
|
|
1801
1786
|
pendingIncomingPatchesEvents: never[];
|
|
1802
|
-
schema:
|
|
1787
|
+
schema: _portabletext_schema6.Schema;
|
|
1803
1788
|
selection: null;
|
|
1804
1789
|
initialReadOnly: boolean;
|
|
1805
1790
|
maxBlocks: number | undefined;
|
|
@@ -2022,7 +2007,7 @@ declare const editorMachine: xstate227.StateMachine<{
|
|
|
2022
2007
|
type: "drop";
|
|
2023
2008
|
}, undefined, never, never, never, never, InternalPatchEvent | MutationEvent | PatchesEvent | {
|
|
2024
2009
|
type: "blurred";
|
|
2025
|
-
event:
|
|
2010
|
+
event: react12.FocusEvent<HTMLDivElement, Element>;
|
|
2026
2011
|
} | {
|
|
2027
2012
|
type: "done loading";
|
|
2028
2013
|
} | {
|
|
@@ -2034,7 +2019,7 @@ declare const editorMachine: xstate227.StateMachine<{
|
|
|
2034
2019
|
data: unknown;
|
|
2035
2020
|
} | {
|
|
2036
2021
|
type: "focused";
|
|
2037
|
-
event:
|
|
2022
|
+
event: react12.FocusEvent<HTMLDivElement, Element>;
|
|
2038
2023
|
} | {
|
|
2039
2024
|
type: "invalid value";
|
|
2040
2025
|
resolution: InvalidValueResolution | null;
|
|
@@ -2905,7 +2890,7 @@ declare const editorMachine: xstate227.StateMachine<{
|
|
|
2905
2890
|
type: "drop";
|
|
2906
2891
|
}, undefined, never, never, never, never, InternalPatchEvent | MutationEvent | PatchesEvent | {
|
|
2907
2892
|
type: "blurred";
|
|
2908
|
-
event:
|
|
2893
|
+
event: react12.FocusEvent<HTMLDivElement, Element>;
|
|
2909
2894
|
} | {
|
|
2910
2895
|
type: "done loading";
|
|
2911
2896
|
} | {
|
|
@@ -2917,7 +2902,7 @@ declare const editorMachine: xstate227.StateMachine<{
|
|
|
2917
2902
|
data: unknown;
|
|
2918
2903
|
} | {
|
|
2919
2904
|
type: "focused";
|
|
2920
|
-
event:
|
|
2905
|
+
event: react12.FocusEvent<HTMLDivElement, Element>;
|
|
2921
2906
|
} | {
|
|
2922
2907
|
type: "invalid value";
|
|
2923
2908
|
resolution: InvalidValueResolution | null;
|
|
@@ -6,7 +6,7 @@ import { AnnotationDefinition, AnnotationSchemaType, BaseDefinition, BlockObject
|
|
|
6
6
|
import * as xstate227 from "xstate";
|
|
7
7
|
import { ActorRef, ActorRefFrom, EventObject, Snapshot } from "xstate";
|
|
8
8
|
import { BaseRange, Descendant, Operation } from "slate";
|
|
9
|
-
import * as
|
|
9
|
+
import * as react21 from "react";
|
|
10
10
|
import React$1, { BaseSyntheticEvent, ClipboardEvent, Component, FocusEvent, JSX, KeyboardEvent as KeyboardEvent$1, MutableRefObject, PropsWithChildren, ReactElement, RefObject, TextareaHTMLAttributes } from "react";
|
|
11
11
|
import * as xstate_guards12 from "xstate/guards";
|
|
12
12
|
import { Observable, Subject } from "rxjs";
|
|
@@ -215,7 +215,7 @@ declare class PortableTextEditor extends Component<PortableTextEditorProps<Inter
|
|
|
215
215
|
componentDidUpdate(prevProps: PortableTextEditorProps): void;
|
|
216
216
|
componentWillUnmount(): void;
|
|
217
217
|
setEditable: (editable: EditableAPI) => void;
|
|
218
|
-
render():
|
|
218
|
+
render(): react21.JSX.Element;
|
|
219
219
|
/**
|
|
220
220
|
* @deprecated
|
|
221
221
|
* Use built-in selectors or write your own: https://www.portabletext.org/reference/selectors/
|
|
@@ -573,6 +573,7 @@ type HotkeyOptions = {
|
|
|
573
573
|
* @public
|
|
574
574
|
*/
|
|
575
575
|
type PortableTextEditableProps = Omit<TextareaHTMLAttributes<HTMLDivElement>, 'onPaste' | 'onCopy' | 'onBeforeInput'> & {
|
|
576
|
+
ref?: React.RefObject<HTMLDivElement>;
|
|
576
577
|
hotkeys?: HotkeyOptions;
|
|
577
578
|
onBeforeInput?: (event: InputEvent) => void;
|
|
578
579
|
onPaste?: OnPasteFn;
|
|
@@ -609,23 +610,7 @@ type PortableTextEditableProps = Omit<TextareaHTMLAttributes<HTMLDivElement>, 'o
|
|
|
609
610
|
* ```
|
|
610
611
|
* @group Components
|
|
611
612
|
*/
|
|
612
|
-
declare const PortableTextEditable:
|
|
613
|
-
hotkeys?: HotkeyOptions;
|
|
614
|
-
onBeforeInput?: (event: InputEvent) => void;
|
|
615
|
-
onPaste?: OnPasteFn;
|
|
616
|
-
onCopy?: OnCopyFn;
|
|
617
|
-
rangeDecorations?: RangeDecoration[];
|
|
618
|
-
renderAnnotation?: RenderAnnotationFunction;
|
|
619
|
-
renderBlock?: RenderBlockFunction;
|
|
620
|
-
renderChild?: RenderChildFunction;
|
|
621
|
-
renderDecorator?: RenderDecoratorFunction;
|
|
622
|
-
renderListItem?: RenderListItemFunction;
|
|
623
|
-
renderPlaceholder?: RenderPlaceholderFunction;
|
|
624
|
-
renderStyle?: RenderStyleFunction;
|
|
625
|
-
scrollSelectionIntoView?: ScrollSelectionIntoViewFunction;
|
|
626
|
-
selection?: EditorSelection;
|
|
627
|
-
spellCheck?: boolean;
|
|
628
|
-
} & react20.RefAttributes<Omit<HTMLDivElement, "as" | "onPaste" | "onBeforeInput">>>;
|
|
613
|
+
declare const PortableTextEditable: react21.ForwardRefExoticComponent<Omit<PortableTextEditableProps, "ref"> & react21.RefAttributes<Omit<HTMLDivElement, "as" | "onPaste" | "onBeforeInput">>>;
|
|
629
614
|
type DecoratedRange = BaseRange & {
|
|
630
615
|
rangeDecoration: RangeDecoration;
|
|
631
616
|
};
|
|
@@ -1354,7 +1339,7 @@ declare const editorMachine: xstate227.StateMachine<{
|
|
|
1354
1339
|
initialValue?: Array<PortableTextBlock>;
|
|
1355
1340
|
}, xstate227.NonReducibleUnknown, InternalPatchEvent | MutationEvent | PatchesEvent | {
|
|
1356
1341
|
type: "blurred";
|
|
1357
|
-
event:
|
|
1342
|
+
event: react21.FocusEvent<HTMLDivElement, Element>;
|
|
1358
1343
|
} | {
|
|
1359
1344
|
type: "done loading";
|
|
1360
1345
|
} | {
|
|
@@ -1366,7 +1351,7 @@ declare const editorMachine: xstate227.StateMachine<{
|
|
|
1366
1351
|
data: unknown;
|
|
1367
1352
|
} | {
|
|
1368
1353
|
type: "focused";
|
|
1369
|
-
event:
|
|
1354
|
+
event: react21.FocusEvent<HTMLDivElement, Element>;
|
|
1370
1355
|
} | {
|
|
1371
1356
|
type: "invalid value";
|
|
1372
1357
|
resolution: InvalidValueResolution | null;
|
|
@@ -2022,7 +2007,7 @@ declare const editorMachine: xstate227.StateMachine<{
|
|
|
2022
2007
|
type: "drop";
|
|
2023
2008
|
}, undefined, never, never, never, never, InternalPatchEvent | MutationEvent | PatchesEvent | {
|
|
2024
2009
|
type: "blurred";
|
|
2025
|
-
event:
|
|
2010
|
+
event: react21.FocusEvent<HTMLDivElement, Element>;
|
|
2026
2011
|
} | {
|
|
2027
2012
|
type: "done loading";
|
|
2028
2013
|
} | {
|
|
@@ -2034,7 +2019,7 @@ declare const editorMachine: xstate227.StateMachine<{
|
|
|
2034
2019
|
data: unknown;
|
|
2035
2020
|
} | {
|
|
2036
2021
|
type: "focused";
|
|
2037
|
-
event:
|
|
2022
|
+
event: react21.FocusEvent<HTMLDivElement, Element>;
|
|
2038
2023
|
} | {
|
|
2039
2024
|
type: "invalid value";
|
|
2040
2025
|
resolution: InvalidValueResolution | null;
|
|
@@ -2905,7 +2890,7 @@ declare const editorMachine: xstate227.StateMachine<{
|
|
|
2905
2890
|
type: "drop";
|
|
2906
2891
|
}, undefined, never, never, never, never, InternalPatchEvent | MutationEvent | PatchesEvent | {
|
|
2907
2892
|
type: "blurred";
|
|
2908
|
-
event:
|
|
2893
|
+
event: react21.FocusEvent<HTMLDivElement, Element>;
|
|
2909
2894
|
} | {
|
|
2910
2895
|
type: "done loading";
|
|
2911
2896
|
} | {
|
|
@@ -2917,7 +2902,7 @@ declare const editorMachine: xstate227.StateMachine<{
|
|
|
2917
2902
|
data: unknown;
|
|
2918
2903
|
} | {
|
|
2919
2904
|
type: "focused";
|
|
2920
|
-
event:
|
|
2905
|
+
event: react21.FocusEvent<HTMLDivElement, Element>;
|
|
2921
2906
|
} | {
|
|
2922
2907
|
type: "invalid value";
|
|
2923
2908
|
resolution: InvalidValueResolution | null;
|