The LinkButton component defines a Button which links to a route.


All of the attrs accepted by Button, plus:

  • active Whether or not the page that this button links to is currently active.
  • href The URL to link to. If the current URL m.route() matches this, the active prop will automatically be set to true.
  • force Whether the page should be fully rerendered. Defaults to true.




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.


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


    the jQuery object for the DOM node



    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

Generated using TypeDoc v0.23.24