Types

A collection of types.

KeyValue

type KeyValue = Record<string, string>;

ContentRules

type ContentStyleValue = string | string[] | RegExp;

type ContentStyle = Record<string, ContentStyleValue>;

type ContentAttributeValue = string | string[] | RegExp | ContentStyle;

type ContentAttribute = Record<string, ContentAttributeValue>;

type ContentRules = Record<string, string | ContentAttribute>;

NodePath

type NodePath = number[];

BoxType

type BoxType = 'inline' | 'block';

BoxValue

type BoxValue = Record<string, any>;

RenderBox

type RenderBox = (box: Box) => Nodes | string | void;

BoxComponent

interface BoxComponent {
  type: BoxType;
  name: string;
  value?: BoxValue;
  render: RenderBox;
}

ActiveItem

interface ActiveItem {
  node: Nodes;
  name: string;
  attributes: KeyValue;
  styles: KeyValue;
}

SelectionState

interface SelectionState {
  activeItems: ActiveItem[];
  disabledNameMap?: Map<string, boolean>;
  selectedNameMap?: Map<string, boolean>;
  selectedValuesMap?: Map<string, string[]>;
}

CommandItem

interface CommandItem {
  isDisabled?: (activeItems: ActiveItem[]) => boolean;
  isSelected?: (activeItems: ActiveItem[]) => boolean;
  selectedValues?: (activeItems: ActiveItem[]) => string[];
  execute: (...data: any[]) => void;
}

UnmountPlugin

type UnmountPlugin = () => void;

InitializePlugin

type InitializePlugin = (editor: Editor) => UnmountPlugin | void;

DropdownMenuItem

interface DropdownMenuItem {
  value: string;
  icon?: string;
  text: string | ((locale: TranslationFunctions) => string);
}

DropdownItem

interface DropdownItem {
  name: string;
  icon?: string;
  accentIcon?: string;
  downIcon?: string;
  defaultValue?: string;
  tooltip: string | ((locale: TranslationFunctions) => string);
  width?: string;
  menuType: DropdownMenuType;
  menuItems: DropdownMenuItem[];
  menuWidth?: string;
  menuHeight?: string;
  menuCheck?: boolean;
}

CornerToolbarItem

interface CornerToolbarItem {
  name: string;
  icon?: string;
  tooltip: string | ((locale: TranslationFunctions) => string);
  onClick: (event: Event) => void;
}

ToolbarButtonItem

interface ToolbarButtonItem {
  name: string;
  type: 'button';
  icon?: string;
  tooltip: string | ((locale: TranslationFunctions) => string);
  isSelected?: (activeItems: ActiveItem[]) => boolean;
  isDisabled?: (activeItems: ActiveItem[]) => boolean;
  onClick: (editor: Editor, value: string) => void;
}

ToolbarDropdownItem

interface ToolbarDropdownItem extends DropdownItem {
  name: string;
  type: 'dropdown';
  selectedValues?: (activeItems: ActiveItem[]) => string[];
  isDisabled?: (activeItems: ActiveItem[]) => boolean;
  onSelect: (editor: Editor, value: string) => void;
}

ToolbarUploadItem

interface ToolbarUploadItem {
  name: string;
  type: 'upload';
  icon?: string;
  tooltip: string | ((locale: TranslationFunctions) => string);
  accept?: string;
  multiple?: boolean;
}

ToolbarItem

type ToolbarItem = ToolbarButtonItem | ToolbarDropdownItem | ToolbarUploadItem;

MentionItem

interface MentionItem {
  id: string;
  name: string;
  nickname?: string;
  avatar?: string;
}

SlashButtonItem

interface SlashButtonItem {
  name: string;
  type: 'button';
  icon?: string;
  title: string | ((locale: TranslationFunctions) => string);
  description: string | ((locale: TranslationFunctions) => string);
  onClick: (editor: Editor, value: string) => void;
}

SlashUploadItem

interface SlashUploadItem {
  name: string;
  type: 'upload';
  icon?: string;
  title: string | ((locale: TranslationFunctions) => string);
  description: string | ((locale: TranslationFunctions) => string);
  accept?: string;
  multiple?: boolean;
}

SlashItem

type SlashItem = SlashButtonItem | SlashUploadItem;