@syncfusion/ej2-richtexteditor
Version:
Essential JS 2 RichTextEditor component
53 lines (52 loc) • 1.83 kB
TypeScript
import { ChildProperty } from '@syncfusion/ej2-base';
import { DialogType } from '../common/enum';
import { ISlashMenuItem } from '../common/interface';
import { CommandName } from '../common/enum';
import { SlashMenuItems } from '../common/types';
/**
* Configures the slash menu settings of the RichTextEditor.
*/
export declare class SlashMenuSettings extends ChildProperty<SlashMenuSettings> {
/**
* Specifies whether to enable or disable the slash menu in the editor.
*
* @default false
*/
enable: boolean;
/**
* Defines the items to be displayed in the slash menu.
*
* @default ['Paragraph', 'Heading 1', 'Heading 2', 'Heading 3', 'Heading 4', 'OrderedList', 'UnorderedList', 'CodeBlock', 'Blockquote']
*/
items: (SlashMenuItems | ISlashMenuItem)[];
/**
* Specifies the width of the slash menu popup. Can be defined in pixels, numbers, or percentages.
* A numeric value is treated as pixels.
*
* @default '300px'
* @aspType string
*/
popupWidth: string | number;
/**
* Specifies the height of the slash menu popup. Can be defined in pixels, numbers, or percentages.
* A numeric value is treated as pixels.
*
* @default '320px'
* @aspType string
*/
popupHeight: string | number;
}
export interface ISlashMenuModel {
text?: string;
command: SlashMenuItems;
subCommand: CommandName | DialogType | string;
type: SlashCommandType;
iconCss: string;
description?: string;
}
export interface ModuleSlashMenuModel extends ISlashMenuModel {
module: string;
}
export declare type SlashCommandType = 'Inline' | 'Basic Block' | 'Media';
export declare const defaultSlashMenuDataModel: ISlashMenuModel[];
export declare const injectibleSlashMenuDataModel: ModuleSlashMenuModel[];