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

Navigation

Extends:

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.

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

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

Override:

Component#view

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