Class Composer

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

Component
- Composer

Constructors

constructor

new Composer(): Composer
Returns Composer

Inherited from Component.constructor

Properties

$backdrop

$backdrop: undefined | JQuery<HTMLElement>

active

active: undefined | boolean

Whether or not the composer currently has focus.

attrs

attrs: ComponentAttrs

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 | {}

Type declaration

prevPosition

prevPosition: any

state

state: undefined | ComposerState

The composer's "state".

Methods

$

$(selector?): JQuery<HTMLElement>
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
- Optional selector: string
  
  a jQuery-compatible selector string
Returns JQuery<HTMLElement>
the jQuery object for the DOM node

Final
Inherited from Component.$
- Defined in framework/core/js/src/common/Component.ts:112

animateHeightChange

animateHeightChange(): Promise<JQuery<HTMLElement>, any, any>
Animate the Composer into the new position by changing the height.

Returns Promise<JQuery<HTMLElement>, any, any>
- Defined in framework/core/js/src/forum/components/Composer.js:229

animatePositionChange

animatePositionChange(): void
Trigger the right animation depending on the desired new position.

Returns void
- Defined in framework/core/js/src/forum/components/Composer.js:207

changeHeight

changeHeight(height): void
Save a new Composer height and update the DOM.
Parameters
- height: number
Returns void
- Defined in framework/core/js/src/forum/components/Composer.js:397

configHandle

configHandle(vnode): 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
- Defined in framework/core/js/src/forum/components/Composer.js:115

controlItems

controlItems(): ItemList<Children>
Build an item list for the composer's controls.

Returns ItemList<Children>
- Defined in framework/core/js/src/forum/components/Composer.js:324

defaultHeight

defaultHeight(): number
Default height of the Composer in case none is saved.

Returns number
- Defined in framework/core/js/src/forum/components/Composer.js:389

focus

focus(): void
Draw focus to the first focusable content element (the text editor).

Returns void
- Defined in framework/core/js/src/forum/components/Composer.js:166

`Private` hide

hide(): void
Private
Animate closing the composer.

Returns void
- Defined in framework/core/js/src/forum/components/Composer.js:295

hideBackdrop

hideBackdrop(): void
Hide the Composer backdrop.

Returns void
- Defined in framework/core/js/src/forum/components/Composer.js:262

initializeHeight

initializeHeight(): void
Initialize default Composer height.

Returns void
- Defined in framework/core/js/src/forum/components/Composer.js:377

`Private` minimize

minimize(): void
Private
Shrink the composer until only its title is visible.

Returns void
- Defined in framework/core/js/src/forum/components/Composer.js:312

onbeforeremove

onbeforeremove(vnode): void
Parameters
- vnode: VnodeDOM<ComponentAttrs, Composer>
Returns void

Inherit Doc
Inherited from Component.onbeforeremove
- Defined in framework/core/js/src/common/Component.ts:92

onbeforeupdate

onbeforeupdate(vnode): void
Parameters
- vnode: VnodeDOM<ComponentAttrs, Composer>
Returns void

Inherit Doc
Inherited from Component.onbeforeupdate
- Defined in framework/core/js/src/common/Component.ts:80

oncreate

oncreate(vnode): void
Parameters
- vnode: any
Returns void

Inherit Doc
Overrides Component.oncreate
- Defined in framework/core/js/src/forum/components/Composer.js:76

oninit

oninit(vnode): void
Parameters
- vnode: any
Returns void

Inherit Doc
Overrides Component.oninit
- Defined in framework/core/js/src/forum/components/Composer.js:15

onmousemove

onmousemove(e): void
Resize the composer according to mouse movement.
Parameters
- e: MouseEvent
Returns void
- Defined in framework/core/js/src/forum/components/Composer.js:134

onmouseup

onmouseup(): void
Finish resizing the composer when the mouse is released.

Returns void
- Defined in framework/core/js/src/forum/components/Composer.js:156

onremove

onremove(vnode): void
Parameters
- vnode: any
Returns void

Inherit Doc
Overrides Component.onremove
- Defined in framework/core/js/src/forum/components/Composer.js:103

onupdate

onupdate(vnode): void
Parameters
- vnode: any
Returns void

Inherit Doc
Overrides Component.onupdate
- Defined in framework/core/js/src/forum/components/Composer.js:62

`Private` show

show(): void
Private
Animate the composer sliding up from the bottom to take its normal height.

Returns void
- Defined in framework/core/js/src/forum/components/Composer.js:271

showBackdrop

showBackdrop(): void
Show the Composer backdrop.

Returns void
- Defined in framework/core/js/src/forum/components/Composer.js:255

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
- Defined in framework/core/js/src/forum/components/Composer.js:195

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
- Defined in framework/core/js/src/forum/components/Composer.js:175

view

view(): Element
Returns Element

Inherit Doc
Overrides Component.view
- Defined in framework/core/js/src/forum/components/Composer.js:36

`Static` component

component<SAttrs>(attrs?, children?): Vnode<{}, {}>
Convenience method to attach a component without JSX. Has the same effect as calling m(THIS_CLASS, attrs, children).
Type Parameters
- SAttrs extends ComponentAttrs<SAttrs> = ComponentAttrs
Parameters
- attrs: SAttrs = ...
- children: Children = null
Returns Vnode<{}, {}>

See
https://mithril.js.org/hyperscript.html#mselector,-attributes,-children
Inherited from Component.component
- Defined in framework/core/js/src/common/Component.ts:124

`Static` initAttrs

initAttrs(attrs): void
Initialize the component's attrs.

This can be used to assign default values for missing, optional attrs.
Parameters
- attrs: unknown
Returns void
Inherited from Component.initAttrs
- Defined in framework/core/js/src/common/Component.ts:159

Class Composer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Composer

Properties

$backdrop

active

attrs

See

element

handle

handlers

Type declaration

prevPosition

state

Methods

$

Parameters

Optional selector: string

Returns JQuery<HTMLElement>

Final

animateHeightChange

Returns Promise<JQuery<HTMLElement>, any, any>

animatePositionChange

Returns void

changeHeight

Parameters

height: number

Returns void

configHandle

Parameters

vnode: any

Returns void

controlItems

Returns ItemList<Children>

defaultHeight

Returns number

focus

Returns void

Private hide

Returns void

hideBackdrop

Returns void

initializeHeight

Returns void

Private minimize

Returns void

onbeforeremove

Parameters

vnode: VnodeDOM<ComponentAttrs, Composer>

Returns void

Inherit Doc

onbeforeupdate

Parameters

vnode: VnodeDOM<ComponentAttrs, Composer>

Returns void

Inherit Doc

oncreate

Parameters

vnode: any

Returns void

Inherit Doc

oninit

Parameters

vnode: any

Returns void

Inherit Doc

onmousemove

Parameters

e: MouseEvent

Returns void

onmouseup

Returns void

onremove

Parameters

`Optional` selector: string

`Private` hide

`Private` minimize

`Private` show

`Static` component

`Static` initAttrs