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

UserPage

Extends:

src/common/Component.js~ComponentPage → UserPage

The UserPage component shows a user's profile. It can be extended to show content inside of the content area. See ActivityPage and SettingsPage for examples.

Member Summary

Public Members
public
public

The user this page is for.

Method Summary

Public Methods
public

content(): VirtualElement

Get the content to display in the user page.

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

oninit(vnode: *)

public

Build an item list for the content of the sidebar.

public

view(): *

Protected Methods
protected

show(user: User)

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

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

oncreate(vnode: *)

public

oninit(vnode: *)

public

Public Members

public bodyClass: string source

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

Override:

Page#bodyClass

public user: User source

The user this page is for.

Public Methods

public content(): VirtualElement source

Get the content to display in the user page.

Return:

VirtualElement

public loadUser(username: String) source

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

Params:

NameTypeAttributeDescription
username String

public navItems(): ItemList source

Build an item list for the navigation in the sidebar.

Return:

ItemList

public oninit(vnode: *) source

Override:

Page#oninit

Params:

NameTypeAttributeDescription
vnode *

public sidebarItems(): ItemList source

Build an item list for the content of the sidebar.

Return:

ItemList

public view(): * source

Return:

*

Protected Methods

protected show(user: User) source

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

Params:

NameTypeAttributeDescription
user User