@yoopta/editor 2.0.1 → 4.0.0-rc.0

package/dist/contexts/YooptaContext/YooptaContext.d.ts

@@ -1,54 +0,0 @@
-import { ReactElement, ReactNode } from 'react';
-import { YooptaBaseElement, YooptaTools } from '../../types';
-import { YooptaPluginType } from '../../utils/plugins';
-import { YooptaMark } from '../../utils/marks';
-export type HoveredElement = YooptaBaseElement<string> | null;
-type YooptaToolsMap = {
-    Toolbar: (props: any) => ReactElement;
-    ActionMenu: (props: any) => ReactElement;
-    ChatGPT: (props: any) => ReactElement;
-    LinkTool: (props: any) => ReactElement;
-    [x: string]: (props: any) => ReactElement;
-};
-export type YooptaContextReturnValues = {
-    marks: MarksMap;
-    elements: ElementsMap;
-    tools?: YooptaToolsMap | undefined;
-};
-export type YooptaContextHandlers = {};
-export type YooptaContextType = YooptaContextReturnValues;
-type Props = {
-    children: ReactNode;
-    plugins: Omit<YooptaPluginType, 'childPlugin'>[];
-    marks?: YooptaMark[];
-    tools?: YooptaTools | undefined;
-};
-export type ToggleOptions = {
-    shouldDeleteText: boolean;
-};
-export type ElementsMap = {
-    [x: string]: {
-        type: YooptaPluginType['type'];
-        create: YooptaPluginType['createElement'];
-        define: YooptaPluginType['defineElement'];
-        toggle: (options?: ToggleOptions) => void;
-        isActive: boolean;
-        options: {
-            displayLabel?: string;
-        };
-    };
-};
-export type MarksMap = {
-    [x: string]: {
-        toggle: (options?: {
-            only: boolean;
-        }) => void;
-        isActive: boolean;
-    };
-};
-declare const YooptaContextProvider: ({ children, plugins: pluginList, marks: markList, tools }: Props) => JSX.Element;
-declare const useYoopta: () => YooptaContextReturnValues;
-declare const useMarks: () => MarksMap;
-declare const useElements: () => ElementsMap;
-declare const useTools: () => YooptaToolsMap | undefined;
-export { YooptaContextProvider, useYoopta, useMarks, useElements, useTools };

package/dist/hooks/useDragDrop.d.ts

@@ -1,25 +0,0 @@
-import { DragEvent } from 'react';
-import { Node, NodeEntry } from 'slate';
-import { YooEditor, YooptaBaseElement } from '../types';
-export type DraggedNode = {
-    path: number[] | null;
-    element: Pick<YooptaBaseElement<string>, 'id' | 'type'> | null;
-    parent: NodeEntry<Node> | null;
-};
-export type DndState = {
-    from: DraggedNode;
-    to: DraggedNode;
-};
-export type DragDropValues = {
-    dndState: DndState;
-    disableWhileDrag: boolean;
-    DRAG_MAP: Map<YooptaBaseElement<string>['id'], YooptaBaseElement<string>>;
-};
-export type DragDropHandlers = {
-    onDrop: (_e: DragEvent<HTMLDivElement>) => void;
-    onDragEnter: (_e: DragEvent<HTMLDivElement>) => void;
-    onDragEnd: (_e: any) => void;
-    onDragStart: (_e: any, from: DraggedNode) => void;
-};
-export declare const DEFAULT_DRAG_STATE: DndState;
-export declare const useDragDrop: (editor: YooEditor) => [DragDropValues, DragDropHandlers];

package/dist/hooks/useHover.d.ts

@@ -1,2 +0,0 @@
-import { RefObject } from 'react';
-export declare function useHover<T extends HTMLElement>(): [RefObject<T>, boolean];

package/dist/hooks/useIntersetionObserver.d.ts

@@ -1,12 +0,0 @@
-/**
- *
- * @param {DOM Ref} elementRef - DOM ref for checking the intersection
- * @param {Observer Params} - https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API
- * @returns {IntersectionObserverEntry} - https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserverEntry
- */
-export declare function useIntersectionObserver(elementRef: any, { threshold, root, rootMargin, freezeOnceVisible }?: {
-    threshold?: number | undefined;
-    root?: null | undefined;
-    rootMargin?: string | undefined;
-    freezeOnceVisible?: boolean | undefined;
-}): IntersectionObserverEntry | Record<string, unknown>;

package/dist/hooks/useScrollToElement.d.ts

@@ -1 +0,0 @@
-export declare const useScrollToElement: () => null;

package/dist/types.d.ts

@@ -1,53 +0,0 @@
-import { BaseEditor, BaseElement } from 'slate';
-import { ReactEditor, RenderElementProps as ElementProps } from 'slate-react';
-import { HistoryEditor } from 'slate-history';
-import { YooptaPluginType, YooptaRenderHTMLAttributes } from './utils/plugins';
-import { CSSProperties, ReactNode } from 'react';
-export type EmptyText = {
-    text: string;
-};
-export type YooptaElementConfig = {
-    nodeType: 'block' | 'inline' | 'void';
-};
-export type Modify<T, R> = Omit<T, keyof R> & R;
-export type YooptaBaseElement<T> = {
-    id: string;
-    type: T;
-    children: BaseElement['children'];
-    data?: any;
-} & YooptaElementConfig;
-export type RenderYooptaElementProps<T extends BaseElement = BaseElement> = ElementProps & {
-    element: T;
-} & YooptaRenderHTMLAttributes;
-export type YooptaEditorValue<V> = V[];
-export type YooptaBaseToolEvents = {
-    [x: string]: (...args: any) => void;
-};
-export type YooptaBaseToolProps<P extends YooptaPluginType = YooptaPluginType, Events extends YooptaBaseToolEvents = YooptaBaseToolEvents> = {
-    style?: CSSProperties;
-    className?: string;
-    plugins?: P[];
-    fromHook?: boolean;
-    on?: Events;
-};
-export interface YooEditor extends BaseEditor, ReactEditor, HistoryEditor {
-    shortcuts: Record<string, YooptaPluginType>;
-    plugins: Record<YooptaBaseElement<string>['type'], YooptaPluginType<any, YooptaBaseElement<string>>>;
-}
-export type YooptaNodeElementSettings = {
-    options?: {
-        handlers?: {
-            onCopy?: () => void;
-            onDelete?: () => void;
-            onDuplicate?: () => void;
-        };
-    };
-    drag?: boolean;
-    plus?: boolean;
-};
-export type YooptaTools = {
-    ActionMenu?: ReactNode;
-    Toolbar?: ReactNode;
-    ChatGPT?: ReactNode;
-    [x: string]: ReactNode;
-};

package/dist/utils/deserializeHTML.d.ts

@@ -1,4 +0,0 @@
-import { YooptaBaseElement } from '../types';
-import { YooptaPluginType } from './plugins';
-export declare function mergePluginTypesToMapHMTLNodeName(plugins: Record<YooptaBaseElement<string>['type'], YooptaPluginType<any, YooptaBaseElement<string>>>): Record<YooptaBaseElement<string>['type'], YooptaPluginType<any, YooptaBaseElement<string>>>;
-export declare function deserializeHtml(htmlString: string, plugins: Record<YooptaBaseElement<string>['type'], YooptaPluginType<any, YooptaBaseElement<string>>>): any;

package/dist/utils/getElementClassname.d.ts

@@ -1,8 +0,0 @@
-import { HTMLAttributes } from 'react';
-type Params<T> = {
-    element: T;
-    HTMLAttributes?: HTMLAttributes<HTMLElement>;
-    className: string;
-};
-export declare function getElementClassname<T>(params: Params<T>): string;
-export {};

package/dist/utils/marks.d.ts

@@ -1,14 +0,0 @@
-/// <reference types="react" />
-import { RenderLeafProps } from 'slate-react';
-export type YooptaMark = {
-    type: string;
-    hotkey?: string;
-    render: (props: RenderLeafProps) => JSX.Element;
-};
-export type YooptaMarksConfig = {
-    type: string;
-    className: string;
-    hotkey?: string;
-    as?: string;
-};
-export declare function createYooptaMark({ type, hotkey, className, as }: YooptaMarksConfig): YooptaMark;

package/dist/utils/nodes.d.ts

@@ -1,5 +0,0 @@
-import { Path } from 'slate';
-import { YooEditor } from '../types';
-export declare const getMatchedNode: (editor: YooEditor, type: string) => false | import("slate").NodeEntry<import("slate").Node>;
-export declare const isElementActive: (editor: YooEditor, type: string) => boolean;
-export declare const getElementByPath: (editor: YooEditor, path?: Path, mode?: 'all' | 'highest' | 'lowest') => any;

package/dist/utils/plugins.d.ts

@@ -1,102 +0,0 @@
-import { HTMLAttributes, ReactElement } from 'react';
-import { Element, NodeEntry, Range } from 'slate';
-import { RenderLeafProps } from 'slate-react';
-import { YooEditor, RenderYooptaElementProps, YooptaBaseElement } from '../types';
-import { EditorEventHandlers } from '../types/eventHandlers';
-import { HOTKEYS_TYPE } from './hotkeys';
-export type HandlersOptions = {
-    hotkeys: HOTKEYS_TYPE;
-    defaultNode: Element;
-};
-export type DecoratorFn = (nodeEntry: NodeEntry) => Range[];
-export type YooptaPluginEventHandlers = {
-    [key in keyof EditorEventHandlers]: (editor: YooEditor, options: HandlersOptions) => EditorEventHandlers[key] | void;
-};
-export type YooptaPluginBaseOptions = YooptaRenderHTMLAttributes & {
-    searchString?: string;
-    displayLabel?: string;
-};
-export type YooptaRenderElementFunc<P extends YooptaBaseElement<string> = YooptaBaseElement<string>> = (editor: YooEditor, plugin: YooptaPluginType) => (props: RenderYooptaElementProps<P> & YooptaRenderHTMLAttributes) => ReactElement;
-export type YooptaRender<P extends YooptaBaseElement<string>> = YooptaRenderElementFunc<P>;
-export type ExtendedYooptaRender<P extends YooptaBaseElement<string>> = {
-    editor: YooptaRenderElementFunc<P>;
-    render: (props: RenderYooptaElementProps<P> & YooptaRenderHTMLAttributes) => ReactElement;
-};
-export type YooptaRenderHTMLAttributes = {
-    HTMLAttributes?: HTMLAttributes<HTMLElement>;
-};
-export type YooptaRenderer<P extends YooptaBaseElement<string>> = ExtendedYooptaRender<P> | YooptaRender<P>;
-type DeserializeHTML = {
-    nodeName: string | string[];
-    parse?: (el: HTMLElement) => any | null;
-};
-type Serializes<T, S> = {
-    serialize?: (node: T, text: string) => string;
-    deserialize?: S;
-};
-type Exports<T> = {
-    html: Serializes<T, DeserializeHTML>;
-    markdown: Serializes<T, {
-        mark: string;
-        parse: (mark: any) => any;
-    }>;
-};
-export type YooptaPluginType<O extends YooptaPluginBaseOptions = YooptaPluginBaseOptions, P extends YooptaBaseElement<string> = YooptaBaseElement<string>> = {
-    /**
-     * The type of the plugin and element.
-     */
-    type: string;
-    /**
-     * The plugin's renderer which can be .
-     */
-    renderer: YooptaRenderer<P>;
-    /**
-     * The element placeholder.
-     */
-    placeholder?: string | null;
-    /**
-     * The element's shortcuts.
-     */
-    shortcut?: string | string[];
-    /**
-     * The element's exports which contain rules for deserializers and serializers for plain text([WIP]) html, markdown.
-     */
-    exports?: Exports<P>;
-    /**
-     * The element's events: onKeyDown, onCopy and etc.
-     */
-    events?: YooptaPluginEventHandlers;
-    /**
-     * The element's options object that can be extended with custom options for your plugin
-     * Default options: HTMLAttributes
-     */
-    options?: O;
-    /**
-     *
-     * @param editor
-     * @returns
-     */
-    extendEditor?: (editor: YooEditor) => YooEditor;
-    /**
-     * Slate decorator for text ranges. Check docs: https://docs.slatejs.org/concepts/09-rendering#decorations
-     */
-    decorator?: (editor: YooEditor) => DecoratorFn;
-    /** Slate leaves. Check docs: https://docs.slatejs.org/concepts/09-rendering#decorations */
-    leaf?: (editor: YooEditor) => (props: RenderLeafProps) => any;
-    /** Useful key for plugins which contain children as plugin. For example NumberedList contain childPlugin ListItem */
-    childPlugin?: YooptaPlugin<any, any>;
-    hasParent?: boolean;
-    createElement?: (editor: YooEditor, elementData?: Partial<P>) => void;
-    defineElement: () => P;
-};
-export type ParentYooptaPlugin = Omit<YooptaPluginType, 'childPlugin' | 'hasParent'>;
-export declare class YooptaPlugin<O extends YooptaPluginBaseOptions, P extends YooptaBaseElement<string>> {
-    #private;
-    constructor(inputPlugin: YooptaPluginType<O, P>);
-    extend(overrides: Partial<Pick<YooptaPluginType<O, P>, 'type' | 'renderer' | 'placeholder' | 'shortcut' | 'exports' | 'events' | 'options' | 'extendEditor'>>): YooptaPlugin<O, P>;
-    get getPlugin(): YooptaPluginType<O, P>;
-}
-export declare function createYooptaPlugin<O extends YooptaPluginBaseOptions, P extends YooptaBaseElement<string>>(input: YooptaPluginType<O, P>): YooptaPlugin<O, P>;
-export declare function mergePlugins<O extends YooptaPluginBaseOptions, P extends YooptaBaseElement<string>>(plugins: YooptaPlugin<O, P>[]): YooptaPluginType<O, P>[];
-export declare function mergePluginTypesToMap(plugins: YooptaPluginType<any, YooptaBaseElement<string>>[]): Record<YooptaBaseElement<string>['type'], YooptaPluginType<any, YooptaBaseElement<string>>>;
-export {};

package/dist/utils/storage.d.ts

@@ -1,4 +0,0 @@
-import { YooptaEditorValue } from '../types';
-export type OFFLINE_STORAGE = boolean | string;
-export declare function getStorageName(offline?: OFFLINE_STORAGE): string;
-export declare function getInitialState<V>(storageName: string, offline?: OFFLINE_STORAGE, value?: YooptaEditorValue<V>): YooptaEditorValue<V>;

package/dist/utils/validate.d.ts

@@ -1 +0,0 @@
-export declare function isValidYooptaNodes(nodes: any): boolean;