vuetify-pro-tiptap/lib/extensions/components/bubble.d.ts

tiptap text editor on vuejs and vuetify

import { Editor } from '@tiptap/vue-3';
import { ButtonViewParams, ButtonViewReturn, ExtensionNameKeys } from '../../type';
/** Represents the floating types for bubble images */
type BubbleImageFloatType = 'float-left' | 'float-none' | 'float-right';
/** Represents the size types for bubble images or videos */
type BubbleImageOrVideoSizeType = 'size-small' | 'size-medium' | 'size-large';
/** Represents the various types for bubble images */
type BubbleImageType = BubbleImageFloatType | `image-${BubbleImageOrVideoSizeType}` | `video-${BubbleImageOrVideoSizeType}` | 'image' | 'image-aspect-ratio' | 'unlink' | 'link-open' | 'remove';
/** Represents the types for bubble videos */
type BubbleVideoType = 'video' | 'remove';
/** Represents the types for bubble table */
type BubbleTableType = 'table-add-column-before' | 'table-add-column-after' | 'table-delete-column' | 'table-add-row-before' | 'table-add-row-after' | 'table-delete-row' | 'table-merge-or-split-cells' | 'table-delete-table';
/** Represents the overall types for bubbles */
type BubbleAllType = BubbleImageType | BubbleVideoType | BubbleTableType | ExtensionNameKeys | 'divider' | (string & {});
/** Represents the key types for node types */
export type NodeTypeKey = 'table' | 'image' | 'text' | 'link' | 'video';
/** Represents the menu of bubble types for each node type */
export type BubbleTypeMenu = Partial<Record<NodeTypeKey, BubbleMenuItem[]>>;
/** Represents the menu of overall bubble types for each node type */
export type NodeTypeMenu = Partial<Record<NodeTypeKey, BubbleAllType[]>>;
/**
 * Represents the structure of a bubble menu item.
 */
export interface BubbleMenuItem extends ButtonViewReturn {
    /** The type of the bubble item */
    type: BubbleAllType;
}
/**
 * Represents a function to generate a bubble menu
 */
interface BubbleView<T = any> {
    /**
     * Generates a bubble menu based on the provided options.
     * @param {ButtonViewParams<T>} options - The options for generating the bubble menu.
     * @returns {BubbleTypeMenu} The generated bubble menu.
     */
    (options: ButtonViewParams<T>): BubbleTypeMenu;
}
/**
 * Represents the options for configuring bubbles.
 * @interface BubbleOptions
 * @template T
 */
export interface BubbleOptions<T> {
    /** The menu of bubble types for each node type. */
    list: NodeTypeMenu;
    /** The default list of bubble types. */
    defaultBubbleList: typeof defaultBubbleList;
    /** The function to generate a bubble menu. */
    button: BubbleView<T>;
}
export declare function defaultBubbleList(editor: Editor): BubbleMenuItem[];
/**
 * Generate bubble menu
 * @template T
 * @param {NodeTypeMenu} list
 * @param {BubbleMenuItem[]} defaultList
 * @param {ButtonViewParams<T>} { editor, extension, t }
 * @return {*}  {BubbleTypeMenu}
 */
export declare function generateBubbleTypeMenu<T = any>(list: NodeTypeMenu, defaultList: BubbleMenuItem[], { editor, extension, t }: ButtonViewParams<T>): BubbleTypeMenu;
export {};