Dropdowns
Bootstrap 5 Dropdown component
Responsive dropdown/caret built with Bootstrap 5. Examples of navbar dropdown, dropdown list, submenu, dropdown toggle, dropdown hover, hamburger icon & more.
Dropdowns are responsible for toggleable (collapsible) display a list of links.
Toggle contextual overlays for displaying lists of links and more with the MDB dropdown plugin.
Note: Read the API tab to find all available options and advanced customization
Basic examples
Wrap the dropdown’s toggle (your button or link) and the dropdown menu within
.dropdown
element that declares position: relative;
. Dropdowns can be
triggered from <a>
or <button>
elements to better fit
your potential needs. The examples shown here use semantic <ul>
elements
where appropriate, but custom markup is supported.
Colors
You can do this with any button variant:
<!-- Primary -->
<div class="btn-group">
<button type="button" class="btn btn-primary dropdown-toggle" data-mdb-toggle="dropdown" aria-expanded="false">
Action
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<!-- Secondary -->
<div class="btn-group">
<button type="button" class="btn btn-primary dropdown-toggle" data-mdb-toggle="dropdown" aria-expanded="false">
Action
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<!-- Success -->
<div class="btn-group">
<button type="button" class="btn btn-success dropdown-toggle" data-mdb-toggle="dropdown" aria-expanded="false">
Action
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<!-- Info -->
<div class="btn-group">
<button type="button" class="btn btn-info dropdown-toggle" data-mdb-toggle="dropdown" aria-expanded="false">
Action
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<!-- Warning -->
<div class="btn-group">
<button type="button" class="btn btn-warning dropdown-toggle" data-mdb-toggle="dropdown" aria-expanded="false">
Action
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<!-- Danger -->
<div class="btn-group">
<button type="button" class="btn btn-danger dropdown-toggle" data-mdb-toggle="dropdown" aria-expanded="false">
Action
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<!-- Danger -->
<div class="btn-group">
<button type="button" class="btn btn-danger dropdown-toggle" data-mdb-toggle="dropdown" aria-expanded="false">
Action
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<!-- Dark -->
<div class="btn-group">
<button type="button" class="btn btn-dark dropdown-toggle" data-mdb-toggle="dropdown" aria-expanded="false">
Action
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<!-- Light -->
<div class="btn-group shadow-0">
<button type="button" class="btn btn-light dropdown-toggle" data-mdb-toggle="dropdown" aria-expanded="false">
Action
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<!-- Link -->
<div class="btn-group shadow-0">
<button type="button" class="btn btn-link dropdown-toggle" data-mdb-toggle="dropdown" aria-expanded="false">
Action
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
Sizing
Button dropdowns work with buttons of all sizes, including default and split dropdown buttons.
<!-- Large button groups (default and split) -->
<div class="btn-group">
<button
class="btn btn-primary btn-lg dropdown-toggle"
type="button"
data-mdb-toggle="dropdown"
aria-expanded="false"
>
Large button
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<div class="btn-group">
<button class="btn btn-primary btn-lg" type="button">Large split button</button>
<button
type="button"
class="btn btn-lg btn-primary dropdown-toggle dropdown-toggle-split"
data-mdb-toggle="dropdown"
aria-expanded="false"
>
<span class="visually-hidden">Toggle Dropdown</span>
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<!-- Small button groups (default and split) -->
<div class="btn-group">
<button class="btn btn-primary btn-sm dropdown-toggle" type="button" data-mdb-toggle="dropdown" aria-expanded="false">
Small button
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<div class="btn-group">
<button class="btn btn-primary btn-sm" type="button">Small split button</button>
<button
type="button"
class="btn btn-sm btn-primary dropdown-toggle dropdown-toggle-split"
data-mdb-toggle="dropdown"
aria-expanded="false"
>
<span class="visually-hidden">Toggle Dropdown</span>
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
Directions
Dropup
Trigger dropdown menus above elements by adding .dropup
to the parent element.
<!-- Default dropup button -->
<div class="btn-group dropup">
<button type="button" class="btn btn-primary dropdown-toggle" data-mdb-toggle="dropdown" aria-expanded="false">
Dropup
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<!-- Split dropup button -->
<div class="btn-group dropup">
<button type="button" class="btn btn-primary">Split dropup</button>
<button
type="button"
class="btn btn-primary dropdown-toggle dropdown-toggle-split"
data-mdb-toggle="dropdown"
aria-expanded="false"
>
<span class="visually-hidden">Toggle Dropdown</span>
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
Dropright
Trigger dropdown menus at the right of the elements by adding
.dropend
to the parent element.
<!-- Default dropright button -->
<div class="btn-group dropend">
<button type="button" class="btn btn-primary dropdown-toggle" data-mdb-toggle="dropdown" aria-expanded="false">
Dropright
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<!-- Split dropright button -->
<div class="btn-group dropend">
<button type="button" class="btn btn-primary">Split dropright</button>
<button
type="button"
class="btn btn-primary dropdown-toggle dropdown-toggle-split"
data-mdb-toggle="dropdown"
aria-expanded="false"
>
<span class="visually-hidden">Toggle Dropright</span>
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
Dropleft
Trigger dropdown menus at the left of the elements by adding
.dropstart
to the parent element.
<!-- Default dropleft button -->
<div class="btn-group dropstart">
<button type="button" class="btn btn-primary dropdown-toggle" data-mdb-toggle="dropdown" aria-expanded="false">
Dropleft
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<!-- Split dropleft button -->
<div class="btn-group">
<div class="btn-group dropstart" role="group">
<button
type="button"
class="btn btn-primary dropdown-toggle dropdown-toggle-split"
data-mdb-toggle="dropdown"
aria-expanded="false"
>
<span class="visually-hidden">Toggle Dropleft</span>
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
<button type="button" class="btn btn-primary">Split dropleft</button>
</div>
Remove animation
To remove the fade animation on click, add
data-mdb-dropdown-animation="off"
attribute to the dropdown button.
<div class="dropdown">
<button
class="btn btn-primary dropdown-toggle"
type="button"
id="dropdownExampleAnimation"
data-mdb-toggle="dropdown"
aria-expanded="false"
data-mdb-dropdown-animation="off"
>
Dropdown button
</button>
<ul class="dropdown-menu" aria-labelledby="dropdownExampleAnimation">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
</ul>
</div>
Dropdown options
Use data-mdb-offset
or data-mdb-reference
to change the location of
the dropdown.
<div class="d-flex">
<div class="dropdown me-1">
<button
type="button"
class="btn btn-primary dropdown-toggle"
id="dropdownMenuOffset"
data-mdb-toggle="dropdown"
aria-expanded="false"
data-mdb-offset="10,20"
>
Offset
</button>
<ul class="dropdown-menu" aria-labelledby="dropdownMenuOffset">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
</ul>
</div>
<div class="btn-group">
<button type="button" class="btn btn-primary">Reference</button>
<button
type="button"
class="btn btn-primary dropdown-toggle dropdown-toggle-split"
id="dropdownMenuReference"
data-mdb-toggle="dropdown"
aria-expanded="false"
data-mdb-reference="parent"
>
<span class="visually-hidden">Toggle Dropdown</span>
</button>
<ul class="dropdown-menu" aria-labelledby="dropdownMenuReference">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
</div>
Dark variant
Add .dropdown-menu-dark
onto an existing .dropdown-menu
to match a
dark navbar.
<div class="dropdown">
<button
class="btn btn-secondary dropdown-toggle"
type="button"
id="dropdownMenuButton2"
data-mdb-toggle="dropdown"
aria-expanded="false"
>
Dropdown button
</button>
<ul class="dropdown-menu dropdown-menu-dark" aria-labelledby="dropdownMenuButton2">
<li><a class="dropdown-item active" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider" /></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
Dropdowns - API
Usage
Via data attributes or JavaScript, the dropdown plugin toggles hidden content (dropdown menus)
by toggling the .show
class on the parent list item. The
data-mdb-toggle="dropdown"
attribute is relied on for closing dropdown menus at
an application level, so it’s a good idea to always use it.
Note:
On touch-enabled devices, opening a dropdown adds empty
mouseover
handlers to the immediate children of the
<body>
element. This admittedly ugly hack is necessary to work around a
quirk in iOS’ event delegation, which would otherwise prevent a tap anywhere outside of the dropdown from triggering the
code that closes the dropdown. Once the dropdown is closed, these additional empty
mouseover
handlers are removed.
Via data attributes
Add data-mdb-toggle="dropdown"
to a link or button to toggle a dropdown.
<div class="dropdown">
<button id="dLabel" type="button" data-mdb-toggle="dropdown" aria-expanded="false">
Dropdown trigger
</button>
<ul class="dropdown-menu" aria-labelledby="dLabel">
...
</ul>
</div>
Via JavaScript
Call the dropdowns via JavaScript:
const dropdownElementList = [].slice.call(document.querySelectorAll('.dropdown-toggle'));
const dropdownList = dropdownElementList.map((dropdownToggleEl) => {
return new mdb.Dropdown(dropdownToggleEl);
});
data-mdb-toggle="dropdown"
still required:
Regardless of whether you call your dropdown via JavaScript or instead use the data-mdb-api,
data-mdb-toggle="dropdown"
is always required to be present on the dropdown’s
trigger element.
Options
Options can be passed via data attributes or JavaScript. For data attributes, append the
option name to data-mdb-
, as in data-mdb-offset=""
.
Name | Type | Default | Description |
---|---|---|---|
autoClose |
boolean | string | true |
Configure the auto close behavior of the dropdown:
|
boundary |
string | element | 'clippingParents' |
Overflow constraint boundary of the dropdown menu (applies only to Popper's
preventOverflow modifier). By default it's
'clippingParents' and can accept an HTMLElement reference (via JavaScript
only). For more information refer to Popper's
detectOverflow docs.
|
display |
string | 'dynamic' |
By default, we use Popper for dynamic positioning. Disable this with
static .
|
dropdownAnimation |
string | 'on' |
Turn on / off dropdown animation. |
offset |
array | string | function | 0 |
Offset of the dropdown relative to its target. When a function is used to determine the offset, it is called with an object containing the offset data as its first argument. The function must return an object with the same structure. The triggering element DOM node is passed as the second argument. For more information refer to Popper's offset docs. |
popperConfig |
null | object | function | null |
To change Bootstrap's default Popper config, see Popper's configuration. When a function is used to create the Popper configuration, it's called with an object that contains the Bootstrap's default Popper configuration. It helps you use and merge the default with your own configuration. The function must return a configuration object for Popper. |
reference |
string | element | object | 'toggle' |
Reference element of the dropdown menu. Accepts the values of 'toggle' ,
'parent' , an HTMLElement reference or an object providing
getBoundingClientRect . For more information refer to Popper's
constructor docs
and virtual element docs.
|
Note when boundary
is set to any value other than 'scrollParent'
,
the style position: static
is applied to the .dropdown
container.
Methods
Method | Description |
---|---|
toggle |
Toggles the dropdown menu of a given navbar or tabbed navigation. |
show |
Shows the dropdown menu of a given navbar or tabbed navigation. |
hide |
Hides the dropdown menu of a given navbar or tabbed navigation. |
update |
Updates the position of an element's dropdown. |
dispose |
Destroys an element's dropdown. |
getInstance |
Static method which allows you to get the dropdown instance associated with a DOM element. |
const myDropdown = document.getElementById('myDropdown');
const myDropdownInstance = new mdb.Dropdown(myDropdown);
myDropdownInstance.show();
Events
All dropdown events are fired at the toggling element and then bubbled up. So you can also add
event listeners on the .dropdown-menu
’s parent element.
hide.mdb.dropdown
and hidden.mdb.dropdown
events have a
clickEvent
property (only when the original Event type is click
)
that contains an Event Object for the click event.
Method | Description |
---|---|
show.mdb.dropdown
|
Fires immediately when the show instance method is called. |
shown.mdb.dropdown
|
Fired when the dropdown has been made visible to the user and CSS transitions have completed. |
hide.mdb.dropdown
|
Fires immediately when the hide instance method has been called. |
hidden.mdb.dropdown
|
Fired when the dropdown has finished being hidden from the user and CSS transitions have completed. |
const myDropdown = document.getElementById('myDropdown');
myDropdown.addEventListener('show.mdb.dropdown', () => {
// do something...
});
Import
MDB UI KIT also works with module bundlers. Use the following code to import this component:
import { Dropdown } from 'mdb-ui-kit';