Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

constructor

Properties

$backdrop

$backdrop: undefined | JQuery<HTMLElement>

active

active: undefined | boolean

Whether or not the composer currently has focus.

attrs

The attributes passed into the component.

see

https://mithril.js.org/components.html#passing-data-to-components

element

element: Element

The root DOM element for the component.

handle

handle: any

handlers

handlers: undefined | {}

prevPosition

prevPosition: any

state

state: undefined | ComposerState

The composer's "state".

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.

    final

    Parameters

    • Optional selector: string

    Returns JQuery<HTMLElement>

    the jQuery object for the DOM node

animateHeightChange

  • animateHeightChange(): Promise<JQuery<HTMLElement>, any, any>

animatePositionChange

  • animatePositionChange(): void

changeHeight

  • changeHeight(height: number): void

configHandle

  • configHandle(vnode: any): void
  • Add the necessary event handlers to the composer's handle so that it can be used to resize the composer.

    Parameters

    • vnode: any

    Returns void

controlItems

defaultHeight

  • defaultHeight(): number

focus

  • focus(): void

Private hide

  • hide(): void

hideBackdrop

  • hideBackdrop(): void

initializeHeight

  • initializeHeight(): void

Private minimize

  • minimize(): void

onbeforeremove

onbeforeupdate

oncreate

  • oncreate(vnode: any): void

oninit

  • oninit(vnode: any): void

onmousemove

  • onmousemove(e: MouseEvent): void

onmouseup

  • onmouseup(): void

onremove

  • onremove(vnode: any): void

onupdate

  • onupdate(vnode: any): void

Private show

  • show(): void

showBackdrop

  • showBackdrop(): void

updateBodyPadding

  • updateBodyPadding(): 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

updateHeight

  • updateHeight(): 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

view

  • view(): Element

Static component

  • component<SAttrs>(attrs?: SAttrs, children?: Children): Vnode<{}, {}>

Static initAttrs

  • initAttrs(attrs: unknown): void

Generated using TypeDoc version 0.22.10