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

PostsUserPage

Extends:

ComponentPageUserPage → PostsUserPage

The PostsUserPage component shows a user's activity feed inside of their profile.

Member Summary

Public Members
public

loadLimit: Integer

The number of activity items to load per request.

public

Whether or not the activity feed is currently loading.

public

Whether or not there are any more activity items that can be loaded.

public

posts: Post[]

The Post models in the feed.

Method Summary

Public Methods
public

content(): *

public

init()

public

Load the next page of results.

public

parseResults(results: Post[]): Post[]

Parse results and append them to the activity feed.

public

Clear and reload the user's activity feed.

public

show(user: *)

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

Protected Methods
protected

loadResults(offset: Integer): Promise

Load a new page of the user's activity feed.

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 Members

public loadLimit: Integer source

The number of activity items to load per request.

public loading: Boolean source

Whether or not the activity feed is currently loading.

public moreResults: Boolean source

Whether or not there are any more activity items that can be loaded.

public posts: Post[] source

The Post models in the feed.

Public Methods

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 loadMore() source

Load the next page of results.

public parseResults(results: Post[]): Post[] source

Parse results and append them to the activity feed.

Params:

NameTypeAttributeDescription
results Post[]

Return:

Post[]

public refresh() source

Clear and reload the user's activity feed.

public show(user: *) source

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

Override:

UserPage#show

Params:

NameTypeAttributeDescription
user *

Protected Methods

protected loadResults(offset: Integer): Promise source

Load a new page of the user's activity feed.

Params:

NameTypeAttributeDescription
offset Integer
  • optional

The position to start getting results from.

Return:

Promise