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

    The Composer component displays the composer. It can be loaded with a content component with load and then its position/state can be altered with show, hide, close, minimize, fullScreen, and exitFullScreen.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    $backdrop: JQuery<HTMLElement> | undefined
    active: boolean | undefined

    Whether or not the composer currently has focus.

    The attributes passed into the component.

    element: Element

    The root DOM element for the component.

    handle: any
    handlers: {} | undefined
    prevPosition: any
    state: ComposerState | undefined

    The composer's "state".

    textEditorBuilt: boolean | undefined

    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