@firecms/editor 3.0.0-canary.102 → 3.0.0-canary.103

package/dist/components/index.d.ts

@@ -1,8 +1,5 @@
 export { useCurrentEditor as useEditor } from "@tiptap/react";
 export { type Editor } from "@tiptap/core";
 export type { JSONContent } from "@tiptap/react";
-export { EditorRoot } from "./editor";
 export { EditorBubble } from "./editor-bubble";
 export { EditorBubbleItem } from "./editor-bubble-item";
-export { EditorCommand } from "./editor-command";
-export { EditorCommandItem, EditorCommandEmpty } from "./editor-command-item";

package/dist/editor.d.ts

@@ -1,9 +1,16 @@
 import { type JSONContent } from "./components";
+export type FireCMSEditorTextSize = "sm" | "base" | "lg";
 export type FireCMSEditorProps = {
-    initialContent?: JSONContent | string;
+    content?: JSONContent | string;
     onMarkdownContentChange?: (content: string) => void;
     onJsonContentChange?: (content: JSONContent | null) => void;
     onHtmlContentChange?: (content: string) => void;
     handleImageUpload: (file: File) => Promise<string>;
+    version?: number;
+    textSize?: FireCMSEditorTextSize;
+    highlight?: {
+        from: number;
+        to: number;
+    };
 };
-export declare const FireCMSEditor: ({ handleImageUpload, initialContent, onJsonContentChange, onHtmlContentChange, onMarkdownContentChange }: FireCMSEditorProps) => import("react/jsx-runtime").JSX.Element | null;
+export declare const FireCMSEditor: ({ handleImageUpload, content, onJsonContentChange, onHtmlContentChange, onMarkdownContentChange, version, textSize, highlight }: FireCMSEditorProps) => import("react/jsx-runtime").JSX.Element;

package/dist/extensions/index.d.ts

@@ -7,5 +7,4 @@ import { InputRule } from "@tiptap/core";
 declare const PlaceholderExtension: import("@tiptap/core").Extension<import("@tiptap/extension-placeholder").PlaceholderOptions, any>;
 declare const Horizontal: import("@tiptap/core").Node<import("@tiptap/extension-horizontal-rule").HorizontalRuleOptions, any>;
 export { PlaceholderExtension as Placeholder, StarterKit, Horizontal as HorizontalRule, TiptapLink, TiptapImage, TaskItem, TaskList, InputRule, };
-export * from "./slash-command";
 export { getPrevText } from "../utils/utils";

package/dist/extensions/slashCommand.d.ts

@@ -0,0 +1,84 @@
+import React, { ReactNode } from "react";
+import { Editor, Node, Range } from "@tiptap/react";
+import { DOMOutputSpec, Node as ProseMirrorNode } from "@tiptap/pm/model";
+import { PluginKey } from "@tiptap/pm/state";
+import { SuggestionOptions } from "@tiptap/suggestion";
+export interface CommandNodeAttrs {
+    /**
+     * The identifier for the selected item that was mentioned, stored as a `data-id`
+     * attribute.
+     */
+    id: string | null;
+    /**
+     * The label to be rendered by the editor as the displayed text for this mentioned
+     * item, if provided. Stored as a `data-label` attribute. See `renderLabel`.
+     */
+    label?: string | null;
+}
+export type CommandOptions<SuggestionItem = any, Attrs extends Record<string, any> = CommandNodeAttrs> = {
+    /**
+     * The HTML attributes for a command node.
+     * @default {}
+     * @example { class: 'foo' }
+     */
+    HTMLAttributes: Record<string, any>;
+    /**
+     * A function to render the label of a command.
+     * @deprecated use renderText and renderHTML instead
+     * @param props The render props
+     * @returns The label
+     * @example ({ options, node }) => `${options.suggestion.char}${node.attrs.label ?? node.attrs.id}`
+     */
+    renderLabel?: (props: {
+        options: CommandOptions<SuggestionItem, Attrs>;
+        node: ProseMirrorNode;
+    }) => string;
+    /**
+     * A function to render the text of a command.
+     * @param props The render props
+     * @returns The text
+     * @example ({ options, node }) => `${options.suggestion.char}${node.attrs.label ?? node.attrs.id}`
+     */
+    renderText: (props: {
+        options: CommandOptions<SuggestionItem, Attrs>;
+        node: ProseMirrorNode;
+    }) => string;
+    /**
+     * A function to render the HTML of a command.
+     * @param props The render props
+     * @returns The HTML as a ProseMirror DOM Output Spec
+     * @example ({ options, node }) => ['span', { 'data-type': 'command' }, `${options.suggestion.char}${node.attrs.label ?? node.attrs.id}`]
+     */
+    renderHTML: (props: {
+        options: CommandOptions<SuggestionItem, Attrs>;
+        node: ProseMirrorNode;
+    }) => DOMOutputSpec;
+    /**
+     * Whether to delete the trigger character with backspace.
+     * @default false
+     */
+    deleteTriggerWithBackspace: boolean;
+    /**
+     * The suggestion options.
+     * @default {}
+     * @example { char: '@', pluginKey: CommandPluginKey, command: ({ editor, range, props }) => { ... } }
+     */
+    suggestion: Omit<SuggestionOptions<SuggestionItem, Attrs>, "editor">;
+};
+/**
+ * The plugin key for the command plugin.
+ * @default 'command'
+ */
+export declare const CommandPluginKey: PluginKey<any>;
+export declare const SlashCommand: Node<CommandOptions<any, CommandNodeAttrs>, any>;
+export interface SuggestionItem {
+    title: string;
+    description: string;
+    icon: ReactNode;
+    searchTerms?: string[];
+    command?: (props: {
+        editor: Editor;
+        range: Range;
+    }) => void;
+}
+export declare const suggestion: (ref: React.MutableRefObject<any>) => Omit<SuggestionOptions<SuggestionItem, any>, "editor">;