slate-react 0.93.0 → 0.94.0

package/dist/plugin/react-editor.d.ts

@@ -1,91 +1,124 @@
 import { BaseEditor, Editor, Node, Path, Point, Range } from 'slate';
-import { Key } from '../utils/key';
+import { TextDiff } from '../utils/diff-text';
 import { DOMNode, DOMPoint, DOMRange, DOMSelection, DOMStaticRange } from '../utils/dom';
+import { Key } from '../utils/key';
 /**
  * A React and DOM-specific version of the `Editor` interface.
  */
 export interface ReactEditor extends BaseEditor {
+    hasEditableTarget: (editor: ReactEditor, target: EventTarget | null) => target is DOMNode;
+    hasRange: (editor: ReactEditor, range: Range) => boolean;
+    hasSelectableTarget: (editor: ReactEditor, target: EventTarget | null) => boolean;
+    hasTarget: (editor: ReactEditor, target: EventTarget | null) => target is DOMNode;
     insertData: (data: DataTransfer) => void;
     insertFragmentData: (data: DataTransfer) => boolean;
     insertTextData: (data: DataTransfer) => boolean;
-    setFragmentData: (data: DataTransfer, originEvent?: 'drag' | 'copy' | 'cut') => void;
-    hasRange: (editor: ReactEditor, range: Range) => boolean;
-    hasTarget: (editor: ReactEditor, target: EventTarget | null) => target is DOMNode;
-    hasEditableTarget: (editor: ReactEditor, target: EventTarget | null) => target is DOMNode;
-    hasSelectableTarget: (editor: ReactEditor, target: EventTarget | null) => boolean;
     isTargetInsideNonReadonlyVoid: (editor: ReactEditor, target: EventTarget | null) => boolean;
+    setFragmentData: (data: DataTransfer, originEvent?: 'drag' | 'copy' | 'cut') => void;
 }
-export declare const ReactEditor: {
+export interface ReactEditorInterface {
     /**
-     * Check if the user is currently composing inside the editor.
+     * Experimental and android specific: Get pending diffs
      */
-    isComposing(editor: ReactEditor): boolean;
+    androidPendingDiffs: (editor: Editor) => TextDiff[] | undefined;
     /**
-     * Return the host window of the current editor.
+     * Experimental and android specific: Flush all pending diffs and cancel composition at the next possible time.
      */
-    getWindow(editor: ReactEditor): Window;
+    androidScheduleFlush: (editor: Editor) => void;
     /**
-     * Find a key for a Slate node.
+     * Blur the editor.
      */
-    findKey(editor: ReactEditor, node: Node): Key;
+    blur: (editor: ReactEditor) => void;
     /**
-     * Find the path of Slate node.
+     * Deselect the editor.
      */
-    findPath(editor: ReactEditor, node: Node): Path;
+    deselect: (editor: ReactEditor) => void;
     /**
      * Find the DOM node that implements DocumentOrShadowRoot for the editor.
      */
-    findDocumentOrShadowRoot(editor: ReactEditor): Document | ShadowRoot;
+    findDocumentOrShadowRoot: (editor: ReactEditor) => Document | ShadowRoot;
     /**
-     * Check if the editor is focused.
+     * Get the target range from a DOM `event`.
      */
-    isFocused(editor: ReactEditor): boolean;
+    findEventRange: (editor: ReactEditor, event: any) => Range;
     /**
-     * Check if the editor is in read-only mode.
+     * Find a key for a Slate node.
      */
-    isReadOnly(editor: ReactEditor): boolean;
+    findKey: (editor: ReactEditor, node: Node) => Key;
     /**
-     * Blur the editor.
+     * Find the path of Slate node.
      */
-    blur(editor: ReactEditor): void;
+    findPath: (editor: ReactEditor, node: Node) => Path;
     /**
      * Focus the editor.
      */
-    focus(editor: ReactEditor): void;
+    focus: (editor: ReactEditor) => void;
     /**
-     * Deselect the editor.
+     * Return the host window of the current editor.
      */
-    deselect(editor: ReactEditor): void;
+    getWindow: (editor: ReactEditor) => Window;
     /**
      * Check if a DOM node is within the editor.
      */
-    hasDOMNode(editor: ReactEditor, target: DOMNode, options?: {
+    hasDOMNode: (editor: ReactEditor, target: DOMNode, options?: {
         editable?: boolean;
-    }): boolean;
+    }) => boolean;
+    /**
+     * Check if the target is editable and in the editor.
+     */
+    hasEditableTarget: (editor: ReactEditor, target: EventTarget | null) => target is DOMNode;
+    /**
+     *
+     */
+    hasRange: (editor: ReactEditor, range: Range) => boolean;
+    /**
+     * Check if the target can be selectable
+     */
+    hasSelectableTarget: (editor: ReactEditor, target: EventTarget | null) => boolean;
+    /**
+     * Check if the target is in the editor.
+     */
+    hasTarget: (editor: ReactEditor, target: EventTarget | null) => target is DOMNode;
     /**
      * Insert data from a `DataTransfer` into the editor.
      */
-    insertData(editor: ReactEditor, data: DataTransfer): void;
+    insertData: (editor: ReactEditor, data: DataTransfer) => void;
     /**
      * Insert fragment data from a `DataTransfer` into the editor.
      */
-    insertFragmentData(editor: ReactEditor, data: DataTransfer): boolean;
+    insertFragmentData: (editor: ReactEditor, data: DataTransfer) => boolean;
     /**
      * Insert text data from a `DataTransfer` into the editor.
      */
-    insertTextData(editor: ReactEditor, data: DataTransfer): boolean;
+    insertTextData: (editor: ReactEditor, data: DataTransfer) => boolean;
+    /**
+     * Check if the user is currently composing inside the editor.
+     */
+    isComposing: (editor: ReactEditor) => boolean;
+    /**
+     * Check if the editor is focused.
+     */
+    isFocused: (editor: ReactEditor) => boolean;
+    /**
+     * Check if the editor is in read-only mode.
+     */
+    isReadOnly: (editor: ReactEditor) => boolean;
+    /**
+     * Check if the target is inside void and in an non-readonly editor.
+     */
+    isTargetInsideNonReadonlyVoid: (editor: ReactEditor, target: EventTarget | null) => boolean;
     /**
      * Sets data from the currently selected fragment on a `DataTransfer`.
      */
-    setFragmentData(editor: ReactEditor, data: DataTransfer, originEvent?: "drag" | "copy" | "cut" | undefined): void;
+    setFragmentData: (editor: ReactEditor, data: DataTransfer, originEvent?: 'drag' | 'copy' | 'cut') => void;
     /**
      * Find the native DOM element from a Slate node.
      */
-    toDOMNode(editor: ReactEditor, node: Node): HTMLElement;
+    toDOMNode: (editor: ReactEditor, node: Node) => HTMLElement;
     /**
      * Find a native DOM selection point from a Slate point.
      */
-    toDOMPoint(editor: ReactEditor, point: Point): DOMPoint;
+    toDOMPoint: (editor: ReactEditor, point: Point) => DOMPoint;
     /**
      * Find a native DOM range from a Slate `range`.
      *
@@ -94,56 +127,25 @@ export declare const ReactEditor: {
      * there is no way to create a reverse DOM Range using Range.setStart/setEnd
      * according to https://dom.spec.whatwg.org/#concept-range-bp-set.
      */
-    toDOMRange(editor: ReactEditor, range: Range): DOMRange;
+    toDOMRange: (editor: ReactEditor, range: Range) => DOMRange;
     /**
      * Find a Slate node from a native DOM `element`.
      */
-    toSlateNode(editor: ReactEditor, domNode: DOMNode): Node;
-    /**
-     * Get the target range from a DOM `event`.
-     */
-    findEventRange(editor: ReactEditor, event: any): Range;
+    toSlateNode: (editor: ReactEditor, domNode: DOMNode) => Node;
     /**
      * Find a Slate point from a DOM selection's `domNode` and `domOffset`.
      */
-    toSlatePoint<T extends boolean>(editor: ReactEditor, domPoint: DOMPoint, options: {
+    toSlatePoint: <T extends boolean>(editor: ReactEditor, domPoint: DOMPoint, options: {
         exactMatch: boolean;
         suppressThrow: T;
-    }): T extends true ? import("slate").BasePoint | null : import("slate").BasePoint;
+    }) => T extends true ? Point | null : Point;
     /**
      * Find a Slate range from a DOM range or selection.
      */
-    toSlateRange<T_1 extends boolean>(editor: ReactEditor, domRange: DOMRange | DOMStaticRange | DOMSelection, options: {
+    toSlateRange: <T extends boolean>(editor: ReactEditor, domRange: DOMRange | DOMStaticRange | DOMSelection, options: {
         exactMatch: boolean;
-        suppressThrow: T_1;
-    }): T_1 extends true ? import("slate").BaseSelection : import("slate").BaseRange & {
-        placeholder?: string | undefined;
-        onPlaceholderResize?: ((node: HTMLElement | null) => void) | undefined;
-    };
-    hasRange(editor: ReactEditor, range: Range): boolean;
-    /**
-     * Check if the target is in the editor.
-     */
-    hasTarget(editor: ReactEditor, target: EventTarget | null): target is DOMNode;
-    /**
-     * Check if the target is editable and in the editor.
-     */
-    hasEditableTarget(editor: ReactEditor, target: EventTarget | null): target is DOMNode;
-    /**
-     * Check if the target can be selectable
-     */
-    hasSelectableTarget(editor: ReactEditor, target: EventTarget | null): boolean;
-    /**
-     * Check if the target is inside void and in an non-readonly editor.
-     */
-    isTargetInsideNonReadonlyVoid(editor: ReactEditor, target: EventTarget | null): boolean;
-    /**
-     * Experimental and android specific: Flush all pending diffs and cancel composition at the next possible time.
-     */
-    androidScheduleFlush(editor: Editor): void;
-    /**
-     * Experimental and android specific: Get pending diffs
-     */
-    androidPendingDiffs(editor: Editor): import("../utils/diff-text").TextDiff[] | undefined;
-};
+        suppressThrow: T;
+    }) => T extends true ? Range | null : Range;
+}
+export declare const ReactEditor: ReactEditorInterface;
 //# sourceMappingURL=react-editor.d.ts.map

package/dist/plugin/react-editor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"react-editor.d.ts","sourceRoot":"","sources":["../packages/slate-react/src/plugin/react-editor.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,MAAM,EACN,IAAI,EACJ,IAAI,EACJ,KAAK,EACL,KAAK,EAIN,MAAM,OAAO,CAAA;AAEd,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAA;AAelC,OAAO,EAEL,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,cAAc,EAOf,MAAM,cAAc,CAAA;AAGrB;;GAEG;AAEH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,UAAU,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,CAAA;IACxC,kBAAkB,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,OAAO,CAAA;IACnD,cAAc,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,OAAO,CAAA;IAC/C,eAAe,EAAE,CACf,IAAI,EAAE,YAAY,EAClB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,KAClC,IAAI,CAAA;IACT,QAAQ,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,KAAK,OAAO,CAAA;IACxD,SAAS,EAAE,CACT,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,WAAW,GAAG,IAAI,KACvB,MAAM,IAAI,OAAO,CAAA;IACtB,iBAAiB,EAAE,CACjB,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,WAAW,GAAG,IAAI,KACvB,MAAM,IAAI,OAAO,CAAA;IACtB,mBAAmB,EAAE,CACnB,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,WAAW,GAAG,IAAI,KACvB,OAAO,CAAA;IACZ,6BAA6B,EAAE,CAC7B,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,WAAW,GAAG,IAAI,KACvB,OAAO,CAAA;CACb;AAGD,eAAO,MAAM,WAAW;IACtB;;OAEG;wBAEiB,WAAW,GAAG,OAAO;IAIzC;;OAEG;sBAEe,WAAW,GAAG,MAAM;IAQtC;;OAEG;oBAEa,WAAW,QAAQ,IAAI,GAAG,GAAG;IAW7C;;OAEG;qBAEc,WAAW,QAAQ,IAAI;IA8BxC;;OAEG;qCAE8B,WAAW,GAAG,QAAQ,GAAG,UAAU;IAcpE;;OAEG;sBAEe,WAAW,GAAG,OAAO;IAIvC;;OAEG;uBAEgB,WAAW,GAAG,OAAO;IAIxC;;OAEG;iBAEU,WAAW,GAAG,IAAI;IAU/B;;OAEG;kBAEW,WAAW,GAAG,IAAI;IAUhC;;OAEG;qBAEc,WAAW,GAAG,IAAI;IAcnC;;OAEG;uBAGO,WAAW,UACX,OAAO,YACN;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAC9B,OAAO;IAoCV;;OAEG;uBAEgB,WAAW,QAAQ,YAAY,GAAG,IAAI;IAIzD;;OAEG;+BAEwB,WAAW,QAAQ,YAAY,GAAG,OAAO;IAIpE;;OAEG;2BAEoB,WAAW,QAAQ,YAAY,GAAG,OAAO;IAIhE;;OAEG;4BAGO,WAAW,QACb,YAAY,sDAEjB,IAAI;IAIP;;OAEG;sBAEe,WAAW,QAAQ,IAAI,GAAG,WAAW;IAevD;;OAEG;uBAEgB,WAAW,SAAS,KAAK;IAwE5C;;;;;;;OAOG;uBAEgB,WAAW,SAAS,KAAK,GAAG,QAAQ;IA8BvD;;OAEG;wBAEiB,WAAW,WAAW,OAAO,GAAG,IAAI;IAgBxD;;OAEG;2BAEoB,WAAW,SAAS,GAAG,GAAG,KAAK;IAiEtD;;OAEG;4CAGO,WAAW;oBAGL,OAAO;;;IAiKvB;;OAEG;8CAGO,WAAW,YACT,QAAQ,GAAG,cAAc,GAAG,YAAY;oBAEpC,OAAO;;;;;;qBAyIN,WAAW,SAAS,KAAK,GAAG,OAAO;IAOpD;;OAEG;sBAEO,WAAW,UACX,WAAW,GAAG,IAAI;IAK5B;;OAEG;8BAEO,WAAW,UACX,WAAW,GAAG,IAAI;IAQ5B;;OAEG;gCAEO,WAAW,UACX,WAAW,GAAG,IAAI,GACzB,OAAO;IAOV;;OAEG;0CAEO,WAAW,UACX,WAAW,GAAG,IAAI,GACzB,OAAO;IASV;;OAEG;iCAC0B,MAAM;IAInC;;OAEG;gCACyB,MAAM;CAGnC,CAAA"}
+{"version":3,"file":"react-editor.d.ts","sourceRoot":"","sources":["../packages/slate-react/src/plugin/react-editor.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,MAAM,EAEN,IAAI,EACJ,IAAI,EACJ,KAAK,EACL,KAAK,EAGN,MAAM,OAAO,CAAA;AACd,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC7C,OAAO,EAEL,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,cAAc,EAOf,MAAM,cAAc,CAAA;AAGrB,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAA;AAgBlC;;GAEG;AAEH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,iBAAiB,EAAE,CACjB,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,WAAW,GAAG,IAAI,KACvB,MAAM,IAAI,OAAO,CAAA;IACtB,QAAQ,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,KAAK,OAAO,CAAA;IACxD,mBAAmB,EAAE,CACnB,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,WAAW,GAAG,IAAI,KACvB,OAAO,CAAA;IACZ,SAAS,EAAE,CACT,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,WAAW,GAAG,IAAI,KACvB,MAAM,IAAI,OAAO,CAAA;IACtB,UAAU,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,CAAA;IACxC,kBAAkB,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,OAAO,CAAA;IACnD,cAAc,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,OAAO,CAAA;IAC/C,6BAA6B,EAAE,CAC7B,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,WAAW,GAAG,IAAI,KACvB,OAAO,CAAA;IACZ,eAAe,EAAE,CACf,IAAI,EAAE,YAAY,EAClB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,KAClC,IAAI,CAAA;CACV;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,mBAAmB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,QAAQ,EAAE,GAAG,SAAS,CAAA;IAE/D;;OAEG;IACH,oBAAoB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IAE9C;;OAEG;IACH,IAAI,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAA;IAEnC;;OAEG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAA;IAEvC;;OAEG;IACH,wBAAwB,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,QAAQ,GAAG,UAAU,CAAA;IAExE;;OAEG;IACH,cAAc,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,KAAK,KAAK,CAAA;IAE1D;;OAEG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,KAAK,GAAG,CAAA;IAEjD;;OAEG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAA;IAEnD;;OAEG;IACH,KAAK,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAA;IAEpC;;OAEG;IACH,SAAS,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,MAAM,CAAA;IAE1C;;OAEG;IACH,UAAU,EAAE,CACV,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,KAC7B,OAAO,CAAA;IAEZ;;OAEG;IACH,iBAAiB,EAAE,CACjB,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,WAAW,GAAG,IAAI,KACvB,MAAM,IAAI,OAAO,CAAA;IAEtB;;OAEG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,KAAK,OAAO,CAAA;IAExD;;OAEG;IACH,mBAAmB,EAAE,CACnB,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,WAAW,GAAG,IAAI,KACvB,OAAO,CAAA;IAEZ;;OAEG;IACH,SAAS,EAAE,CACT,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,WAAW,GAAG,IAAI,KACvB,MAAM,IAAI,OAAO,CAAA;IAEtB;;OAEG;IACH,UAAU,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,KAAK,IAAI,CAAA;IAE7D;;OAEG;IACH,kBAAkB,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,KAAK,OAAO,CAAA;IAExE;;OAEG;IACH,cAAc,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,KAAK,OAAO,CAAA;IAEpE;;OAEG;IACH,WAAW,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAA;IAE7C;;OAEG;IACH,SAAS,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAA;IAE3C;;OAEG;IACH,UAAU,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAA;IAE5C;;OAEG;IACH,6BAA6B,EAAE,CAC7B,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,WAAW,GAAG,IAAI,KACvB,OAAO,CAAA;IAEZ;;OAEG;IACH,eAAe,EAAE,CACf,MAAM,EAAE,WAAW,EACnB,IAAI,EAAE,YAAY,EAClB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,KAClC,IAAI,CAAA;IAET;;OAEG;IACH,SAAS,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,KAAK,WAAW,CAAA;IAE3D;;OAEG;IACH,UAAU,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,KAAK,QAAQ,CAAA;IAE3D;;;;;;;OAOG;IACH,UAAU,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,KAAK,QAAQ,CAAA;IAE3D;;OAEG;IACH,WAAW,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;IAE5D;;OAEG;IACH,YAAY,EAAE,CAAC,CAAC,SAAS,OAAO,EAC9B,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,QAAQ,EAClB,OAAO,EAAE;QACP,UAAU,EAAE,OAAO,CAAA;QACnB,aAAa,EAAE,CAAC,CAAA;KACjB,KACE,CAAC,SAAS,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,CAAA;IAE1C;;OAEG;IACH,YAAY,EAAE,CAAC,CAAC,SAAS,OAAO,EAC9B,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,QAAQ,GAAG,cAAc,GAAG,YAAY,EAClD,OAAO,EAAE;QACP,UAAU,EAAE,OAAO,CAAA;QACnB,aAAa,EAAE,CAAC,CAAA;KACjB,KACE,CAAC,SAAS,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,CAAA;CAC3C;AAGD,eAAO,MAAM,WAAW,EAAE,oBAirBzB,CAAA"}