Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

Index

Constructors

constructor

Properties

attrs

The attributes passed into the component.

see

https://mithril.js.org/components.html#passing-data-to-components

element

element: Element

The root DOM element for the component.

state

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.

    final

    Parameters

    • Optional selector: string

    Returns JQuery<HTMLElement>

    the jQuery object for the DOM node

Protected getBackButton

  • getBackButton(): Children

Protected getDrawerButton

  • getDrawerButton(): Children

Protected getPaneButton

  • getPaneButton(): Children

onbeforeremove

onbeforeupdate

oncreate

oninit

onremove

onupdate

view

  • view(): Element

Static component

  • component<SAttrs>(attrs?: SAttrs, children?: Children): Vnode<{}, {}>

Static initAttrs

  • initAttrs<T>(attrs: T): void

Generated using TypeDoc version 0.22.10