Reference Source
import ForumApp from 'flarum/ForumApp.js'
public class | source

ForumApp

Extends:

flarum/App~App → ForumApp

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

An object which controls the state of the page's drawer.

public

The app's history stack, which keeps track of which routes the user visits so that they can easily navigate back to the previous route.

public

A map of notification types to their components.

public

An object which controls the state of the page's side pane.

public

A map of post types to their components.

public

search: SearchBox

The page's search component instance.

Method Summary

Public Methods
public

Check whether or not the user is currently composing a reply to a discussion.

public

Check whether or not the user is currently viewing a discussion.

Public Constructors

public constructor() source

Public Members

public drawer: Drawer source

An object which controls the state of the page's drawer.

public history: History source

The app's history stack, which keeps track of which routes the user visits so that they can easily navigate back to the previous route.

public notificationComponents: Object source

A map of notification types to their components.

public pane: Pane source

An object which controls the state of the page's side pane.

public postComponents: Object source

A map of post types to their components.

The page's search component instance.

Public Methods

public composingReplyTo(discussion: Discussion): Boolean source

Check whether or not the user is currently composing a reply to a discussion.

Params:

NameTypeAttributeDescription
discussion Discussion

Return:

Boolean

public viewingDiscussion(discussion: Discussion): Boolean source

Check whether or not the user is currently viewing a discussion.

Params:

NameTypeAttributeDescription
discussion Discussion

Return:

Boolean