Are you ready for Cyber ~~Monday~~ Week Deals?

Extra 25% off for all sale items + Free CoreUI Icons PRO with every order! Limited offer for the first 100 people, use code 2024BWCW25 during checkout.

On this page

Angular Dropdown Component

Angular Dropdown component allows you to toggle contextual overlays for displaying lists, links, and more html elements.

## Overview Dropdowns are toggleable, contextual overlays for displaying lists of links and more. Dropdowns are built on a third party library, [Popper.js](https://popper.js.org/), which provides dynamic positioning and viewport detection. Popper.js isn't used to position dropdowns in navbars though as dynamic positioning isn't required. ## Examples Bind the dropdown toggle and the dropdown menu inside `c-dropdown`, or different element that declares `position: relative;`. Dropdowns can be triggered from `a` or `button` elements to better fit your possible requirements. ### Single button Here's how you can put them to work with either `button` elements:

And with `a` elements:

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

### Split button

Similarly, create split button dropdowns with virtually the same markup as single button dropdowns, but with the addition of boolean prop `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 attached for normal button dropdowns. Those additional changes hold the caret centered in the split button and implement a more properly sized hit area next to the main button.

### Sizing

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

### Dark dropdowns

Opt into darker dropdowns to match a dark navbar or custom style by set `dark` property. No changes are required to the dropdown items.

And putting it to use in a navbar:

## Directions

RTL

Directions are mirrored when using CoreUI in RTL, meaning `dropstart` will appear on the right side.

### Centered Trigger dropdown menus centered below the toggle by adding `direction="center"` to the `c-dropdown`component.

### Dropup Trigger dropdown menus above elements by adding `direction="dropup"` to the `c-dropdown` component.

### Dropup Centered Trigger dropup menu centered above the toggle by adding `direction="dropup-center"` to the `c-dropdown`component.

### Dropright Trigger dropdown menus at the right of the elements by adding `direction="dropend"` to the `c-dropdown`component.

### Dropleft Trigger dropdown menus at the left of the elements by adding `direction="dropstart"` to the `c-dropdown`component.

## Menu items Historically dropdown menu contents had to be links, but that's no longer the case with v4. Now you can optionally use `button` elements in your dropdowns instead of just `a`.

You can also create non-interactive dropdown items with `cDropdownItemText`.

### Active Set boolean property `active` to style item as active.

### Disabled Add `disabled` boolean property to items in the dropdown to style them as disabled.

## Menu alignment By default, a dropdown menu is automatically positioned 100% from the top and along the left side of its parent. Add `aligment="end"` to right align the dropdown menu.

Heads up! Dropdowns are positioned thanks to Popper.js.

## Menu content ### Headers Add a header to label sections of actions in any dropdown menu. In the following example we use div without `cDropdownMenu` to show dropdown menu content.

### Dividers Separate groups of related menu items with a divider. In the following example we use div without `cDropdownMenu` to show dropdown menu content.

### Text Place any freeform text within a dropdown menu with text. Note that you'll likely need additional sizing styles to constrain the menu width.

### Forms Put a form within a dropdown menu, or make it into a dropdown menu.

--- ## API reference ### Dropdown Module ```typescript import { DropdownModule } from '@coreui/angular'; @NgModule({ imports: [DropdownModule,] }) export class AppModule() { } ``` --- ### c-dropdown _component_ ##### Inputs

| name | description | type | default | | ---- | ----------- | ---- | ------- | | `alignment` | Set alignment of dropdown menu. | `string` | _undefined_ | | `dark` | Sets a darker color scheme to match a dark navbar. | `boolean` | _false_ | | `direction` | Sets a specified direction and location of the dropdown menu. | `center` \| `dropup` \| 'dropup-center' \| `dropend` \| `dropstart` |_undefined_| | `placement` | Describes the placement of your component after Popper.js has applied all the modifiers that may have flipped or altered the originally provided placement property. | `Placements` |_bottom-start_| | `popper` | If you want to disable dynamic positioning set this property to `false`. | `boolean` |_true_| | `variant` | Set the dropdown variant to an btn-group, dropdown, input-group, and nav-item. | `btn-group` \| `dropdown` \| `input-group` \| `nav-item` |_dropdown_| | `visible` | Toggle the visibility of dropdown menu component. | `boolean` |_false_| | `autoClose` |

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.

##### Outputs

| name | description | type | | ---- | ----------- | ---- | | `visibleChange` | Event emitted on `visible` change. | `boolean` |

### cDropdownClose _directive_ ##### Inputs

| name | description | type | default | | ---- | ----------- | ---- | ------- | | `disabled` | Toggle the disabled state for the cDropdownClose host element. | `boolean` | _undefined_ |

### cDropdownDivider _directive_ ### cDropdownHeader _directive_ ### cDropdownItem _directive_ ##### Inputs

| name | description | type | default | | ---- | ----------- | ---- | ------- | | `active` | Toggle the active state for the dropdown item. | `boolean` | _undefined_ | | `autoClose` | Close dropdown menu on cDropdownItem click. | `boolean` | _true_ | | `disabled` | Toggle the disabled state for the dropdown item. | `boolean` | _undefined_ |

### cDropdownItemPlain _directive_ ### cDropdownMenu _directive_ ##### Inputs

| name | description | type | default | | ---- | ----------- | ---- | ------- | | `dark` | Sets a darker color scheme to match a dark navbar. | `boolean` | _true_ |

### cDropdownToggle _directive_ ##### Inputs

| name | description | type | default | | ---- | ----------- | ---- | ------- | | `caret` | Enables pseudo element caret on toggler. | `boolean` | _true_ | | `split` | Create split button dropdowns. | `boolean` | _undefined_ |