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


  • 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'.
  • accessibleToggleLabel The label used to describe the dropdown toggle button to assistive readers. Defaults to 'Toggle dropdown menu'.
  • onhide
  • onshow

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




The attributes passed into the component.


element: Element

The root DOM element for the component.

showing: undefined | boolean
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