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

SettingsPage

Extends:

ComponentPageUserPage → SettingsPage

The SettingsPage component displays the user's settings control panel, in the context of their user profile.

Method Summary

Public Methods
public

Build an item list for the user's account settings.

public

content(): *

public

init()

public

Build an item list for the user's notification settings.

public

Generate a callback that will save a value to the given preference.

public

Build an item list for the user's privacy settings.

public

Build an item list for the user's settings controls.

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.

From class Page
public

A class name to apply to the body while the route is active.

public

config(isInitialized: *, context: *)

public

init()

From class UserPage
public
public

The user this page is for.

public

content(): VirtualElement

Get the content to display in the user page.

public

init()

public

loadUser(username: String)

Given a username, load the user's profile from the store, or make a request if we don't have it yet.

public

Build an item list for the navigation in the sidebar.

public

Build an item list for the content of the sidebar.

public

view(): *

protected

show(user: User)

Initialize the component with a user, and trigger the loading of their activity feed.

Public Methods

public accountItems(): ItemList source

Build an item list for the user's account settings.

Return:

ItemList

public content(): * source

Get the content to display in the user page.

Override:

UserPage#content

Return:

*

public init() source

Called when the component is constructed.

Override:

UserPage#init

public notificationsItems(): ItemList source

Build an item list for the user's notification settings.

Return:

ItemList

public preferenceSaver(key: String): Function source

Generate a callback that will save a value to the given preference.

Params:

NameTypeAttributeDescription
key String

Return:

Function

public privacyItems(): ItemList source

Build an item list for the user's privacy settings.

Return:

ItemList

public settingsItems(): ItemList source

Build an item list for the user's settings controls.

Return:

ItemList