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

Navigation

Extends:

flarum/Component~Component → Navigation

The Navigation component displays a set of navigation buttons. Typically this is just a back button which pops the app's History. If the user is on the root page and there is no history to pop, then in some instances it may show a button that toggles the app's drawer.

If the app has a pane, it will also include a 'pin' button which toggles the pinned state of the pane.

Accepts the following props:

  • className The name of a class to set on the root element.
  • drawer Whether or not to show a button to toggle the app's drawer if there is no more history to pop.

Method Summary

Public Methods
public

config(isInitialized: *, context: *)

public

view(): *

Protected Methods
protected

Get the back button.

protected

Get the drawer toggle button.

protected

Get the pane pinned toggle button.

Public Methods

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

Params:

NameTypeAttributeDescription
isInitialized *
context *

public view(): * source

Return:

*

Protected Methods

protected getBackButton(): Object source

Get the back button.

Return:

Object

protected getDrawerButton(): Object | String source

Get the drawer toggle button.

Return:

Object | String

protected getPaneButton(): Object | String source

Get the pane pinned toggle button.

Return:

Object | String