---
title: Dropdowns
description: Toggle contextual overlays for displaying lists of links and more with the Bootstrap dropdown plugin.
toc: true
---

## Overview

Dropdowns are toggleable, contextual overlays for displaying lists of links and more. They’re made interactive with the included Bootstrap dropdown JavaScript plugin. They’re toggled by clicking, not by hovering; this is [an intentional design decision](https://markdotto.com/blog/bootstrap-explained-dropdowns/).

Dropdowns are built on a third party library, [Popper](https://popper.js.org/docs/v2/), which provides dynamic positioning and viewport detection. Be sure to include [popper.min.js]([[config:cdn.popper]]) before Bootstrap’s JavaScript or use `bootstrap.bundle.min.js` / `bootstrap.bundle.js` which contains Popper. Popper isn’t used to position dropdowns in navbars though as dynamic positioning isn’t required.

## Accessibility

The [WAI ARIA](https://www.w3.org/TR/wai-aria/) standard defines an actual [`role="menu"` widget](https://www.w3.org/TR/wai-aria/#menu), but this is specific to application-like menus which trigger actions or functions. ARIA menus can only contain menu items, checkbox menu items, radio button menu items, radio button groups, and sub-menus.

Bootstrap’s dropdowns, on the other hand, are designed to be generic and applicable to a variety of situations and markup structures. For instance, it is possible to create dropdowns that contain additional inputs and form controls, such as search fields or login forms. For this reason, Bootstrap does not expect (nor automatically add) any of the `role` and `aria-` attributes required for true ARIA menus. Authors will have to include these more specific attributes themselves.

However, Bootstrap does add built-in support for most standard keyboard menu interactions, such as the ability to move through individual `.dropdown-item` elements using the cursor keys and close the menu with the Esc key.

## Examples

Wrap the dropdown’s toggle (your button or link) and the dropdown menu within `.dropdown`, or another element that declares `position: relative;`. Ideally, you should use a `<button>` element as the dropdown trigger, but the plugin will work with `<a>` elements as well. The examples shown here use semantic `<ul>` elements where appropriate, but custom markup is supported.

### Single button

Any single `.btn` can be turned into a dropdown toggle with some markup changes. Here’s how you can put them to work with `<button>` elements:

<Example code={`
    
      Dropdown button

- Action
      
- Another action
      
- Something else here

`} />

While `<button>` is the recommended control for a dropdown toggle, there might be situations where you have to use an `<a>` element. If you do, we recommend adding a `role="button"` attribute to appropriately convey control’s purpose to assistive technologies such as screen readers.

<Example code={`
    
      Dropdown link

    <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>
    </ul>
  
`} />

The best part is you can do this with any button variant, too:

<Example showMarkup={false} code={`
    Primary

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

    Secondary

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

    Success

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

    Info

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

    Warning

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

    Danger

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

`} />

```html
<!-- Example single danger button -->
<div class="btn-group">
  <button type="button" class="btn btn-danger dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
    Danger
  </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 button

Similarly, create split button dropdowns with virtually the same markup as single button dropdowns, but with the addition of `.dropdown-toggle-split` for proper spacing around the dropdown caret.

We use this extra class to reduce the horizontal `padding` on either side of the caret by 25% and remove the `margin-left` that’s added for regular button dropdowns. Those extra changes keep the caret centered in the split button and provide a more appropriately sized hit area next to the main button.

<Example showMarkup={false} code={`
    Primary
    
      Toggle Dropdown

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

    Secondary
    
      Toggle Dropdown

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

    Success
    
      Toggle Dropdown

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

    Info
    
      Toggle Dropdown

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

    Warning
    
      Toggle Dropdown

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

    Danger
    
      Toggle Dropdown

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

`} />

```html
<!-- Example split danger button -->
<div class="btn-group">
  <button type="button" class="btn btn-danger">Danger</button>
  <button type="button" class="btn btn-danger dropdown-toggle dropdown-toggle-split" data-bs-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>
```

## Sizing

Button dropdowns work with buttons of all sizes, including default and split dropdown buttons.

<Example showMarkup={false} code={`
    
      Large button

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

    Large split button
    
      Toggle Dropdown

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

`} />

```html
<!-- Large button groups (default and split) -->
<div class="btn-group">
  <button class="btn btn-secondary btn-lg dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
    Large button
  </button>
  <ul class="dropdown-menu">
    ...
  </ul>
</div>
<div class="btn-group">
  <button class="btn btn-secondary btn-lg" type="button">
    Large split button
  </button>
  <button type="button" class="btn btn-lg btn-secondary dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
    <span class="visually-hidden">Toggle Dropdown</span>
  </button>
  <ul class="dropdown-menu">
    ...
  </ul>
</div>
```

<Example showMarkup={false} code={`
    
      Small button

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

    Small split button
    
      Toggle Dropdown

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

`} />

```html
<div class="btn-group">
  <button class="btn btn-secondary btn-sm dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
    Small button
  </button>
  <ul class="dropdown-menu">
    ...
  </ul>
</div>
<div class="btn-group">
  <button class="btn btn-secondary btn-sm" type="button">
    Small split button
  </button>
  <button type="button" class="btn btn-sm btn-secondary dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
    <span class="visually-hidden">Toggle Dropdown</span>
  </button>
  <ul class="dropdown-menu">
    ...
  </ul>
</div>
```

## Dark dropdowns

<DeprecatedIn version="5.3.0" />

Opt into darker dropdowns to match a dark navbar or custom style by adding `.dropdown-menu-dark` onto an existing `.dropdown-menu`. No changes are required to the dropdown items.

<CalloutDeprecatedDarkVariants component="dropdown-menu" />

<Example code={`
    
      Dropdown button

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

`} />

And putting it to use in a navbar:

<Example code={`
    
      Navbar

-             
              Dropdown

- Action
              
- Another action
              
- Something else here

`} />

## Directions

<Callout>
**Directions are flipped in RTL mode.** As such, `.dropstart` will appear on the right side.
</Callout>

### Centered

Make the dropdown menu centered below the toggle with `.dropdown-center` on the parent element.

<Example code={`
    
      Centered dropdown

- Action
      
- Action two
      
- Action three

`} />

### Dropup

Trigger dropdown menus above elements by adding `.dropup` to the parent element.

<Example showMarkup={false} code={`
    
      Dropup

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

    Split dropup
    
      Toggle Dropdown

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

`} />

```html
<!-- Default dropup button -->
<div class="btn-group dropup">
  <button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
    Dropup
  </button>
  <ul class="dropdown-menu">
    <!-- Dropdown menu links -->
  </ul>
</div>

<!-- Split dropup button -->
<div class="btn-group dropup">
  <button type="button" class="btn btn-secondary">
    Split dropup
  </button>
  <button type="button" class="btn btn-secondary dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
    <span class="visually-hidden">Toggle Dropdown</span>
  </button>
  <ul class="dropdown-menu">
    <!-- Dropdown menu links -->
  </ul>
</div>
```

### Dropup centered

Make the dropup menu centered above the toggle with `.dropup-center` on the parent element.

<Example code={`
    
      Centered dropup

- Action
      
- Action two
      
- Action three

`} />

### Dropend

Trigger dropdown menus at the right of the elements by adding `.dropend` to the parent element.

<Example showMarkup={false} code={`
    
      Dropend

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

    Split dropend
    
      Toggle Dropend

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

`} />

```html
<!-- Default dropend button -->
<div class="btn-group dropend">
  <button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
    Dropend
  </button>
  <ul class="dropdown-menu">
    <!-- Dropdown menu links -->
  </ul>
</div>

<!-- Split dropend button -->
<div class="btn-group dropend">
  <button type="button" class="btn btn-secondary">
    Split dropend
  </button>
  <button type="button" class="btn btn-secondary dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
    <span class="visually-hidden">Toggle Dropend</span>
  </button>
  <ul class="dropdown-menu">
    <!-- Dropdown menu links -->
  </ul>
</div>
```

### Dropstart

Trigger dropdown menus at the left of the elements by adding `.dropstart` to the parent element.

<Example showMarkup={false} code={`
    
      Dropstart

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link

      Toggle Dropstart

- Action
      
- Another action
      
- Something else here
      
- 

- Separated link
    
    Split dropstart
  
`} />

```html
<!-- Default dropstart button -->
<div class="btn-group dropstart">
  <button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
    Dropstart
  </button>
  <ul class="dropdown-menu">
    <!-- Dropdown menu links -->
  </ul>
</div>

<!-- Split dropstart button -->
<div class="btn-group dropstart">
  <button type="button" class="btn btn-secondary dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
    <span class="visually-hidden">Toggle Dropstart</span>
  </button>
  <ul class="dropdown-menu">
    <!-- Dropdown menu links -->
  </ul>
  <button type="button" class="btn btn-secondary">
    Split dropstart
  </button>
</div>
```

## Menu items

You can use `<a>` or `<button>` elements as dropdown items.

<Example code={`
    
      Dropdown

- Action
      
- Another action
      
- Something else here

`} />

You can also create non-interactive dropdown items with `.dropdown-item-text`. Feel free to style further with custom CSS or text utilities.

<Example code={`
    
- Dropdown item text
    
- Action
    
- Another action
    
- Something else here
  
`} />

### Active

Add `.active` to items in the dropdown to **style them as active**. To convey the active state to assistive technologies, use the `aria-current` attribute — using the `page` value for the current page, or `true` for the current item in a set.

<Example code={`
    
- Regular link
    
- Active link
    
- Another link
  
`} />

### Disabled

Add `.disabled` to items in the dropdown to **style them as disabled**.

<Example code={`
    
- Regular link
    
- Disabled link
    
- Another link
  
`} />

## Menu alignment

By default, a dropdown menu is automatically positioned 100% from the top and along the left side of its parent. You can change this with the directional `.drop*` classes, but you can also control them with additional modifier classes.

Add `.dropdown-menu-end` to a `.dropdown-menu` to right align the dropdown menu. Directions are mirrored when using Bootstrap in RTL, meaning `.dropdown-menu-end` will appear on the left side.

<Callout>
**Heads up!** Dropdowns are positioned thanks to Popper except when they are contained in a navbar.
</Callout>

<Example code={`
    
      Right-aligned menu example

- Action
      
- Another action
      
- Something else here

`} />

### Responsive alignment

If you want to use responsive alignment, disable dynamic positioning by adding the `data-bs-display="static"` attribute and use the responsive variation classes.

To align **right** the dropdown menu with the given breakpoint or larger, add `.dropdown-menu{-sm|-md|-lg|-xl|-xxl}-end`.

<Example code={`
    
      Left-aligned but right aligned when large screen

- Action
      
- Another action
      
- Something else here

`} />

To align **left** the dropdown menu with the given breakpoint or larger, add `.dropdown-menu-end` and `.dropdown-menu{-sm|-md|-lg|-xl|-xxl}-start`.

<Example code={`
    
      Right-aligned but left aligned when large screen

- Action
      
- Another action
      
- Something else here

`} />

Note that you don’t need to add a `data-bs-display="static"` attribute to dropdown buttons in navbars, since Popper isn’t used in navbars.

### Alignment options

Taking most of the options shown above, here’s a small kitchen sink demo of various dropdown alignment options in one place.

<Example code={`
    
      Dropdown

- Menu item
      
- Menu item
      
- Menu item

      Right-aligned menu

- Menu item
      
- Menu item
      
- Menu item

      Left-aligned, right-aligned lg

- Menu item
      
- Menu item
      
- Menu item

      Right-aligned, left-aligned lg

- Menu item
      
- Menu item
      
- Menu item

      Dropstart

- Menu item
      
- Menu item
      
- Menu item

      Dropend

- Menu item
      
- Menu item
      
- Menu item

      Dropup

- Menu item
      
- Menu item
      
- Menu item

`} />

## Menu content

### Headers

Add a header to label sections of actions in any dropdown menu.

<Example code={`
    
- 
Dropdown header

- Action
    
- Another action
  
`} />

### Dividers

Separate groups of related menu items with a divider.

<Example code={`
    
- Action
    
- Another action
    
- Something else here
    
- 

- Separated link
  
`} />

### Text

Place any freeform text within a dropdown menu with text and use [spacing utilities]([[docsref:/utilities/spacing]]). Note that you’ll likely need additional sizing styles to constrain the menu width.

<Example code={`
    
      Some example text that’s free-flowing within the dropdown menu.

      And this is more example text.

`} />

### Forms

Put a form within a dropdown menu, or make it into a dropdown menu, and use [margin or padding utilities]([[docsref:/utilities/spacing]]) to give it the negative space you require.

<Example code={`

        Email address

        Password

            Remember me

      Sign in

    New around here? Sign up
    Forgot password?
  
`} />

<Example code={`
    
      Dropdown form

        Email address

        Password

            Remember me

      Sign in

`} />

## Dropdown options

Use `data-bs-offset` or `data-bs-reference` to change the location of the dropdown.

<Example code={`

        Offset

- Action
        
- Another action
        
- Something else here

      Reference
      
        Toggle Dropdown

- Action
        
- Another action
        
- Something else here
        
- 

- Separated link

`} />

### Auto close behavior

By default, the dropdown menu is closed when clicking inside or outside the dropdown menu. You can use the `autoClose` option to change this behavior of the dropdown.

<Example code={`
    
      Default dropdown

- Menu item
      
- Menu item
      
- Menu item

      Clickable inside

- Menu item
      
- Menu item
      
- Menu item

      Clickable outside

- Menu item
      
- Menu item
      
- Menu item

      Manual close

- Menu item
      
- Menu item
      
- Menu item

`} />

## CSS

### Variables

<AddedIn version="5.2.0" />

As part of Bootstrap’s evolving CSS variables approach, dropdowns now use local CSS variables on `.dropdown-menu` for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.

<ScssDocs name="dropdown-css-vars" file="scss/_dropdown.scss" />

<Callout>
Dropdown items include at least one variable that is not set on `.dropdown`. This allows you to provide a new value while Bootstrap defaults to a fallback value.

- `--bs-dropdown-item-border-radius`
</Callout>

Customization through CSS variables can be seen on the `.dropdown-menu-dark` class where we override specific values without adding duplicate CSS selectors.

<ScssDocs name="dropdown-dark-css-vars" file="scss/_dropdown.scss" />

### Sass variables

Variables for all dropdowns:

<ScssDocs name="dropdown-variables" file="scss/_variables.scss" />

Variables for the [dark dropdown](#dark-dropdowns):

<ScssDocs name="dropdown-dark-variables" file="scss/_variables.scss" />

Variables for the CSS-based carets that indicate a dropdown’s interactivity:

<ScssDocs name="caret-variables" file="scss/_variables.scss" />

### Sass mixins

Mixins are used to generate the CSS-based carets and can be found in `scss/mixins/_caret.scss`.

<ScssDocs name="caret-mixins" file="scss/mixins/_caret.scss" />

## Usage

Via data attributes or JavaScript, the dropdown plugin toggles hidden content (dropdown menus) by toggling the `.show` class on the parent `.dropdown-menu`. The `data-bs-toggle="dropdown"` attribute is relied on for closing dropdown menus at an application level, so it’s a good idea to always use it.

<Callout>
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](https://www.quirksmode.org/blog/archives/2014/02/mouse_event_bub.html), 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.
</Callout>

### Via data attributes

Add `data-bs-toggle="dropdown"` to a link or button to toggle a dropdown.

```html
<div class="dropdown">
  <button type="button" data-bs-toggle="dropdown" aria-expanded="false">
    Dropdown trigger
  </button>
  <ul class="dropdown-menu">
    ...
  </ul>
</div>
```

### Via JavaScript

<Callout type="warning">
Dropdowns must have `data-bs-toggle="dropdown"` on their trigger element, regardless of whether you call your dropdown via JavaScript or use the data-api.
</Callout>

Call the dropdowns via JavaScript:

```js
const dropdownElementList = document.querySelectorAll('.dropdown-toggle')
const dropdownList = [...dropdownElementList].map(dropdownToggleEl => new bootstrap.Dropdown(dropdownToggleEl))
```

### Options

<JsDataAttributes />

<BsTable>
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `autoClose` | boolean, string | `true` | Configure the auto close behavior of the dropdown: 

- `true` - the dropdown will be closed by clicking outside or inside the dropdown menu.
- `false` - the dropdown will be closed by clicking the toggle button and manually calling `hide` or `toggle` method. (Also will not be closed by pressing Esc key)
- `'inside'` - the dropdown will be closed (only) by clicking inside the dropdown menu. 
- `'outside'` - the dropdown will be closed (only) by clicking outside the dropdown menu.
 Note: the dropdown can always be closed with the Esc key. |
| `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](https://popper.js.org/docs/v2/utils/detect-overflow/#boundary). |
| `display` | string | `'dynamic'` | By default, we use Popper for dynamic positioning. Disable this with `static`. |
| `offset` | array, string, function | `[0, 2]` | Offset of the dropdown relative to its target. You can pass a string in data attributes with comma separated values like: `data-bs-offset="10,20"`. When a function is used to determine the offset, it is called with an object containing the popper placement, the reference, and popper rects as its first argument. The triggering element DOM node is passed as the second argument. The function must return an array with two numbers: [skidding](https://popper.js.org/docs/v2/modifiers/offset/#skidding-1), [distance](https://popper.js.org/docs/v2/modifiers/offset/#distance-1). For more information refer to Popper’s [offset docs](https://popper.js.org/docs/v2/modifiers/offset/#options). |
| `popperConfig` | null, object, function | `null` | To change Bootstrap’s default Popper config, see [Popper’s configuration](https://popper.js.org/docs/v2/constructors/#options). 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](https://popper.js.org/docs/v2/constructors/#createpopper) and [virtual element docs](https://popper.js.org/docs/v2/virtual-elements/). |
</BsTable>

#### Using function with `popperConfig`

```js
const dropdown = new bootstrap.Dropdown(element, {
  popperConfig(defaultBsPopperConfig) {
    // const newPopperConfig = {...}
    // use defaultBsPopperConfig if needed...
    // return newPopperConfig
  }
})
```

### Methods

<BsTable>
| Method | Description |
| --- | --- |
| `dispose` | Destroys an element’s dropdown. (Removes stored data on the DOM element) |
| `getInstance` | Static method which allows you to get the dropdown instance associated to a DOM element, you can use it like this: `bootstrap.Dropdown.getInstance(element)`. |
| `getOrCreateInstance` | Static method which returns a dropdown instance associated to a DOM element or create a new one in case it wasn’t initialized. You can use it like this: `bootstrap.Dropdown.getOrCreateInstance(element)`. |
| `hide` | Hides the dropdown menu of a given navbar or tabbed navigation. |
| `show` | Shows the dropdown menu of a given navbar or tabbed navigation. |
| `toggle` | Toggles the dropdown menu of a given navbar or tabbed navigation. |
| `update` | Updates the position of an element’s dropdown. |
</BsTable>

### 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.bs.dropdown` and `hidden.bs.dropdown` events have a `clickEvent` property (only when the original Event type is `click`) that contains an Event Object for the click event.

<BsTable>
| Event type | Description |
| --- | --- |
| `hide.bs.dropdown` | Fires immediately when the `hide` instance method has been called. |
| `hidden.bs.dropdown` | Fired when the dropdown has finished being hidden from the user and CSS transitions have completed. |
| `show.bs.dropdown` | Fires immediately when the `show` instance method is called. |
| `shown.bs.dropdown` | Fired when the dropdown has been made visible to the user and CSS transitions have completed. |
</BsTable>

```js
const myDropdown = document.getElementById('myDropdown')
myDropdown.addEventListener('show.bs.dropdown', event => {
  // do something...
})
```
