slate-react 0.115.0 → 0.116.0

package/dist/hooks/use-slate-selector.d.ts

@@ -1,32 +1,47 @@
 /// <reference types="react" />
 import { Editor } from 'slate';
-type EditorChangeHandler = (editor: Editor) => void;
+type Callback = () => void;
+export interface SlateSelectorOptions {
+    /**
+     * If true, defer calling the selector function until after `Editable` has
+     * finished rendering. This ensures that `ReactEditor.findPath` won't return
+     * an outdated path if called inside the selector.
+     */
+    deferred?: boolean;
+}
 /**
- * A React context for sharing the editor selector context in a way to control rerenders
+ * A React context for sharing the editor selector context in a way to control
+ * re-renders.
  */
 export declare const SlateSelectorContext: import("react").Context<{
-    getSlate: () => Editor;
-    addEventListener: (callback: EditorChangeHandler) => () => void;
+    addEventListener: (callback: Callback, options?: SlateSelectorOptions) => () => void;
+    flushDeferred: () => void;
 }>;
 /**
- * use redux style selectors to prevent rerendering on every keystroke.
- * Bear in mind rerendering can only prevented if the returned value is a value type or for reference types (e.g. objects and arrays) add a custom equality function.
+ * Use redux style selectors to prevent re-rendering on every keystroke.
  *
- * Example:
- * ```
- *  const isSelectionActive = useSlateSelector(editor => Boolean(editor.selection));
- * ```
+ * Bear in mind re-rendering can only prevented if the returned value is a value
+ * type or for reference types (e.g. objects and arrays) add a custom equality
+ * function.
+ *
+ * If `selector` is memoized using `useCallback`, then it will only be called
+ * when it or the editor state changes. Otherwise, `selector` will be called
+ * every time the component renders.
+ *
+ * @example
+ * const isSelectionActive = useSlateSelector(editor => Boolean(editor.selection))
  */
-export declare function useSlateSelector<T>(selector: (editor: Editor) => T, equalityFn?: (a: T, b: T) => boolean): T;
+export declare function useSlateSelector<T>(selector: (editor: Editor) => T, equalityFn?: (a: T | null, b: T) => boolean, { deferred }?: SlateSelectorOptions): T;
 /**
  * Create selector context with editor updating on every editor change
  */
-export declare function useSelectorContext(editor: Editor): {
+export declare function useSelectorContext(): {
     selectorContext: {
-        getSlate: () => import("..").ReactEditor;
-        addEventListener: (callback: EditorChangeHandler) => () => void;
+        addEventListener: (callbackProp: Callback, { deferred }?: SlateSelectorOptions) => () => void;
+        flushDeferred: () => void;
     };
-    onChange: (editor: Editor) => void;
+    onChange: () => void;
 };
+export declare function useFlushDeferredSelectorsOnRender(): void;
 export {};
 //# sourceMappingURL=use-slate-selector.d.ts.map

package/dist/hooks/use-slate-selector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-slate-selector.d.ts","sourceRoot":"","sources":["../../../../packages/slate-react/src/hooks/use-slate-selector.tsx"],"names":[],"mappings":";AAQA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAA;AAO9B,KAAK,mBAAmB,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;AACnD;;GAEG;AAEH,eAAO,MAAM,oBAAoB;cACrB,MAAM,MAAM;iCACO,mBAAmB,KAAK,MAAM,IAAI;EACpD,CAAA;AAIb;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,EAC/B,UAAU,GAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,OAAqB,KAiFlD;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM;;;qCAoBd,mBAAmB;;uBAZzC,MAAM;EAqBlB"}
+{"version":3,"file":"use-slate-selector.d.ts","sourceRoot":"","sources":["../../../../packages/slate-react/src/hooks/use-slate-selector.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAA;AAK9B,KAAK,QAAQ,GAAG,MAAM,IAAI,CAAA;AAE1B,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;GAGG;AAEH,eAAO,MAAM,oBAAoB;iCAEnB,QAAQ,YACR,oBAAoB,KAC3B,MAAM,IAAI;mBACA,MAAM,IAAI;EACd,CAAA;AAIb;;;;;;;;;;;;;GAaG;AAEH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,EAC/B,UAAU,GAAE,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,CAAC,KAAK,OAAqB,EACxD,EAAE,QAAQ,EAAE,GAAE,oBAAyB,GACtC,CAAC,CA0BH;AAED;;GAEG;AACH,wBAAgB,kBAAkB;;yCAed,QAAQ,iBACA,oBAAoB;;;;EAwB/C;AAED,wBAAgB,iCAAiC,SAGhD"}

package/dist/hooks/use-slate.d.ts

@@ -1,22 +1,15 @@
-/// <reference types="react" />
 import { Editor } from 'slate';
-import { ReactEditor } from '../plugin/react-editor';
 /**
- * A React context for sharing the editor object, in a way that re-renders the
- * context whenever changes occur.
+ * Get the current editor object and re-render whenever it changes.
  */
-export interface SlateContextValue {
-    v: number;
-    editor: ReactEditor;
-}
-export declare const SlateContext: import("react").Context<{
-    v: number;
-    editor: ReactEditor;
-} | null>;
+export declare const useSlate: () => Editor;
 /**
- * Get the current editor object from the React context.
+ * Get the current editor object and its version, which increments on every
+ * change.
+ *
+ * @deprecated The `v` counter is no longer used except for this hook, and may
+ * be removed in a future version.
  */
-export declare const useSlate: () => Editor;
 export declare const useSlateWithV: () => {
     editor: Editor;
     v: number;

package/dist/hooks/use-slate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-slate.d.ts","sourceRoot":"","sources":["../../../../packages/slate-react/src/hooks/use-slate.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAA;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAEpD;;;GAGG;AAEH,MAAM,WAAW,iBAAiB;IAChC,CAAC,EAAE,MAAM,CAAA;IACT,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,eAAO,MAAM,YAAY;OACpB,MAAM;YACD,WAAW;SACN,CAAA;AAEf;;GAEG;AAEH,eAAO,MAAM,QAAQ,QAAO,MAW3B,CAAA;AAED,eAAO,MAAM,aAAa,QAAO;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAU3D,CAAA"}
+{"version":3,"file":"use-slate.d.ts","sourceRoot":"","sources":["../../../../packages/slate-react/src/hooks/use-slate.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAA;AAK9B;;GAEG;AAEH,eAAO,MAAM,QAAQ,QAAO,MAgB3B,CAAA;AAyBD;;;;;;GAMG;AAEH,eAAO,MAAM,aAAa;YAAiB,MAAM;OAAK,MAAM;CAI3D,CAAA"}

package/dist/index.d.ts

@@ -1,9 +1,10 @@
-export { Editable, RenderElementProps, RenderLeafProps, RenderPlaceholderProps, DefaultPlaceholder, } from './components/editable';
+export { Editable, RenderElementProps, RenderChunkProps, RenderLeafProps, RenderPlaceholderProps, DefaultPlaceholder, } from './components/editable';
 export { DefaultElement } from './components/element';
 export { DefaultText } from './components/text';
 export { DefaultLeaf } from './components/leaf';
 export { Slate } from './components/slate';
 export { useEditor } from './hooks/use-editor';
+export { useElement, useElementIf } from './hooks/use-element';
 export { useSlateStatic } from './hooks/use-slate-static';
 export { useComposing } from './hooks/use-composing';
 export { useFocused } from './hooks/use-focused';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,QAAQ,EACR,kBAAkB,EAClB,eAAe,EACf,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,uBAAuB,CAAA;AAE9B,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAG1C,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAA;AAG/D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAG/C,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,QAAQ,EACR,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,uBAAuB,CAAA;AAE9B,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAG1C,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAA;AAG/D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAG/C,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA"}