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

Dropdown

Extends:

Component → Dropdown

Indirect Subclass:

SettingDropdown

The Dropdown component displays a button which, when clicked, shows a dropdown menu beneath it.

Props

  • buttonClassName A class name to apply to the dropdown toggle button.
  • menuClassName A class name to apply to the dropdown menu.
  • icon The name of an icon to show in the dropdown toggle button.
  • caretIcon The name of an icon to show on the right of the button.
  • label The label of the dropdown toggle button. Defaults to 'Controls'.
  • onhide
  • onshow

The children will be displayed as a list inside of the dropdown menu.

Static Method Summary

Static Public Methods
public static

initProps(props: *)

Member Summary

Public Members
public

Method Summary

Public Methods
public

config(isInitialized: *)

public

getMenu(items: *): *

public

init()

public

view(): *

Protected Methods
protected

getButton(): *

Get the template for the button.

protected

Get the template for the button's content.

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.

Static Public Methods

public static initProps(props: *) source

Initialize the component's props.

Override:

Component#initProps

Params:

NameTypeAttributeDescription
props *

Public Members

public showing: boolean source

Public Methods

public config(isInitialized: *) 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 *

public getMenu(items: *): * source

Params:

NameTypeAttributeDescription
items *

Return:

*

public init() source

Called when the component is constructed.

Override:

Component#init

public view(): * source

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

Override:

Component#view

Return:

*

Protected Methods

protected getButton(): * source

Get the template for the button.

Return:

*

protected getButtonContent(): * source

Get the template for the button's content.

Return:

*