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

SettingsModal

Extends:

src/common/Component.js~ComponentModal → SettingsModal

Member Summary

Public Members
public
public

settings: {}

Method Summary

Public Methods
public

changed(): *

public

content(): *

public

dirty(): *

public
public

oninit(vnode: *)

public
public

onsubmit(e: *)

public

setting(key: *, fallback: string): *

public

Inherited Summary

From class Modal
public static

Determine whether or not the modal should be dismissible via an 'x' button.

public

Attributes for an alert component to show below the header.

public
public abstract

Get the class name to apply to the modal.

public abstract

content(): VirtualElement

Get the content of the modal.

public

hide()

Hide the modal.

public

loaded()

Stop loading.

public
public

oncreate(vnode: *)

public

Show an alert describing an error returned from the API, and give focus to the first relevant field.

public

Focus on the first input when the modal is ready to be used.

public

onsubmit(e: Event)

Handle the modal form's submit event.

public abstract

Get the title of the modal dialog.

public

view(): *

Public Members

public loading: boolean source

Override:

Modal#loading

public settings: {} source

Public Methods

public changed(): * source

Return:

*

public content(): * source

Get the content of the modal.

Override:

Modal#content

Return:

*

public dirty(): * source

Return:

*

public form(): string source

Return:

string

public oninit(vnode: *) source

Params:

NameTypeAttributeDescription
vnode *

public onsaved() source

public onsubmit(e: *) source

Handle the modal form's submit event.

Override:

Modal#onsubmit

Params:

NameTypeAttributeDescription
e *

public setting(key: *, fallback: string): * source

Params:

NameTypeAttributeDescription
key *
fallback string
  • optional
  • default:

Return:

*

public submitButton(): * source

Return:

*