@atlaskit/editor-plugin-block-type/dist/types-ts4.5/pm-plugins/types.d.ts

BlockType plugin for @atlaskit/editor-core

import type { ReactElement } from 'react';
import type { MessageDescriptor } from 'react-intl';
import type { AllowedBlockTypes, HeadingLevelsAndNormalText } from '@atlaskit/editor-common/types';
import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
export type BlockTypeName = 'normal' | 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6' | 'blockquote' | 'codeblock' | 'panel' | 'notePanel' | 'successPanel' | 'warningPanel' | 'errorPanel' | 'other';
export interface BlockType {
    icon?: ReactElement;
    LEGACY_icon?: ReactElement;
    level?: HeadingLevelsAndNormalText;
    markName?: string;
    name: string;
    nodeName: string;
    tagName?: string;
    title: MessageDescriptor;
}
export interface BlockTypeWithRank extends BlockType {
    toolbarKey: string;
    toolbarRank: number;
}
export interface BlockTypeNode {
    name: AllowedBlockTypes;
    node: NodeSpec;
}
export interface BlockTypePluginOptions {
    allowBlockType?: {
        exclude?: Array<AllowedBlockTypes>;
    };
    /**
     * Add ability to toggle paragraph size variations.
     *
     * Note: Feature is in development and logic is under an experiment.
     * Note: `fontSize` mark must be supported in the ADF schema for this feature to work.
     * Note: To support fontSize variatons in tasks, allowBlockTaskItem must be enabled for tasksAndDecisionsPlugin
     */
    allowFontSize?: boolean;
    includeBlockQuoteAsTextstyleOption?: boolean;
    isUndoRedoButtonsEnabled?: boolean;
    lastNodeMustBeParagraph?: boolean;
}