@yoopta/editor 4.8.5-rc.8 → 4.9.0

package/README.md

@@ -20,8 +20,11 @@ const plugins = [Paragraph];
 const Editor = () => {
   // create instance
   const editor: YooEditor = useMemo(() => createYooptaEditor(), []);
+  const [value, setValue] = useState();
 
-  return <YooptaEditor editor={editor} plugins={plugins} />;
+  const onChange = (newValue) => setValue(newValue);
+
+  return <YooptaEditor editor={editor} plugins={plugins} value={value} onChange={onChange} />;
 };
 ```
 
@@ -76,40 +79,48 @@ type Props = {
 ### Editor API
 
 ```tsx
-export type YooEditor<TNodes> = {
+export type YooEditor = {
   id: string;
-  // Method to check if editor is empty
-  // [NOTE] - Empty editor means the next: If the Editor has one block with the default type "Paragraph", and this block does not contain text content
-  isEmpty: () => boolean;
   readOnly: boolean;
-  insertBlock: (data: YooptaBlockData, options?: InsertBlockOptions) => void;
+  isEmpty: () => boolean;
+
+  // block handlers
+  insertBlock: WithoutFirstArg<typeof insertBlock>;
+  updateBlock: WithoutFirstArg<typeof updateBlock>;
+  deleteBlock: WithoutFirstArg<typeof deleteBlock>;
+  duplicateBlock: WithoutFirstArg<typeof duplicateBlock>;
+  toggleBlock: WithoutFirstArg<typeof toggleBlock>;
+  increaseBlockDepth: WithoutFirstArg<typeof increaseBlockDepth>;
+  decreaseBlockDepth: WithoutFirstArg<typeof decreaseBlockDepth>;
+  moveBlock: WithoutFirstArg<typeof moveBlock>;
+  focusBlock: WithoutFirstArg<typeof focusBlock>;
+  mergeBlock: () => void;
   splitBlock: (options?: SplitBlockOptions) => void;
-  updateBlock: (id: string, data: Partial<YooptaBlockData>) => void;
-  deleteBlock: (options?: DeleteBlockOptions) => void;
-  duplicateBlock: (options: DuplicateBlockOptions) => void;
-  toggleBlock: (toBlockType: string, options?: ToggleBlockOptions) => void;
-  increaseBlockDepth: (options?: BlockDepthOptions) => void;
-  decreaseBlockDepth: (options?: BlockDepthOptions) => void;
-  moveBlock: (blockId: string, to: YooptaPath) => void;
-  focusBlock: (id: string, options?: FocusBlockOptions) => void;
   getBlock: (options: GetBlockOptions) => YooptaBlockData | null;
-  selectedBlocks: number[] | null;
-  children: Record<string, YooptaBlockData>;
-  getEditorValue: () => TNodes;
-  setEditorValue: (value: YooptaContentValue) => void;
+
+  // path handlers
   path: YooptaPath;
-  setPath: (path: YooptaPath | null, options?: SetSelectionOptions) => void;
+  setPath: (path: YooptaPath) => void;
+
+  children: YooptaContentValue;
+  getEditorValue: () => YooptaContentValue;
+  setEditorValue: WithoutFirstArg<typeof setEditorValue>;
   blockEditorsMap: YooptaPluginsEditorMap;
   blocks: YooptaBlocks;
   formats: YooptaFormats;
   shortcuts: Record<string, YooptaBlock>;
-  plugins: Record<string, Plugin<string, unknown>>;
+  plugins: Record<string, Plugin<Record<string, SlateElement>, unknown>>;
+  commands: Record<string, (...args: any[]) => any>;
+
+  // core handlers
+  applyTransforms: WithoutFirstArg<typeof applyTransforms>;
+  batchOperations: (fn: () => void) => void;
 
   // events handlers
-  on: (event: YooptaEditorEventKeys, fn: (payload: any) => void) => void;
-  once: (event: YooptaEditorEventKeys, fn: (payload: any) => void) => void;
-  off: (event: YooptaEditorEventKeys, fn: (payload: any) => void) => void;
-  emit: (event: YooptaEditorEventKeys, payload: any) => void;
+  on: <K extends keyof YooptaEventsMap>(event: K, fn: (payload: YooptaEventsMap[K]) => void) => void;
+  once: <K extends keyof YooptaEventsMap>(event: K, fn: (payload: YooptaEventsMap[K]) => void) => void;
+  off: <K extends keyof YooptaEventsMap>(event: K, fn: (payload: YooptaEventsMap[K]) => void) => void;
+  emit: <K extends keyof YooptaEventsMap>(event: K, payload: YooptaEventsMap[K]) => void;
 
   // focus handlers
   isFocused: () => boolean;
@@ -121,6 +132,17 @@ export type YooEditor<TNodes> = {
   getMarkdown: (content: YooptaContentValue) => string;
   getPlainText: (content: YooptaContentValue) => string;
 
+  // history
+  historyStack: Record<HistoryStackName, HistoryStack[]>;
+  isSavingHistory: WithoutFirstArg<typeof YooptaHistory.isSavingHistory>;
+  isMergingHistory: WithoutFirstArg<typeof YooptaHistory.isMergingHistory>;
+  withoutSavingHistory: WithoutFirstArg<typeof YooptaHistory.withoutSavingHistory>;
+  withoutMergingHistory: WithoutFirstArg<typeof YooptaHistory.withoutMergingHistory>;
+  withMergingHistory: WithoutFirstArg<typeof YooptaHistory.withMergingHistory>;
+  withSavingHistory: WithoutFirstArg<typeof YooptaHistory.withSavingHistory>;
+  redo: WithoutFirstArg<typeof YooptaHistory.redo>;
+  undo: WithoutFirstArg<typeof YooptaHistory.undo>;
+
   // ref to editor element
   refElement: HTMLElement | null;
 };

package/dist/components/Block/Block.d.ts

@@ -4,7 +4,8 @@ type BlockProps = {
     children: React.ReactNode;
     block: YooptaBlockData;
     blockId: string;
+    onActiveDragHandleChange: (props: any) => void;
 };
-declare const Block: ({ children, block, blockId }: BlockProps) => import("react/jsx-runtime").JSX.Element;
+declare const Block: React.MemoExoticComponent<({ children, block, blockId, onActiveDragHandleChange }: BlockProps) => import("react/jsx-runtime").JSX.Element>;
 export { Block };
 //# sourceMappingURL=Block.d.ts.map

package/dist/components/Block/Block.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Block.d.ts","sourceRoot":"","sources":["../../../src/components/Block/Block.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA+B,MAAM,OAAO,CAAC;AAIpD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAIrD,KAAK,UAAU,GAAG;IAChB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,KAAK,EAAE,eAAe,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,QAAA,MAAM,KAAK,iCAAkC,UAAU,4CAmDtD,CAAC;AAEF,OAAO,EAAE,KAAK,EAAE,CAAC"}
+{"version":3,"file":"Block.d.ts","sourceRoot":"","sources":["../../../src/components/Block/Block.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAe,MAAM,OAAO,CAAC;AAGpC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAIrD,KAAK,UAAU,GAAG;IAChB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,KAAK,EAAE,eAAe,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,wBAAwB,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;CAChD,CAAC;AAEF,QAAA,MAAM,KAAK,qFAAiE,UAAU,6CAmCpF,CAAC;AAIH,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/dist/components/Block/FloatingBlockActions.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="react" />
+import { YooEditor } from '../../editor/types';
+type dragHandleProps = {
+    attributes: any;
+    listeners: any;
+    setActivatorNodeRef: any;
+};
+type FloatingBlockActionsProps = {
+    editor: YooEditor;
+    dragHandleProps: dragHandleProps | null;
+};
+export declare const FloatingBlockActions: import("react").MemoExoticComponent<({ editor, dragHandleProps }: FloatingBlockActionsProps) => import("react/jsx-runtime").JSX.Element>;
+export {};
+//# sourceMappingURL=FloatingBlockActions.d.ts.map

package/dist/components/Block/FloatingBlockActions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FloatingBlockActions.d.ts","sourceRoot":"","sources":["../../../src/components/Block/FloatingBlockActions.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAmB,MAAM,oBAAoB,CAAC;AAehE,KAAK,eAAe,GAAG;IACrB,UAAU,EAAE,GAAG,CAAC;IAChB,SAAS,EAAE,GAAG,CAAC;IACf,mBAAmB,EAAE,GAAG,CAAC;CAC1B,CAAC;AAEF,KAAK,yBAAyB,GAAG;IAC/B,MAAM,EAAE,SAAS,CAAC;IAClB,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;CACzC,CAAC;AAoBF,eAAO,MAAM,oBAAoB,oEAAsC,yBAAyB,6CAsL9F,CAAC"}