The TextEditor component displays a textarea with controls, including a submit button.


  • composer
  • submitLabel
  • value
  • placeholder
  • disabled
  • preview




The attributes passed into the component.


disabled: any

Whether the editor is disabled.

element: Element

The root DOM element for the component.

state: undefined

Class component state that is persisted between redraws.

Updating this will not automatically trigger a redraw, unlike other frameworks.

This is different to Vnode state, which is always an instance of your class component.

This is undefined by default.

value: undefined | string

The value of the editor.


  • Returns a jQuery object for this component's element. If you pass in a selector string, this method will return a jQuery object, using the current element as its buffer.

    For example, calling component.$('li') will return a jQuery object containing all of the li elements inside the DOM element of this component.


    the jQuery object for the DOM node



    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

  • Returns {
        classNames: string[];
        disabled: any;
        inputListeners: never[];
        oninput: ((value: string) => void);
        onsubmit: (() => void);
        placeholder: any;
        value: undefined | string;

    • classNames: string[]
    • disabled: any
    • inputListeners: never[]
    • oninput: ((value: string) => void)
        • (value: string): void
        • Handle input into the textarea.


          • value: string

          Returns void

    • onsubmit: (() => void)
        • (): void
        • Returns void

    • placeholder: any
    • value: undefined | string
  • Initialize the component's attrs.

    This can be used to assign default values for missing, optional attrs.


    • attrs: unknown

    Returns void

Generated using TypeDoc v0.23.24