Flarum (2.x)
    Preparing search index...

    The Navigation component displays a set of navigation buttons. In drawer mode — the fixed control strip at the top of the mobile layout — the drawer toggle is always present, so the menu and the notification badge it carries stay reachable on every page; the back button joins it only when there is history to pop. Elsewhere (the desktop header) it is the back button alone.

    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.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    The attributes passed into the component.

    element: Element

    The root DOM element for the component.

    state: undefined

    Class component state that is persisted between redraws.

    Updating this will not automatically trigger a redraw, unlike other frameworks.

    This is different to Vnode state, which is always an instance of your class component.

    This is undefined by default.

    Methods

    • 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.

      Parameters

      • Optionalselector: string

        a jQuery-compatible selector string

      Returns JQuery

      the jQuery object for the DOM node