import Navigation from 'flarum/common/components/Navigation'

public class | source

Navigation

Extends:

src/common/Component.js~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 attrs:

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	view(): *

Protected Methods
protected	getBackButton(): Object Get the back button.
protected	getDrawerButton(): Object \| String Get the drawer toggle button.
protected	getPaneButton(): Object \| String Get the pane pinned toggle button.

Public Methods

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