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

BasicsPage

Extends:

src/common/Component.js~ComponentPageAdminPage → BasicsPage

Member Summary

Public Members
public
public
public

Method Summary

Public Methods
public
public

headerInfo(): {"className": string, "icon": string, "title": *, "description": *}

public

Build a list of options for the default homepage.

public

oninit(vnode: *)

Inherited Summary

From class Page
public

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

public

Whether we should scroll to the top of the page when its rendered.

public

Whether the browser should restore scroll state on refreshes.

public

oncreate(vnode: *)

public

oninit(vnode: *)

public

onremove(vnode: *)

From class AdminPage
public
public

settings: {}

public

buildSettingComponent(setting: *): JSX.Element

buildSettingComponent takes a settings object and turns it into a component.

public
public

dirty(): *

public

header(): *

public

headerInfo(): {"className": *, "icon": *, "title": *, "description": *}

public

isChanged(): *

public

oninit(vnode: *)

public
public

saveSettings(e: *): *

public

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

public
public

view(): *

Public Members

public displayNameOptions: {} source

public localeOptions: {} source

public slugDriverOptions: {} source

Public Methods

public content(): undefined[] source

Override:

AdminPage#content

Return:

undefined[]

public headerInfo(): {"className": string, "icon": string, "title": *, "description": *} source

Override:

AdminPage#headerInfo

Return:

{"className": string, "icon": string, "title": *, "description": *}

public homePageItems(): ItemList source

Build a list of options for the default homepage. Each option must be an object with path and label properties.

Return:

ItemList

public oninit(vnode: *) source

Override:

AdminPage#oninit

Params:

NameTypeAttributeDescription
vnode *