@udecode/plate-core - npm Package Compare versions

Comparing version 21.4.2 to 21.5.0

dist/components/index.d.ts

@@ -5,2 +5,3 @@ /**
 export * from './DefaultLeaf';
+export * from './EditorMethodsEffect';
 export * from './EditorRefEffect';
@@ -7,0 +8,0 @@ export * from './EditorStateEffect';

dist/hooks/usePlateEffects.d.ts

@@ -0,1 +1,2 @@
+import { ForwardedRef } from 'react';
 import { Value } from '@udecode/slate';
@@ -26,2 +27,6 @@ import { Nullable, PlateEditor, PlatePlugin, PlateStoreState, PluginOptions, TEditableProps } from '../types';
     onChange?: (value: V) => void;
+    /**
+     * Access the editor object using a React ref.
+     */
+    editorRef?: ForwardedRef<E>;
     decorate?: TEditableProps<V>['decorate'];
@@ -31,3 +36,3 @@ renderElement?: TEditableProps<V>['renderElement'];
 }>;
-export declare const usePlateEffects: <V extends Value = Value, E extends PlateEditor<V> = PlateEditor<V>>({ id, disableCorePlugins, value: valueProp, onChange: onChangeProp, plugins: pluginsProp, decorate: decorateProp, renderElement: renderElementProp, renderLeaf: renderLeafProp, readOnly: readOnlyProp, }: UsePlateEffectsProps<V, E>) => void;
+export declare const usePlateEffects: <V extends Value = Value, E extends PlateEditor<V> = PlateEditor<V>>({ id, disableCorePlugins, value: valueProp, onChange: onChangeProp, plugins: pluginsProp, editorRef: editorRefProp, decorate: decorateProp, renderElement: renderElementProp, renderLeaf: renderLeafProp, readOnly: readOnlyProp, }: UsePlateEffectsProps<V, E>) => void;
 //# sourceMappingURL=usePlateEffects.d.ts.map

dist/plugins/withPlate.d.ts

@@ -29,3 +29,3 @@ /// <reference types="react" />
     getDirtyPaths: <N_8 extends import("@udecode/slate").TDescendant>(operation: import("@udecode/slate").TOperation<N_8>) => import("slate").Path[];
-} & import("@udecode/utils").UnknownObject & Pick<import("slate-history").HistoryEditor, "history" | "undo" | "redo"> & Pick<import("slate-react").ReactEditor, "insertData" | "insertFragmentData" | "insertTextData" | "setFragmentData" | "hasRange" | "hasTarget" | "hasEditableTarget" | "hasSelectableTarget" | "isTargetInsideNonReadonlyVoid"> & {
+} & import("@udecode/utils").UnknownObject & Pick<import("slate-history").HistoryEditor, "history" | "undo" | "redo"> & Pick<import("slate-react").ReactEditor, "insertData" | "insertFragmentData" | "insertTextData" | "setFragmentData" | "hasRange" | "hasTarget" | "hasEditableTarget" | "hasSelectableTarget" | "isTargetInsideNonReadonlyVoid"> & import("..").PlateEditorMethods<V> & {
     key: any;
@@ -52,3 +52,3 @@ plugins: import("..").WithPlatePlugin<{}, V, PlateEditor<V>>[];
     getDirtyPaths: <N_8 extends import("@udecode/slate").TDescendant>(operation: import("@udecode/slate").TOperation<N_8>) => import("slate").Path[];
-} & import("@udecode/utils").UnknownObject & Pick<import("slate-history").HistoryEditor, "history" | "undo" | "redo"> & Pick<import("slate-react").ReactEditor, "insertData" | "insertFragmentData" | "insertTextData" | "setFragmentData" | "hasRange" | "hasTarget" | "hasEditableTarget" | "hasSelectableTarget" | "isTargetInsideNonReadonlyVoid"> & {
+} & import("@udecode/utils").UnknownObject & Pick<import("slate-history").HistoryEditor, "history" | "undo" | "redo"> & Pick<import("slate-react").ReactEditor, "insertData" | "insertFragmentData" | "insertTextData" | "setFragmentData" | "hasRange" | "hasTarget" | "hasEditableTarget" | "hasSelectableTarget" | "isTargetInsideNonReadonlyVoid"> & import("..").PlateEditorMethods<V> & {
     key: any;
@@ -55,0 +55,0 @@ plugins: import("..").WithPlatePlugin<{}, V, PlateEditor<V>>[];

dist/stores/plate/createPlateStore.d.ts

@@ -0,1 +1,2 @@
+/// <reference types="react" />
 import { Value } from '@udecode/slate';
@@ -41,3 +42,3 @@ import { GetRecord, SetRecord, UseRecord } from '../../atoms/index';
 export declare const usePlateId: () => string;
-export declare const createPlateStore: <V extends Value = Value, E extends PlateEditor<V> = PlateEditor<V>>({ decorate, editor, id, isRendered, keyDecorate, keyEditor, keySelection, onChange, plugins, rawPlugins, readOnly, renderElement, renderLeaf, value, ...state }?: Partial<PlateStoreState<V, E>>) => {
+export declare const createPlateStore: <V extends Value = Value, E extends PlateEditor<V> = PlateEditor<V>>({ decorate, editor, id, isRendered, keyDecorate, keyEditor, keySelection, onChange, editorRef, plugins, rawPlugins, readOnly, renderElement, renderLeaf, value, ...state }?: Partial<PlateStoreState<V, E>>) => {
     plateStore: {
@@ -58,2 +59,5 @@ atom: {
             } | null>;
+            editorRef: import("jotai").Atom<{
+                ref: import("react").ForwardedRef<E>;
+            } | null>;
             decorate: import("jotai").Atom<{
@@ -85,2 +89,5 @@ fn: (entry: import("@udecode/slate").ENodeEntry<V>) => import("slate").BaseRange[];
             };
+            editorRef: {
+                ref: import("react").ForwardedRef<E>;
+            };
             decorate: {
@@ -113,2 +120,5 @@ fn: (entry: import("@udecode/slate").ENodeEntry<V>) => import("slate").BaseRange[];
             };
+            editorRef: {
+                ref: import("react").ForwardedRef<E>;
+            };
             decorate: {
@@ -139,2 +149,5 @@ fn: (entry: import("@udecode/slate").ENodeEntry<V>) => import("slate").BaseRange[];
             };
+            editorRef: {
+                ref: import("react").ForwardedRef<E>;
+            };
             decorate: {
@@ -165,2 +178,5 @@ fn: (entry: import("@udecode/slate").ENodeEntry<V>) => import("slate").BaseRange[];
             };
+            editorRef: {
+                ref: import("react").ForwardedRef<E>;
+            };
             decorate: {
@@ -193,2 +209,5 @@ fn: (entry: import("@udecode/slate").ENodeEntry<V>) => import("slate").BaseRange[];
         } | null>;
+        editorRef: import("jotai").Atom<{
+            ref: import("react").ForwardedRef<PlateEditor<Value>>;
+        } | null>;
         decorate: import("jotai").Atom<{
@@ -220,2 +239,5 @@ fn: (entry: import("@udecode/slate").ENodeEntry<Value>) => import("slate").BaseRange[];
         };
+        editorRef: {
+            ref: import("react").ForwardedRef<PlateEditor<Value>>;
+        };
         decorate: {
@@ -247,2 +269,5 @@ fn: (entry: import("@udecode/slate").ENodeEntry<Value>) => import("slate").BaseRange[];
         };
+        editorRef: {
+            ref: import("react").ForwardedRef<PlateEditor<Value>>;
+        };
         decorate: {
@@ -273,2 +298,5 @@ fn: (entry: import("@udecode/slate").ENodeEntry<Value>) => import("slate").BaseRange[];
         };
+        editorRef: {
+            ref: import("react").ForwardedRef<PlateEditor<Value>>;
+        };
         decorate: {
@@ -299,2 +327,5 @@ fn: (entry: import("@udecode/slate").ENodeEntry<Value>) => import("slate").BaseRange[];
         };
+        editorRef: {
+            ref: import("react").ForwardedRef<PlateEditor<Value>>;
+        };
         decorate: {
@@ -301,0 +332,0 @@ fn: (entry: import("@udecode/slate").ENodeEntry<Value>) => import("slate").BaseRange[];

dist/types/index.d.ts

@@ -6,2 +6,3 @@ /**
 export * from './PlateEditor';
+export * from './PlateEditorMethods';
 export * from './PlateRenderElementProps';
@@ -8,0 +9,0 @@ export * from './PlateRenderLeafProps';

dist/types/PlateEditor.d.ts

@@ -7,3 +7,4 @@ import { KeyboardEvent } from 'react';
 import { PluginKey } from './plugin/PlatePluginKey';
-export declare type PlateEditor<V extends Value = Value> = TEditor<V> & THistoryEditor<V> & TReactEditor<V> & {
+import { PlateEditorMethods } from './PlateEditorMethods';
+export declare type PlateEditor<V extends Value = Value> = TEditor<V> & THistoryEditor<V> & TReactEditor<V> & PlateEditorMethods<V> & {
     key: any;
@@ -10,0 +11,0 @@ plugins: WithPlatePlugin<{}, V>[];

dist/types/PlateStore.d.ts

@@ -0,1 +1,2 @@
+import { ForwardedRef } from 'react';
 import { Value } from '@udecode/slate';
@@ -58,2 +59,8 @@ import { PlateId } from '../stores';
     };
+    /**
+     * Access the editor object using a React ref.
+     */
+    editorRef: {
+        ref: ForwardedRef<E>;
+    };
     decorate: {
@@ -69,2 +76,3 @@ fn: NonNullable<TEditableProps<V>['decorate']>;
 }>;
+export declare const EXPOSED_STORE_KEYS: (keyof PlateStoreState)[];
 //# sourceMappingURL=PlateStore.d.ts.map

dist/utils/createPlateEditor.d.ts

@@ -55,3 +55,3 @@ /// <reference types="react" />
     getDirtyPaths: <N_8 extends import("@udecode/slate").TDescendant>(operation: import("@udecode/slate").TOperation<N_8>) => import("slate").Path[];
-} & import("@udecode/utils").UnknownObject & Pick<import("slate-history").HistoryEditor, "history" | "undo" | "redo"> & Pick<import("slate-react").ReactEditor, "insertData" | "insertFragmentData" | "insertTextData" | "setFragmentData" | "hasRange" | "hasTarget" | "hasEditableTarget" | "hasSelectableTarget" | "isTargetInsideNonReadonlyVoid"> & {
+} & import("@udecode/utils").UnknownObject & Pick<import("slate-history").HistoryEditor, "history" | "undo" | "redo"> & Pick<import("slate-react").ReactEditor, "insertData" | "insertFragmentData" | "insertTextData" | "setFragmentData" | "hasRange" | "hasTarget" | "hasEditableTarget" | "hasSelectableTarget" | "isTargetInsideNonReadonlyVoid"> & import("..").PlateEditorMethods<V> & {
     key: any;
@@ -58,0 +58,0 @@ plugins: import("../types/plugin/PlatePlugin").WithPlatePlugin<{}, V, PlateEditor<V>>[];

package.json

 {
   "name": "@udecode/plate-core",
-  "version": "21.4.2",
+  "version": "21.5.0",
   "description": "The core architecture of Plate – a plugin system for slate",
@@ -5,0 +5,0 @@ "license": "MIT",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1825060

increased by1.47%

Number of package files

380

increased by1.6%

Lines of code

18352

increased by1.12%

Worsened metrics

Published versions last two months

16

decreased by-5.88%

No dependency changes