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.




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

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

The composer's "state".


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

  • Add the necessary event handlers to the composer's handle so that it can be used to resize the composer.


    • vnode: any

    Returns void

  • Update the amount of padding-bottom on the body so that the page's content will still be visible above the composer when the page is scrolled right to the bottom.

    Returns void

  • Update the DOM to reflect the composer's current height. This involves setting the height of the composer's root element, and adjusting the height of any flexible elements inside the composer's body.

    Returns void

  • 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