@atlaskit/editor-plugin-paste-options-toolbar/dist/types-ts4.5/pasteOptionsToolbarPluginType.d.ts

Paste options toolbar for @atlaskit/editor-core

import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
import type { PastePlugin } from '@atlaskit/editor-plugin-paste';
import type { UiControlRegistryPlugin } from '@atlaskit/editor-plugin-ui-control-registry';
import type { RegisterComponent } from '@atlaskit/editor-ui-control-model';
import type { ToolbarDropdownOption } from './types/types';
import type { PasteMenuRuleFactories } from './ui/utils/paste-menu-rules/types';
export type PasteOptionsToolbarPluginDependencies = [
    OptionalPlugin<AnalyticsPlugin>,
    PastePlugin,
    OptionalPlugin<UiControlRegistryPlugin>
];
export interface PasteOptionsToolbarSharedState {
    isPlainText: boolean;
    pasteAncestorNodeNames: string[];
    pasteEndPos: number;
    pasteStartPos: number;
    plaintextLength: number;
    selectedOption: ToolbarDropdownOption;
    showLegacyOptions: boolean;
    showToolbar: boolean;
}
export type PasteOptionsToolbarPasteMenuContext = {
    getCurrentPastedUrl: () => string | undefined;
    getCurrentPasteRange: () => {
        pasteEndPos: number;
        pasteStartPos: number;
    } | undefined;
};
export type PasteOptionsToolbarPluginConfiguration = {
    /**
     * Optional factory for composing product-specific paste menu buttons.
     * Called with the pre-bound rule factories so products can compose
     * `isHidden` callbacks before plugin setup.
     *
     * @example
     * pasteMenuButtonsFactory: (rules) => [
     *   {
     *     type: 'menu-item',
     *     key: 'my-product-button',
     *     isHidden: rules.allRules(rules.notProseRule, rules.minCharsRule(100)),
     *     component: () => <MyProductButton />,
     *   },
     * ]
     */
    pasteMenuButtonsFactory?: (rules: PasteMenuRuleFactories, context?: PasteOptionsToolbarPasteMenuContext) => RegisterComponent[];
    usePopupBasedPasteActionsMenu?: boolean;
};
export type PasteOptionsToolbarPlugin = NextEditorPlugin<'pasteOptionsToolbarPlugin', {
    actions: {
        /**
         * Returns the collection of paste-menu rule factories.
         * External plugins (e.g. `editor-plugin-ai`, `editor-plugin-card`) use
         * this to compose `isHidden` callbacks without static cross-package
         * imports.
         *
         * @example
         * const { minCharsRule, allRules } =
         *   api.pasteOptionsToolbarPlugin.actions.getPasteMenuRules();
         */
        getPasteMenuRules: () => PasteMenuRuleFactories;
    };
    dependencies: PasteOptionsToolbarPluginDependencies;
    pluginConfiguration?: PasteOptionsToolbarPluginConfiguration;
    sharedState: PasteOptionsToolbarSharedState;
}>;