@hufe921/canvas-editor/dist/src/editor/interface/Control.d.ts

rich text editor by canvas/svg

import { FlexDirection, LocationPosition } from '../dataset/enum/Common';
import { ControlType, ControlIndentation, ControlState } from '../dataset/enum/Control';
import { EditorZone } from '../dataset/enum/Editor';
import { MoveDirection } from '../dataset/enum/Observer';
import { RowFlex } from '../dataset/enum/Row';
import { IDrawOption } from './Draw';
import { IElement } from './Element';
import { IPositionContext } from './Position';
import { IRange } from './Range';
import { IRow, IRowElement } from './Row';
export interface IValueSet {
    value: string;
    code: string;
}
export interface IControlSelect {
    code: string | null;
    valueSets: IValueSet[];
    isMultiSelect?: boolean;
    multiSelectDelimiter?: string;
    selectExclusiveOptions?: {
        inputAble?: boolean;
    };
}
export interface IControlCheckbox {
    code: string | null;
    min?: number;
    max?: number;
    flexDirection: FlexDirection;
    valueSets: IValueSet[];
}
export interface IControlRadio {
    code: string | null;
    flexDirection: FlexDirection;
    valueSets: IValueSet[];
}
export interface IControlDate {
    dateFormat?: string;
}
export interface IControlHighlightRule {
    keyword: string;
    alpha?: number;
    backgroundColor?: string;
}
export interface IControlHighlight {
    ruleList: IControlHighlightRule[];
    id?: string;
    conceptId?: string;
}
export interface IControlRule {
    deletable?: boolean;
    disabled?: boolean;
    pasteDisabled?: boolean;
    hide?: boolean;
}
export interface IControlBasic {
    type: ControlType;
    value: IElement[] | null;
    placeholder?: string;
    conceptId?: string;
    prefix?: string;
    postfix?: string;
    minWidth?: number;
    underline?: boolean;
    border?: boolean;
    extension?: unknown;
    indentation?: ControlIndentation;
    rowFlex?: RowFlex;
    preText?: string;
    postText?: string;
}
export interface IControlStyle {
    font?: string;
    size?: number;
    bold?: boolean;
    highlight?: string;
    italic?: boolean;
    strikeout?: boolean;
}
export type IControl = IControlBasic & IControlRule & Partial<IControlStyle> & Partial<IControlSelect> & Partial<IControlCheckbox> & Partial<IControlRadio> & Partial<IControlDate>;
export interface IControlOption {
    placeholderColor?: string;
    bracketColor?: string;
    prefix?: string;
    postfix?: string;
    borderWidth?: number;
    borderColor?: string;
    activeBackgroundColor?: string;
    disabledBackgroundColor?: string;
    existValueBackgroundColor?: string;
    noValueBackgroundColor?: string;
}
export interface IControlInitOption {
    index: number;
    isTable?: boolean;
    trIndex?: number;
    tdIndex?: number;
    tdValueIndex?: number;
}
export interface IControlInitResult {
    newIndex: number;
}
export interface IControlInstance {
    setElement(element: IElement): void;
    getElement(): IElement;
    getValue(context?: IControlContext): IElement[];
    setValue(data: IElement[], context?: IControlContext, options?: IControlRuleOption): number;
    keydown(evt: KeyboardEvent): number | null;
    cut(): number;
}
export interface IControlContext {
    range?: IRange;
    elementList?: IElement[];
}
export interface IControlRuleOption {
    isIgnoreDisabledRule?: boolean;
    isIgnoreDeletedRule?: boolean;
    isAddPlaceholder?: boolean;
}
export interface IGetControlValueOption {
    id?: string;
    conceptId?: string;
    areaId?: string;
}
export type IGetControlValueResult = (Omit<IControl, 'value'> & {
    value: string | null;
    innerText: string | null;
    zone: EditorZone;
    elementList?: IElement[];
})[];
export interface ISetControlValueOption {
    id?: string;
    conceptId?: string;
    areaId?: string;
    value: string | IElement[] | null;
    isSubmitHistory?: boolean;
}
export interface ISetControlExtensionOption {
    id?: string;
    conceptId?: string;
    areaId?: string;
    extension: unknown;
}
export type ISetControlHighlightOption = IControlHighlight[];
export type ISetControlProperties = {
    id?: string;
    conceptId?: string;
    areaId?: string;
    properties: Partial<Omit<IControl, 'value'>>;
    isSubmitHistory?: boolean;
};
export type IRepaintControlOption = Pick<IDrawOption, 'curIndex' | 'isCompute' | 'isSubmitHistory' | 'isSetCursor'>;
export interface IControlChangeOption {
    context?: IControlContext;
    controlElement?: IElement;
    controlValue?: IElement[];
}
export interface INextControlContext {
    positionContext: IPositionContext;
    nextIndex: number;
}
export interface IInitNextControlOption {
    direction?: MoveDirection;
}
export interface ILocationControlOption {
    position: LocationPosition;
}
export interface ISetControlRowFlexOption {
    row: IRow;
    rowElement: IRowElement;
    availableWidth: number;
    controlRealWidth: number;
}
export interface IControlChangeResult {
    state: ControlState;
    control: IControl;
    controlId: string;
}
export interface IControlContentChangeResult {
    control: IControl;
    controlId: string;
}
export interface IDestroyControlOption {
    isEmitEvent?: boolean;
}
export interface IRemoveControlOption {
    id?: string;
    conceptId?: string;
}