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

NotificationList

Extends:

Component → NotificationList

The NotificationList component displays a list of the logged-in user's notifications, grouped by discussion.

Member Summary

Public Members
public

Whether or not the notifications are loading.

public

Whether or not there are more results that can be loaded.

Method Summary

Public Methods
public

config(isInitialized: *, context: *)

public

init()

public

load()

Load notifications into the application's cache if they haven't already been loaded.

public

loadMore(): *

Load the next page of notification results.

public

Mark all of the notifications as read.

public

Parse results and append them to the notification list.

public

view(): *

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.

Public Members

public loading: Boolean source

Whether or not the notifications are loading.

public moreResults: Boolean source

Whether or not there are more results that can be loaded.

Public Methods

public config(isInitialized: *, context: *) source

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.

Override:

Component#config

Params:

NameTypeAttributeDescription
isInitialized *
context *

public init() source

Called when the component is constructed.

Override:

Component#init

public load() source

Load notifications into the application's cache if they haven't already been loaded.

public loadMore(): * source

Load the next page of notification results.

Return:

*

public markAllAsRead() source

Mark all of the notifications as read.

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

Parse results and append them to the notification list.

Params:

NameTypeAttributeDescription
results Notification[]

Return:

Notification[]

public view(): * source

Get the virtual DOM that represents the component's view.

Override:

Component#view

Return:

*