@openreachtech/furo-vue 1.3.1

package/types/generated/components/organisms/FuroEditor/FuroEditorCommandContext.d.ts

@@ -0,0 +1,192 @@
+/**
+ * Command facade over a Tiptap editor instance.
+ *
+ * Owns the selection/command surface for FuroEditor: querying active marks and
+ * nodes, toggling formatting, applying headings/alignment/color, and editing links.
+ * It is a plain helper (not a Vue context) so it can be unit-tested with a stubbed
+ * editor ref.
+ */
+export default class FuroEditorCommandContext {
+    /**
+     * Factory method to create a new instance of this class.
+     *
+     * @param {FuroEditorCommandContextParams} params - Parameters of this factory method.
+     * @returns {FuroEditorCommandContext} - New instance of this class.
+     */
+    static create({ editorRef, }: FuroEditorCommandContextParams): FuroEditorCommandContext;
+    /**
+     * Constructor.
+     *
+     * @param {FuroEditorCommandContextParams} params - Parameters of this constructor.
+     */
+    constructor({ editorRef, }: FuroEditorCommandContextParams);
+    editorRef: import("vue").ShallowRef<import("@tiptap/vue-3").Editor, import("@tiptap/vue-3").Editor>;
+    /**
+     * get: the live Tiptap editor instance, or null before it mounts.
+     *
+     * @returns {import('@tiptap/vue-3').Editor | null} - Editor instance.
+     */
+    get editor(): import("@tiptap/vue-3").Editor | null;
+    /**
+     * Whether a node or mark is currently active.
+     *
+     * @param {{
+     *   name?: string | null
+     *   attributes?: Record<string, *> | null
+     * }} [params] - Parameters of this method.
+     * @returns {boolean} - true when active.
+     */
+    isActive({ name, attributes, }?: {
+        name?: string | null;
+        attributes?: Record<string, any> | null;
+    }): boolean;
+    /**
+     * Whether any of the given text-align values is active.
+     *
+     * @param {{
+     *   alignments: Array<string>
+     * }} params - Parameters of this method.
+     * @returns {boolean} - true when one alignment is active.
+     */
+    hasActiveTextAlign({ alignments, }: {
+        alignments: Array<string>;
+    }): boolean;
+    /**
+     * Focus the editor and return a fresh command chain.
+     *
+     * @returns {import('@tiptap/core').ChainedCommands | null} - Focused chain, or null.
+     */
+    focusChain(): import("@tiptap/core").ChainedCommands | null;
+    /**
+     * Toggle a node or mark by its chained-command name (toggleBold, toggleBulletList, ...).
+     *
+     * @param {{
+     *   command: string
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    toggleNodeOrMark({ command, }: {
+        command: string;
+    }): void;
+    /**
+     * Execute a dropdown command (heading level, paragraph, alignment, color).
+     *
+     * @param {{
+     *   command: string
+     *   level?: number | null
+     *   value?: string | null
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    executeDropdownCommand({ command, level, value, }: {
+        command: string;
+        level?: number | null;
+        value?: string | null;
+    }): void;
+    /**
+     * Run a heading toggle when a level is provided.
+     *
+     * @param {{
+     *   chain: import('@tiptap/core').ChainedCommands
+     *   level: number | null
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    runToggleHeading({ chain, level, }: {
+        chain: import("@tiptap/core").ChainedCommands;
+        level: number | null;
+    }): void;
+    /**
+     * Run a text-align command when a value is provided.
+     *
+     * @param {{
+     *   chain: import('@tiptap/core').ChainedCommands
+     *   value: string | null
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    runSetTextAlign({ chain, value, }: {
+        chain: import("@tiptap/core").ChainedCommands;
+        value: string | null;
+    }): void;
+    /**
+     * Run a color command; an empty value clears the color.
+     *
+     * @param {{
+     *   chain: import('@tiptap/core').ChainedCommands
+     *   value: string | null
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    runSetColor({ chain, value, }: {
+        chain: import("@tiptap/core").ChainedCommands;
+        value: string | null;
+    }): void;
+    /**
+     * Insert literal text at the cursor (used to trigger the mention popup with '@').
+     *
+     * @param {{
+     *   text: string
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    insertText({ text, }: {
+        text: string;
+    }): void;
+    /**
+     * Insert an inline image node at the cursor, or at an explicit document position.
+     *
+     * @param {{
+     *   src: string
+     *   alt?: string
+     *   position?: number | null
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    insertImage({ src, alt, position, }: {
+        src: string;
+        alt?: string;
+        position?: number | null;
+    }): void;
+    /**
+     * Read the link href, display text, and document range of the current selection.
+     *
+     * @returns {{
+     *   url: string
+     *   displayText: string
+     *   range: { from: number, to: number } | null
+     * }} - Current link details for the selection.
+     */
+    extractSelectionLink(): {
+        url: string;
+        displayText: string;
+        range: {
+            from: number;
+            to: number;
+        } | null;
+    };
+    /**
+     * Apply or clear a link over a document range (or the current selection).
+     *
+     * Using an explicit range keeps the operation reliable after the link dialog
+     * (a focus-trapped modal) closes, since it does not depend on the live cursor.
+     *
+     * @param {{
+     *   url: string
+     *   displayText: string
+     *   range?: { from: number, to: number } | null
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    applyLink({ url, displayText, range, }: {
+        url: string;
+        displayText: string;
+        range?: {
+            from: number;
+            to: number;
+        } | null;
+    }): void;
+}
+export type FuroEditorCommandContextParams = {
+    editorRef: ReturnType<typeof import("@tiptap/vue-3").useEditor>;
+};