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

TextEditor

Extends:

Component → TextEditor

The TextEditor component displays a textarea with controls, including a submit button.

Props

  • submitLabel
  • value
  • placeholder
  • disabled

Member Summary

Public Members
public

The value of the textarea.

Method Summary

Public Methods
public

configTextarea(element: DOMElement, isInitialized: Boolean)

Configure the textarea element.

public

Build an item list for the text editor controls.

public

Get the selected range of the textarea.

public

init()

public

Insert content into the textarea at the position of the cursor.

public

oninput(value: String)

Handle input into the textarea.

public

Handle the submit button being clicked.

public

setSelectionRange(start: Integer, end: Integer)

Set the selected range of the textarea.

public

setValue(value: String)

Set the value of the text editor.

public

Build an item list for the toolbar controls.

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 value: String source

The value of the textarea.

Public Methods

public configTextarea(element: DOMElement, isInitialized: Boolean) source

Configure the textarea element.

Params:

NameTypeAttributeDescription
element DOMElement
isInitialized Boolean

public controlItems(): ItemList source

Build an item list for the text editor controls.

Return:

ItemList

public getSelectionRange(): Array source

Get the selected range of the textarea.

Return:

Array

public init() source

Called when the component is constructed.

Override:

Component#init

public insertAtCursor(insert: String) source

Insert content into the textarea at the position of the cursor.

Params:

NameTypeAttributeDescription
insert String

public oninput(value: String) source

Handle input into the textarea.

Params:

NameTypeAttributeDescription
value String

public onsubmit() source

Handle the submit button being clicked.

public setSelectionRange(start: Integer, end: Integer) source

Set the selected range of the textarea.

Params:

NameTypeAttributeDescription
start Integer
end Integer

public setValue(value: String) source

Set the value of the text editor.

Params:

NameTypeAttributeDescription
value String

public toolbarItems(): ItemList source

Build an item list for the toolbar controls.

Return:

ItemList

public view(): * source

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

Override:

Component#view

Return:

*