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

LinkButton

Extends:

ComponentButton → LinkButton

Direct Subclass:

AdminLinkButton

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

Props

All of the props 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.

Static Method Summary

Static Public Methods
public static

initProps(props: *)

public static

Determine whether a component with the given props is 'active'.

Method Summary

Public Methods
public

view(): *

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.

From class Button
public

view(): *

protected

Get the template for the button's content.

Static Public Methods

public static initProps(props: *) source

Initialize the component's props.

Override:

Component#initProps

Params:

NameTypeAttributeDescription
props *

public static isActive(props: Object): Boolean source

Determine whether a component with the given props is 'active'.

Params:

NameTypeAttributeDescription
props Object

Return:

Boolean

Public Methods

public view(): * source

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

Override:

Button#view

Return:

*