ngx-editor/lib/types.d.ts

The Rich Text Editor for Angular, Built on ProseMirror

import { EditorState } from 'prosemirror-state';
import { EditorView } from 'prosemirror-view';
import { IconsKeys } from './icons';
import { LocalsKeys } from './Locals';
import { Observable } from 'rxjs';
import { LinkOptions } from './modules/menu/link/link.component';
type TCR = {
    dom: HTMLElement;
    update: (state: EditorState) => void;
};
export type TBHeadingItems = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
export type TBItems = 'bold' | 'italic' | 'code' | 'blockquote' | 'underline' | 'strike' | 'ordered_list' | 'bullet_list' | 'link' | 'image' | 'text_color' | 'background_color' | 'align_left' | 'align_center' | 'align_right' | 'align_justify' | 'horizontal_rule' | 'format_clear' | 'indent' | 'outdent' | 'superscript' | 'subscript' | 'undo' | 'redo';
export type ToolbarDropdown = {
    heading?: TBHeadingItems[];
};
export type ToolbarLinkOptions = Partial<LinkOptions>;
export type ToolbarLink = {
    link: ToolbarLinkOptions;
};
export type ToolbarCustomMenuItem = (editorView: EditorView) => TCR;
export type ToolbarDropdownGroupKeys = keyof ToolbarDropdown;
export type ToolbarDropdownGroupValues = ToolbarDropdown[ToolbarDropdownGroupKeys];
export type ToolbarItem = TBItems | ToolbarDropdown | ToolbarLink | ToolbarCustomMenuItem;
export type Toolbar = ToolbarItem[][];
export interface NgxEditorConfig {
    locals?: Partial<Record<LocalsKeys, string | Observable<string>>>;
    icons?: Partial<Record<IconsKeys, string>>;
}
export {};