Interface StartEditEvent

interface StartEditEvent {
    autoFocus?: string | boolean;
    editMode?: boolean;
    initialSelection?: {
        direction?: "forward" | "backward" | "none";
        end: number;
        start: number;
    };
    text?: string;
}

Properties

autoFocus? editMode? initialSelection? text?

Properties

Optional autoFocus

autoFocus?: string | boolean

Should editor start editing with focus. If a string is passed this will use a querySelector to a nest element to focus.

Default Value

true

Optional editMode

editMode?: boolean

Is editor starting in edit mode.

Default Value

false

Optional initialSelection

initialSelection?: {
    direction?: "forward" | "backward" | "none";
    end: number;
    start: number;
}

Allows the initial selection position to be overridden. By default it's at the end

Type declaration

  • Optional direction?: "forward" | "backward" | "none"
  • end: number
  • start: number

Optional text

text?: string

Edit text. If this is null or undefined then this will not replace the text. A '' will clear the text.

Default Value

null

Settings

Member Visibility

Theme

On This Page

autoFocuseditModeinitialSelectiontext