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

Notification

Extends:

Component → Notification

The Notification component abstract displays a single notification. Subclasses should implement the icon, href, and content methods.

Props

  • notification

Method Summary

Public Methods
public abstract

content(): VirtualElement

Get the content of the notification.

public abstract

excerpt(): VirtualElement

Get the excerpt of the notification.

public abstract

Get the URL that the notification should link to.

public abstract

Get the name of the icon that should be displayed in the notification.

public

Mark the notification as read.

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 Methods

public abstract content(): VirtualElement source

Get the content of the notification.

Return:

VirtualElement

public abstract excerpt(): VirtualElement source

Get the excerpt of the notification.

Return:

VirtualElement

public abstract href(): String source

Get the URL that the notification should link to.

Return:

String

public abstract icon(): String source

Get the name of the icon that should be displayed in the notification.

Return:

String

public markAsRead() source

Mark the notification as read.

public view(): * source

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

Override:

Component#view

Return:

*