Flarum (v2.0.0-beta.5)
    Preparing search index...

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

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

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _loaders: any[] | undefined

    Async operations to complete before the editor is ready.

    The attributes passed into the component.

    disabled: any

    Whether the editor is disabled.

    element: Element

    The root DOM element for the component.

    loading: boolean | undefined

    Whether the editor is loading.

    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: string | undefined

    The value of the editor.

    Methods

    • 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.

      Parameters

      • Optionalselector: string

        a jQuery-compatible selector string

      Returns JQuery

      the jQuery object for the DOM node

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

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