Reference Source
import ComposerBody from 'flarum/components/ComposerBody'
public class | source

ComposerBody

Extends:

Component → ComposerBody

The ComposerBody component handles the body, or the content, of the composer. Subclasses should implement the onsubmit method and override headerTimes.

Props

  • originalContent
  • submitLabel
  • placeholder
  • user
  • confirmExit
  • disabled

Member Summary

Public Members
public

The content of the text editor.

public

The text editor component instance.

public

Whether or not the component is loading.

Method Summary

Public Methods
public

focus()

Draw focus to the text editor.

public

Build an item list for the composer's header.

public

init()

public

loaded()

Stop loading.

public abstract

Handle the submit event of the text editor.

public

Check if there is any unsaved data – if there is, return a confirmation message to prompt the user with.

public

view(): *

Inherited Summary

From class Component
public static

component(props: Object, children: *): Object

Get a Mithril component object for this component, preloaded with props.

public static

initProps(props: Object)

Initialize the component's props.

public

element: *

The root DOM element for the component.

public

The properties passed into the component.

public

Whether or not to retain the component's subtree on redraw.

public

$(selector: String): jQuery

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.

public

config(isInitialized: Boolean, context: Object, vdom: Object)

Called after the component's root element is redrawn. This hook can be used to perform any actions on the DOM, both on the initial draw and any subsequent redraws. See Mithril's documentation for more information.

public

Called when the component is destroyed, i.e.

public

Get the renderable virtual DOM that represents the component's view.

This should NOT be overridden by subclasses. Subclasses wishing to define their virtual DOM should override Component#view instead.

protected

init()

Called when the component is constructed.

protected

Get the virtual DOM that represents the component's view.

Public Members

public content: Function source

The content of the text editor.

public editor: TextEditor source

The text editor component instance.

public loading: Boolean source

Whether or not the component is loading.

Public Methods

public focus() source

Draw focus to the text editor.

public headerItems(): ItemList source

Build an item list for the composer's header.

Return:

ItemList

public init() source

Called when the component is constructed.

Override:

Component#init

public loaded() source

Stop loading.

public abstract onsubmit() source

Handle the submit event of the text editor.

public preventExit(): String source

Check if there is any unsaved data – if there is, return a confirmation message to prompt the user with.

Return:

String

public view(): * source

Get the virtual DOM that represents the component's view.

Override:

Component#view

Return:

*