import TextEditor from 'flarum/common/components/TextEditor'

public class | source

TextEditor

Extends:

src/common/Component.js~Component → TextEditor

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

Attrs

composer
submitLabel
value
placeholder
disabled
preview

Member Summary

Public Members
public	disabled: * Whether the editor is disabled.
public	value: String The value of the editor.

Method Summary

Public Methods
public	buildEditor(dom: ):
public	buildEditorParams(): {"classNames": , "disabled": , "placeholder": , "value": , "oninput": , "inputListeners": , "onsubmit": *}
public	controlItems(): ItemList Build an item list for the text editor controls.
public	oncreate(vnode: *)
public	oninit(vnode: *)
public	oninput(value: String) Handle input into the textarea.
public	onsubmit() Handle the submit button being clicked.
public	onupdate(vnode: *)
public	toolbarItems(): ItemList Build an item list for the toolbar controls.
public	view(): *

Public Members

public disabled: * source

Whether the editor is disabled.

public value: String source

The value of the editor.

Public Methods

public buildEditor(dom: ): source

Params:

Name	Type	Attribute	Description
dom	*

Return:

public buildEditorParams(): {"classNames": , "disabled": , "placeholder": , "value": , "oninput": , "inputListeners": , "onsubmit": *} source

Return:

{"classNames": *, "disabled": *, "placeholder": *, "value": *, "oninput": *, "inputListeners": *, "onsubmit": *}

public controlItems(): ItemList source

Build an item list for the text editor controls.

Return:

ItemList

public oncreate(vnode: *) source

Params:

Name	Type	Attribute	Description
vnode	*

public oninit(vnode: *) source

Params:

Name	Type	Attribute	Description
vnode	*

public oninput(value: String) source

Handle input into the textarea.

Params:

Name	Type	Attribute	Description
value	String

public onsubmit() source

Handle the submit button being clicked.

public onupdate(vnode: *) source

Params:

Name	Type	Attribute	Description
vnode	*

TextEditor

Extends:

Attrs

Member Summary

Method Summary

Public Members

public disabled: * source

public value: String source

Public Methods

public buildEditor(dom: ): source

Params:

Return:

public buildEditorParams(): {"classNames": , "disabled": , "placeholder": , "value": , "oninput": , "inputListeners": , "onsubmit": *} source

Return:

public controlItems(): ItemList source

Return:

public oncreate(vnode: *) source

Params:

public oninit(vnode: *) source

Params:

public oninput(value: String) source

Params:

public onsubmit() source

public onupdate(vnode: *) source

Params:

public toolbarItems(): ItemList source

Return:

public view(): * source

Return:

TextEditor

Extends:

Attrs

Member Summary

Method Summary

Public Members

public disabled: * source

public value: String source

Public Methods

public buildEditor(dom: *): * source

Params:

Return:

public buildEditorParams(): {"classNames": *, "disabled": *, "placeholder": *, "value": *, "oninput": *, "inputListeners": *, "onsubmit": *} source

Return:

public controlItems(): ItemList source

Return:

public oncreate(vnode: *) source

Params:

public oninit(vnode: *) source

Params:

public oninput(value: String) source

Params:

public onsubmit() source

public onupdate(vnode: *) source

Params:

public toolbarItems(): ItemList source

Return:

public view(): * source

Return:

public buildEditor(dom: ): source

public buildEditorParams(): {"classNames": , "disabled": , "placeholder": , "value": , "oninput": , "inputListeners": , "onsubmit": *} source