@paperbits/common/editing/IHtmlEditor.ts

Paperbits common components.

import { BlockModel } from "../text/models/blockModel";
import { SelectionState } from "./selectionState";
import { HyperlinkContract } from "./hyperlinkContract";

export let formattableStates = ["bold", "italic", "underlined", "highlighted", "hyperlink", "h1", "h2", "h3", "h4", "h5", "h6",
    "quote", "code", "ol", "ul", "alignedLeft", "alignedRight", "alignedCenter", "justified"];

export interface IHtmlEditor {
    attachToElement(element: HTMLElement): void;
    detachFromElement(): void;
    enable(activeElement?: HTMLElement): void;
    disable(): void;
    getSelectionState(): SelectionState;
    toggleBold(): void;
    toggleItalic(): void;
    toggleUnderlined(): void;
    toggleHighlighted(): void;
    toggleStriked(): void;
    toggleCode(): void;
    toggleParagraph(): void;
    toggleH1(): void;
    toggleH2(): void;
    toggleH3(): void;
    toggleH4(): void;
    toggleH5(): void;
    toggleH6(): void;
    toggleQuote(): void;
    toggleFormatted(): void;
    toggleSize(): void;
    toggleOrderedList(styleKey?: string): void;
    toggleUnorderedList(styleKey?: string): void;
    alignLeft(viewport?: string): void;
    alignCenter(viewport?: string): void;
    alignRight(viewport?: string): void;
    justify(viewport?: string): void;
    setHyperlink(hyperlink: HyperlinkContract): void;
    setAnchor(hash: string, anchorKey: string): void;
    removeAnchor(): void;
    removeHyperlink(): void;
    setColor(colorKey: string): void;
    removeColor(): void;
    getHyperlink(): HyperlinkContract;
    expandSelection(): void;
    getState(): BlockModel[];
    setState(state: BlockModel[]): void;
    getSelectionText(): string;
    increaseIndent(): void;
    decreaseIndent(): void;
    setTextStyle(styleKey: string, viewport?: string): void;
    onStateChange: (state: BlockModel[]) => void;
    insertProperty(name: string, placeholder: string): void;
}