@openreachtech/furo-vue 1.3.1

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

@@ -0,0 +1,904 @@
+/**
+ * Context for the FuroEditor organism.
+ *
+ * Owns the editor lifecycle, the value/attachment surface, the formatting toolbar
+ * model, and the link dialog. Selection and command execution are delegated to a
+ * {@link FuroEditorCommandContext} sub-context. Paste behavior (markdown detection,
+ * font-style stripping, newline preservation) is wired onto the editor on mount.
+ *
+ * Domain concerns (mention search, attachment uploads) are exposed as adapter
+ * callbacks and slots — this component never touches GraphQL or domain schemas.
+ *
+ * @extends {BaseFuroContext<null, FuroEditorContextParams['props'], string>}
+ */
+export default class FuroEditorContext extends BaseFuroContext<null, {
+    parcel?: FuroEditorParcel | null;
+} & {
+    parcel?: any;
+}, string> {
+    /**
+     * Factory method to create a new instance of this class.
+     *
+     * @template {X extends typeof FuroEditorContext ? X : never} T, X
+     * @override
+     * @param {FuroEditorContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} - New instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroEditorContext ? X : never, X>(this: T, { props, componentContext, editorRef, reactiveHash, }: FuroEditorContextFactoryParams): InstanceType<T>;
+    /** @override */
+    static override get EMIT_EVENT_NAME(): {
+        UPDATE_VALUE: string;
+        CHANGE_VALUE: string;
+        COMMIT_VALUE: string;
+        UPDATE_ATTACHED_FILES: string;
+        ADD_MENTION: string;
+        ADD_FILES: string;
+        IMAGE_ERROR: string;
+    };
+    /**
+     * Build reactive hash.
+     *
+     * @override
+     * @returns {FuroEditorContextParams['reactiveHash']}
+     */
+    static override buildReactiveHash(): FuroEditorContextParams["reactiveHash"];
+    /**
+     * get: default toolbar labels.
+     *
+     * @returns {typeof DEFAULT_LABELS} - Default labels.
+     */
+    static get DEFAULT_LABELS(): typeof DEFAULT_LABELS;
+    /**
+     * Build the option object for the `useEditor()` composable.
+     *
+     * Keeps all editor-assembly logic out of the component's `setup()`: the SFC only
+     * passes the result to `useEditor()` and hands the ref to {@link create}.
+     *
+     * The Tiptap builders are injected (not imported) so this context module — and the
+     * unit tests that load it — stay free of the editor runtime.
+     *
+     * @param {{
+     *   props: { parcel?: FuroEditorParcel | null }
+     *   componentContext: import('vue').SetupContext<*>
+     *   buildExtensions: typeof import('./build-editor-extensions.js').buildEditorExtensions
+     *   createMention: typeof import('./mention-suggestion.js').createMentionExtension
+     * }} params - Parameters of this method.
+     * @returns {Partial<import('@tiptap/core').EditorOptions>} - useEditor() options.
+     */
+    static buildEditorOptions({ props, componentContext, buildExtensions, createMention, }: {
+        props: {
+            parcel?: FuroEditorParcel | null;
+        };
+        componentContext: import("vue").SetupContext<any>;
+        buildExtensions: typeof import("./build-editor-extensions.js").buildEditorExtensions;
+        createMention: typeof import("./mention-suggestion.js").createMentionExtension;
+    }): Partial<import("@tiptap/core").EditorOptions>;
+    /**
+     * Build the mention extension via the injected factory.
+     *
+     * Always registers the mention node so saved chips render in any editor (including
+     * read-only / display). The live `@` popup is wired only when a search adapter is
+     * supplied.
+     *
+     * @param {{
+     *   parcel: FuroEditorParcel
+     *   componentContext: import('vue').SetupContext<*>
+     *   createMention: typeof import('./mention-suggestion.js').createMentionExtension
+     * }} params - Parameters of this method.
+     * @returns {import('@tiptap/core').AnyExtension} - Mention extension.
+     */
+    static buildMentionExtension({ parcel, componentContext, createMention, }: {
+        parcel: FuroEditorParcel;
+        componentContext: import("vue").SetupContext<any>;
+        createMention: typeof import("./mention-suggestion.js").createMentionExtension;
+    }): import("@tiptap/core").AnyExtension;
+    /**
+     * Constructor.
+     *
+     * @param {FuroEditorContextParams} params - Parameters of this constructor.
+     */
+    constructor({ props, componentContext, reactiveHash, editorRef, }: FuroEditorContextParams);
+    reactiveHash: {
+        statusReactive: import("vue").Reactive<FuroEditorStatusReactive>;
+        addLinkReactive: import("vue").Reactive<FuroEditorAddLinkReactive>;
+    };
+    editorRef: import("vue").ShallowRef<import("@tiptap/vue-3").Editor, import("@tiptap/vue-3").Editor>;
+    commandContext: FuroEditorCommandContext;
+    /** @type {{ from: number, to: number } | null} */
+    linkRange: {
+        from: number;
+        to: number;
+    } | null;
+    /**
+     * get: live editor instance, or null before it mounts.
+     *
+     * @returns {import('@tiptap/vue-3').Editor | null} - Editor instance.
+     */
+    get editor(): import("@tiptap/vue-3").Editor | null;
+    /**
+     * get: the command sub-context.
+     *
+     * @returns {FuroEditorCommandContext} - Command facade.
+     */
+    get command(): FuroEditorCommandContext;
+    /**
+     * get: status reactive (link dialog open state).
+     *
+     * @returns {{ isLinkDialogOpen: boolean }} - Status reactive.
+     */
+    get statusReactive(): {
+        isLinkDialogOpen: boolean;
+    };
+    /**
+     * get: add-link reactive (url + display text).
+     *
+     * @returns {{ url: string, displayText: string }} - Link reactive.
+     */
+    get addLinkReactive(): {
+        url: string;
+        displayText: string;
+    };
+    /**
+     * get: current HTML value from parcel.
+     *
+     * @returns {string} - HTML content.
+     */
+    get value(): string;
+    /**
+     * get: placeholder text.
+     *
+     * @returns {string} - Placeholder.
+     */
+    get placeholder(): string;
+    /**
+     * get: attached files passed in by the consumer.
+     *
+     * @returns {Array<*>} - Attached files.
+     */
+    get attachedFiles(): Array<any>;
+    /**
+     * Whether the editor is read-only.
+     *
+     * @returns {boolean} - true when read-only.
+     */
+    isReadOnly(): boolean;
+    /**
+     * Whether the editor renders as plain text (no chrome: toolbar, border, padding).
+     *
+     * @returns {boolean} - true in plain appearance.
+     */
+    isPlain(): boolean;
+    /**
+     * Whether the editor is display-only (read-only or plain) — never editable.
+     *
+     * @returns {boolean} - true when display-only.
+     */
+    isDisplayOnly(): boolean;
+    /**
+     * Whether the editor instance is currently editable.
+     *
+     * @returns {boolean} - true when editable.
+     */
+    isEditorEditable(): boolean;
+    /**
+     * Whether the mention feature is enabled (a search adapter was supplied).
+     *
+     * @returns {boolean} - true when mentions are available.
+     */
+    hasMentionFeature(): boolean;
+    /**
+     * Whether inline images are enabled (an upload adapter was supplied).
+     *
+     * @returns {boolean} - true when inline images are available.
+     */
+    hasImageFeature(): boolean;
+    /**
+     * Whether the link dialog is open.
+     *
+     * @returns {boolean} - true when open.
+     */
+    isLinkDialogOpen(): boolean;
+    /**
+     * Merge consumer label overrides over the defaults.
+     *
+     * @returns {typeof DEFAULT_LABELS} - Effective labels.
+     */
+    extractLabels(): typeof DEFAULT_LABELS;
+    /**
+     * Setup component context: bind editor events, paste handlers, and value/readonly sync.
+     *
+     * @template {X extends FuroEditorContext ? X : never} T, X
+     * @override
+     * @returns {T} - For method chaining.
+     * @this {T}
+     */
+    override setupComponent<T extends X extends FuroEditorContext ? X : never, X>(this: T): T;
+    /**
+     * Bind editor update/blur events to emits.
+     *
+     * @returns {void}
+     */
+    bindEditorEvents(): void;
+    /**
+     * Install paste transforms (markdown detection, font-style stripping, normalization).
+     *
+     * @returns {void}
+     */
+    bindPasteHandlers(): void;
+    /**
+     * Handle a paste: inline images first, then markdown plain text.
+     *
+     * @param {{
+     *   clipboardEvent: ClipboardEvent
+     * }} params - Parameters of this method.
+     * @returns {boolean} - true when a handler consumed the paste.
+     */
+    handleEditorPaste({ clipboardEvent, }: {
+        clipboardEvent: ClipboardEvent;
+    }): boolean;
+    /**
+     * Emit the pasted files the editor does not insert itself.
+     *
+     * @param {{
+     *   clipboardEvent: ClipboardEvent
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    emitPastedFiles({ clipboardEvent, }: {
+        clipboardEvent: ClipboardEvent;
+    }): void;
+    /**
+     * Emit files handed to the consumer, unless there are none.
+     *
+     * @param {{
+     *   files: Array<File>
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    emitAddedFiles({ files, }: {
+        files: Array<File>;
+    }): void;
+    /**
+     * Upload and insert any image files present on the clipboard.
+     *
+     * @param {{
+     *   clipboardEvent: ClipboardEvent
+     * }} params - Parameters of this method.
+     * @returns {boolean} - true when image files were consumed.
+     */
+    handleImagePaste({ clipboardEvent, }: {
+        clipboardEvent: ClipboardEvent;
+    }): boolean;
+    /**
+     * Insert dropped images at the drop position, and hand the other files to the consumer.
+     *
+     * @param {{
+     *   view: import('@tiptap/pm/view').EditorView
+     *   dragEvent: DragEvent
+     * }} params - Parameters of this method.
+     * @returns {boolean} - true when the dropped files were taken.
+     */
+    handleEditorDrop({ view, dragEvent, }: {
+        view: import("@tiptap/pm/view").EditorView;
+        dragEvent: DragEvent;
+    }): boolean;
+    /**
+     * Extract the document position a drag event points at.
+     *
+     * @param {{
+     *   view: import('@tiptap/pm/view').EditorView
+     *   dragEvent: DragEvent
+     * }} params - Parameters of this method.
+     * @returns {number | null} - Document position.
+     */
+    extractDropPosition({ view, dragEvent, }: {
+        view: import("@tiptap/pm/view").EditorView;
+        dragEvent: DragEvent;
+    }): number | null;
+    /**
+     * Push the parcel value into the editor when it diverges from the current HTML.
+     *
+     * @returns {void}
+     */
+    syncValueIntoEditor(): void;
+    /**
+     * Reflect the read-only flag onto the editor.
+     *
+     * @returns {void}
+     */
+    syncEditableState(): void;
+    /**
+     * Convert pasted markdown plain text into HTML and insert it.
+     *
+     * @param {{
+     *   clipboardEvent: ClipboardEvent
+     * }} params - Parameters of this method.
+     * @returns {boolean} - true when this handler consumed the paste.
+     */
+    handleMarkdownPaste({ clipboardEvent, }: {
+        clipboardEvent: ClipboardEvent;
+    }): boolean;
+    /**
+     * Render markdown to HTML asynchronously and insert it at the cursor.
+     *
+     * @param {{
+     *   rawText: string
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    insertMarkdownAsHtml({ rawText, }: {
+        rawText: string;
+    }): void;
+    /**
+     * Normalize pasted plain-text line breaks.
+     *
+     * @param {{
+     *   text: string
+     * }} params - Parameters of this method.
+     * @returns {string} - Normalized text.
+     */
+    normalizePastedText({ text, }: {
+        text: string;
+    }): string;
+    /**
+     * Strip font-family / font-size declarations from pasted HTML so external
+     * typography does not override the editor's.
+     *
+     * @param {{
+     *   html: string
+     * }} params - Parameters of this method.
+     * @returns {string} - Sanitized HTML.
+     */
+    stripPastedHtmlFontStyles({ html, }: {
+        html: string;
+    }): string;
+    /**
+     * Whether pasted text looks like markdown.
+     *
+     * @param {{
+     *   text: string
+     * }} params - Parameters of this method.
+     * @returns {boolean} - true when markdown patterns match.
+     */
+    isMarkdown({ text, }: {
+        text: string;
+    }): boolean;
+    /**
+     * Build the inline-mark controls (bold / italic / underline / strikethrough).
+     *
+     * @returns {Array<FuroEditorControl>} - Mark controls.
+     */
+    generateMarkControls(): Array<FuroEditorControl>;
+    /**
+     * Build the block controls (bullets / numbers / blockquote).
+     *
+     * @returns {Array<FuroEditorControl>} - Block controls.
+     */
+    generateBlockControls(): Array<FuroEditorControl>;
+    /**
+     * Build the action controls (link, plus image / mention when enabled).
+     *
+     * @returns {Array<FuroEditorControl>} - Action controls.
+     */
+    generateActionControls(): Array<FuroEditorControl>;
+    /**
+     * Flatten all toolbar controls into a single list.
+     *
+     * @returns {Array<FuroEditorControl>} - Toolbar controls.
+     */
+    generateFormattingControls(): Array<FuroEditorControl>;
+    /**
+     * Build a lookup of control descriptors keyed by control name.
+     *
+     * @returns {Record<string, FuroEditorControl>} - Controls keyed by name.
+     */
+    generateControlHash(): Record<string, FuroEditorControl>;
+    /**
+     * Build a lookup of dropdown descriptors keyed by name.
+     *
+     * @returns {Record<string, FuroEditorToolbarEntry>} - Dropdown entries keyed by name.
+     */
+    generateDropdownDescriptorHash(): Record<string, FuroEditorToolbarEntry>;
+    /**
+     * The default toolbar layout: an array of groups, separators sit between groups.
+     *
+     * @returns {Array<Array<string>>} - Groups of item names.
+     */
+    generateDefaultToolbarGroups(): Array<Array<string>>;
+    /**
+     * The effective toolbar groups (consumer override or the default).
+     *
+     * @returns {Array<Array<string>>} - Groups of item names.
+     */
+    generateToolbarGroups(): Array<Array<string>>;
+    /**
+     * Resolve a name to a dropdown or control descriptor, leaving `overflow` unhandled.
+     *
+     * @param {{
+     *   name: string
+     *   dropdownHash: Record<string, FuroEditorToolbarEntry>
+     *   controlHash: Record<string, FuroEditorControl>
+     * }} params - Parameters of this method.
+     * @returns {FuroEditorToolbarEntry | null} - Render descriptor.
+     */
+    resolveDropdownOrControlEntry({ name, dropdownHash, controlHash, }: {
+        name: string;
+        dropdownHash: Record<string, FuroEditorToolbarEntry>;
+        controlHash: Record<string, FuroEditorControl>;
+    }): FuroEditorToolbarEntry | null;
+    /**
+     * Resolve a toolbar item name to a render descriptor, or null when unavailable.
+     *
+     * @param {{
+     *   name: string
+     *   dropdownHash: Record<string, FuroEditorToolbarEntry>
+     *   controlHash: Record<string, FuroEditorControl>
+     * }} params - Parameters of this method.
+     * @returns {FuroEditorToolbarEntry | null} - Render descriptor.
+     */
+    resolveToolbarEntry({ name, dropdownHash, controlHash, }: {
+        name: string;
+        dropdownHash: Record<string, FuroEditorToolbarEntry>;
+        controlHash: Record<string, FuroEditorControl>;
+    }): FuroEditorToolbarEntry | null;
+    /**
+     * Resolve the overflow menu, or null when no action is left to put in it.
+     *
+     * @returns {FuroEditorToolbarEntry | null} - Render descriptor.
+     */
+    resolveOverflowEntry(): FuroEditorToolbarEntry | null;
+    /**
+     * List the toolbar names this editor accepts, feature-gated names included.
+     *
+     * @returns {Array<string>} - Accepted names.
+     */
+    generateKnownToolbarNames(): Array<string>;
+    /**
+     * Whether a toolbar name lies outside the vocabulary. A gated feature's own name
+     * stays known, so switching the feature off never reads as a typo.
+     *
+     * @param {{
+     *   name: string
+     * }} params - Parameters of this method.
+     * @returns {boolean} - true when nothing accepts the name.
+     */
+    isUnknownToolbarName({ name, }: {
+        name: string;
+    }): boolean;
+    /**
+     * Fail on a `parcel.toolbar` name nothing can resolve, which would otherwise ship
+     * as a quietly shorter toolbar. Production keeps dropping the name instead.
+     *
+     * @param {{
+     *   name: string
+     * }} params - Parameters of this method.
+     * @returns {void}
+     * @throws {Error} When the name lies outside the toolbar vocabulary.
+     */
+    throwOnUnknownToolbarName({ name, }: {
+        name: string;
+    }): void;
+    /**
+     * List the default action names no toolbar group named.
+     *
+     * @returns {Array<string>} - Hidden action names.
+     */
+    generateOverflowEntryNames(): Array<string>;
+    /**
+     * Build the render descriptors the overflow menu holds.
+     *
+     * @returns {Array<FuroEditorToolbarEntry>} - Render descriptors.
+     */
+    generateOverflowEntries(): Array<FuroEditorToolbarEntry>;
+    /**
+     * Build the overflow menu options, one per hidden action.
+     *
+     * @returns {Array<import('../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js').FuroDropdownMenuOption>} - Options.
+     */
+    generateOverflowOptions(): Array<import("../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js").FuroDropdownMenuOption>;
+    /**
+     * Build one overflow menu option, nesting a hidden dropdown as a submenu.
+     *
+     * @param {{
+     *   entry: FuroEditorToolbarEntry
+     * }} params - Parameters of this method.
+     * @returns {import('../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js').FuroDropdownMenuOption} - Option.
+     */
+    buildOverflowOption({ entry, }: {
+        entry: FuroEditorToolbarEntry;
+    }): import("../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js").FuroDropdownMenuOption;
+    /**
+     * Extract the icon an overflow row draws, mirroring the on-bar active swap.
+     *
+     * @param {{
+     *   option: import('../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js').FuroDropdownMenuOption
+     * }} params - Parameters of this method.
+     * @returns {string | null} - Icon name, or null when the row draws none.
+     */
+    extractOverflowIconName({ option, }: {
+        option: import("../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js").FuroDropdownMenuOption;
+    }): string | null;
+    /**
+     * Whether an overflow row draws a colour swatch beside its label.
+     *
+     * @param {{
+     *   option: import('../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js').FuroDropdownMenuOption
+     * }} params - Parameters of this method.
+     * @returns {boolean} - true when the row is a colour option.
+     */
+    hasOverflowSwatch({ option, }: {
+        option: import("../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js").FuroDropdownMenuOption;
+    }): boolean;
+    /**
+     * React to an overflow menu selection, routing to the handler the value belongs to.
+     *
+     * @param {{
+     *   value?: string
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    onOverflowSelect({ value, }: {
+        value?: string;
+    }): void;
+    /**
+     * Build the flat toolbar layout (dropdowns, controls, separators between groups).
+     *
+     * @returns {Array<FuroEditorToolbarEntry>} - Ordered render descriptors.
+     */
+    generateToolbarLayout(): Array<FuroEditorToolbarEntry>;
+    /**
+     * Build the heading dropdown options.
+     *
+     * @returns {Array<import('../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js').FuroDropdownMenuOption>} - Options.
+     */
+    generateHeadingOptions(): Array<import("../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js").FuroDropdownMenuOption>;
+    /**
+     * Build the text-color dropdown options.
+     *
+     * @returns {Array<import('../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js').FuroDropdownMenuOption>} - Options.
+     */
+    generateColorOptions(): Array<import("../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js").FuroDropdownMenuOption>;
+    /**
+     * Resolve the swatch color for a color dropdown option value.
+     *
+     * @param {{
+     *   value?: string
+     * }} params - Parameters of this method.
+     * @returns {string} - CSS color for the swatch dot.
+     */
+    extractColorSwatch({ value, }: {
+        value?: string;
+    }): string;
+    /**
+     * Build the text-align dropdown options.
+     *
+     * @returns {Array<import('../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js').FuroDropdownMenuOption>} - Options.
+     */
+    generateAlignOptions(): Array<import("../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js").FuroDropdownMenuOption>;
+    /**
+     * React to a formatting control click.
+     *
+     * @param {{
+     *   control: FuroEditorControl
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    onControlClick({ control, }: {
+        control: FuroEditorControl;
+    }): void;
+    /**
+     * Open a native file picker for images and insert the chosen files inline.
+     *
+     * @returns {void}
+     */
+    openImagePicker(): void;
+    /**
+     * Create a hidden multi-image file input element.
+     *
+     * @returns {HTMLInputElement} - The file input.
+     */
+    createImageFileInput(): HTMLInputElement;
+    /**
+     * Extract image files from a FileList-like value.
+     *
+     * @param {{
+     *   fileSource: FileList | null
+     * }} params - Parameters of this method.
+     * @returns {Array<File>} - Image files only.
+     */
+    extractImageFiles({ fileSource, }: {
+        fileSource: FileList | null;
+    }): Array<File>;
+    /**
+     * Extract the image files the editor embeds itself, empty without an upload adapter.
+     *
+     * @param {{
+     *   fileSource: FileList | null
+     * }} params - Parameters of this method.
+     * @returns {Array<File>} - Image files the editor takes.
+     */
+    extractInsertableImageFiles({ fileSource, }: {
+        fileSource: FileList | null;
+    }): Array<File>;
+    /**
+     * Extract the files the editor leaves for the consumer to store.
+     *
+     * @param {{
+     *   fileSource: FileList | null
+     * }} params - Parameters of this method.
+     * @returns {Array<File>} - Files the editor does not insert.
+     */
+    extractUnconsumedFiles({ fileSource, }: {
+        fileSource: FileList | null;
+    }): Array<File>;
+    /**
+     * Upload image files through the consumer adapter and insert them inline.
+     *
+     * The first file lands at `position` (or the cursor when null); the rest follow
+     * it in order. Uploads run sequentially to preserve document order.
+     *
+     * @param {{
+     *   files: FileList | Array<File> | null
+     *   position?: number | null
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    uploadAndInsertImages({ files, position, }: {
+        files: FileList | Array<File> | null;
+        position?: number | null;
+    }): void;
+    /**
+     * Upload one image and insert it, reporting a refusal instead of ending the batch.
+     *
+     * @param {{
+     *   file: File
+     *   position: number | null
+     * }} params - Parameters of this method.
+     * @returns {Promise<void>} - Resolves once the file is inserted or reported.
+     */
+    uploadAndInsertImage({ file, position, }: {
+        file: File;
+        position: number | null;
+    }): Promise<void>;
+    /**
+     * React to a dropdown option selection.
+     *
+     * @param {{
+     *   value?: string
+     * }} params - Parameters of this method (value is the option's encoded action).
+     * @returns {void}
+     */
+    onDropdownSelect({ value, }: {
+        value?: string;
+    }): void;
+    /**
+     * Whether a formatting control is currently active.
+     *
+     * @param {{
+     *   control: FuroEditorControl
+     * }} params - Parameters of this method.
+     * @returns {boolean} - true when active.
+     */
+    isControlActive({ control, }: {
+        control: FuroEditorControl;
+    }): boolean;
+    /**
+     * Extract the button variant for a control based on its active state.
+     *
+     * @param {{
+     *   control: FuroEditorControl
+     * }} params - Parameters of this method.
+     * @returns {'secondary' | 'ghost'} - Variant.
+     */
+    extractControlVariant({ control, }: {
+        control: FuroEditorControl;
+    }): "secondary" | "ghost";
+    /**
+     * Extract the trigger variant for a dropdown group based on its active state.
+     *
+     * @param {{
+     *   kind: 'heading' | 'textStyle' | 'textAlign'
+     * }} params - Parameters of this method.
+     * @returns {'secondary' | 'ghost'} - Variant.
+     */
+    extractDropdownVariant({ kind, }: {
+        kind: "heading" | "textStyle" | "textAlign";
+    }): "secondary" | "ghost";
+    /**
+     * Whether a dropdown group (heading / color / align) is active.
+     *
+     * @param {{
+     *   kind: 'heading' | 'textStyle' | 'textAlign'
+     * }} params - Parameters of this method.
+     * @returns {boolean} - true when active.
+     */
+    isDropdownActive({ kind, }: {
+        kind: "heading" | "textStyle" | "textAlign";
+    }): boolean;
+    /**
+     * Reflect the dialog open state from a FuroDialog open change.
+     *
+     * @param {{
+     *   isOpen: boolean
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    onLinkDialogOpenChange({ isOpen, }: {
+        isOpen: boolean;
+    }): void;
+    /**
+     * Open the link dialog, prefilling from the current selection.
+     *
+     * @returns {void}
+     */
+    openLinkDialog(): void;
+    /**
+     * Close the link dialog.
+     *
+     * @returns {void}
+     */
+    closeLinkDialog(): void;
+    /**
+     * Apply the link from the dialog and close it.
+     *
+     * @returns {void}
+     */
+    saveLink(): void;
+    /**
+     * Update the dialog link URL.
+     *
+     * @param {{
+     *   url?: string | null
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    updateLinkUrl({ url, }: {
+        url?: string | null;
+    }): void;
+    /**
+     * Update the dialog link display text.
+     *
+     * @param {{
+     *   displayText?: string | null
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    updateLinkDisplayText({ displayText, }: {
+        displayText?: string | null;
+    }): void;
+    /**
+     * Remove an attached file by index and emit the updated array.
+     *
+     * @param {{
+     *   index: number
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    removeAttachedFile({ index, }: {
+        index: number;
+    }): void;
+    /**
+     * Whether the consumer provided an `attachments` slot.
+     *
+     * @returns {boolean} - true when the slot is present.
+     */
+    hasAttachmentsSlot(): boolean;
+}
+export type FuroEditorControl = {
+    name: string;
+    kind: "toggle" | "link" | "image" | "mention";
+    command: string;
+    iconName: string;
+    activeIconName: string;
+    tooltip: string;
+};
+export type FuroEditorToolbarEntry = {
+    type: "separator";
+    key: string;
+} | {
+    type: "dropdown";
+    key: string;
+    label: string;
+    iconName: string;
+    dropdownKind: "heading" | "textStyle" | "textAlign";
+    hasSwatch?: boolean;
+    options: Array<import("../../molecules/FuroDropdownMenu/DropdownMenuOptionSelectEmitPayload.js").FuroDropdownMenuOption>;
+} | {
+    type: "control";
+    key: string;
+    control: FuroEditorControl;
+} | {
+    type: "overflow";
+    key: string;
+};
+export type FuroEditorStatusReactive = {
+    isLinkDialogOpen: boolean;
+};
+export type FuroEditorAddLinkReactive = {
+    url: string;
+    displayText: string;
+};
+export type FuroEditorContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams<{
+    parcel?: FuroEditorParcel | null;
+}> & {
+    editorRef: ReturnType<typeof import("@tiptap/vue-3").useEditor>;
+    reactiveHash: {
+        statusReactive: import("vue").Reactive<FuroEditorStatusReactive>;
+        addLinkReactive: import("vue").Reactive<FuroEditorAddLinkReactive>;
+    };
+};
+export type FuroEditorContextFactoryParams = Omit<FuroEditorContextParams, "reactiveHash"> & {
+    reactiveHash?: FuroEditorContextParams["reactiveHash"];
+};
+export type FuroEditorParcel = {
+    value?: string;
+    placeholder?: string;
+    readOnly?: boolean;
+    appearance?: "editor" | "plain";
+    autofocus?: boolean | "start" | "end" | "all" | number;
+    contentAttributes?: Record<string, string>;
+    toolbar?: Array<Array<string>>;
+    attachedFiles?: Array<any>;
+    labels?: Partial<typeof DEFAULT_LABELS>;
+    mention?: {
+        searchMentions: (params: {
+            query: string;
+        }) => Promise<Array<{
+            id: string | number;
+            label: string;
+        }>>;
+    };
+    image?: {
+        uploadImage: (params: {
+            file: File;
+        }) => Promise<{
+            src: string;
+            alt?: string;
+        }>;
+    };
+    actionOverrides?: Record<string, (params: {
+        control: FuroEditorControl;
+        command: FuroEditorCommandContext;
+        editor: import("@tiptap/vue-3").Editor | null;
+    }) => void>;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';
+import FuroEditorCommandContext from './FuroEditorCommandContext.js';
+declare namespace DEFAULT_LABELS {
+    let normalText: string;
+    let heading1: string;
+    let heading2: string;
+    let heading3: string;
+    let heading4: string;
+    let colorDefault: string;
+    let colorRed: string;
+    let colorBlue: string;
+    let colorGreen: string;
+    let colorOrange: string;
+    let colorPurple: string;
+    let alignLeft: string;
+    let alignCenter: string;
+    let alignRight: string;
+    let alignJustify: string;
+    let heading: string;
+    let textColor: string;
+    let textAlign: string;
+    let bold: string;
+    let italic: string;
+    let underline: string;
+    let strike: string;
+    let bullets: string;
+    let numbers: string;
+    let blockquote: string;
+    let link: string;
+    let mention: string;
+    let image: string;
+    let overflow: string;
+    let linkDialogTitle: string;
+    let linkUrlLabel: string;
+    let linkDisplayTextLabel: string;
+    let linkSave: string;
+    let linkCancel: string;
+}
+export {};