# Bootstrap 6 Menu > The Menu component toggles contextual overlays with submenus, container teleport and responsive placement - the new generation the Dropdown compatibility layer is built on. ## Overview _Added in 6.0.0._ Toggle menus with buttons whenever possible. Here’s an example using a CoreUI button: ```html ``` Menus are toggleable, contextual overlays for displaying lists of links and more. They’re made interactive with the included CoreUI menu JavaScript plugin. They’re toggled by clicking, not by hovering; this is [an intentional design decision](https://markdotto.com/blog/bootstrap-explained-dropdowns/). Menus are built on a third party library, [Floating UI](https://floating-ui.com/), which provides dynamic positioning and viewport detection. Use `coreui.bundle.min.js` / `coreui.bundle.js` which includes Floating UI, or include Floating UI separately via an [import map](https://coreui.io/bootstrap/docs/getting-started/javascript/#using-coreui-for-bootstrap-as-a-module). Floating UI isn’t used to position menus in navbars though as dynamic positioning isn’t required. ## Examples While ` ``` ### Dark menus Opt into darker menus to match a dark navbar or custom style by adding `data-coreui-theme="dark"` onto the toggle element or a parent. ```html

``` And putting it to use in a navbar: ```html ``` ### Translucent menus Blur and saturate the background of menus to create a translucent effect with `.menu-translucent`. ```html ``` ## Placement Use `data-coreui-placement` on the toggle element to control where the menu appears. - **Physical placements:** `top`, `bottom`, `left`, `right` — fixed directions regardless of text direction. - **Logical placements:** `start`, `end` — automatically flip based on RTL. In LTR mode, `start` becomes `left` and `end` becomes `right`. In RTL mode, they swap. All placements support `-start` and `-end` alignment modifiers (e.g., `bottom-start`, `end-end`). ```html

``` ### Responsive Change placement at different breakpoints using responsive prefixes. The syntax is `breakpoint:placement`, where breakpoint is one of `sm`, `md`, `lg`, `xl`, or `2xl`. Multiple breakpoints can be combined in a single attribute, space-separated. For example, `data-coreui-placement="bottom-start md:bottom-end lg:end-start"` will: - Show the menu at `bottom-start` on small screens (default) - Switch to `bottom-end` at the `md` breakpoint - Switch to `right-start` at the `lg` breakpoint ```html ``` Resize your browser window to see the placement change at different breakpoints. ## Menu items You can use `` or ` ``` You can also create non-interactive menu items with `.menu-text`. Feel free to style further with custom CSS or text utilities. ```html ``` ### Active Add `.active` to items in the menu to style them as the active selection. 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. ```html ``` ### Disabled Add `.disabled` to items in the menu to style them as disabled. ```html ``` ### Variants Colour an individual item with a [`.theme-*` class](https://coreui.io/bootstrap/docs/customize/components/#theme-variants). The item reads the theme's foreground while at rest and swaps to the theme's fill with a contrasting label once it is `.active`, so one class covers both states. ```html ``` ### Icons Add `.menu-item-icon` directly to an ` ``` ### Descriptions Use `.menu-item-content` for a flex column layout and `.menu-item-description` for secondary text below the main label. ```html ``` ### Selected Add `.selected` to a `.menu-item` to indicate the current selection. ```html ``` ## Menu content ### Headers Add a header to label sections of actions in any menu. ```html ``` ### Dividers Separate groups of related menu items with a divider. ```html ``` ### Text Place any freeform text within a menu with text and use [spacing utilities](https://coreui.io/bootstrap/docs/utilities/margin/). Note that you’ll likely need additional sizing styles to constrain the menu width. ```html ``` ### Forms Put a form within a menu, or make it into a menu, and use [spacing utilities](https://coreui.io/bootstrap/docs/utilities/margin/) to give it the negative space you require. ```html ``` ## Scrollable menus Assign `--cui-menu-max-height` and `--cui-menu-overflow-y` custom properties to constrain the menu height and enable scrolling. ```html ``` You can also use the `.menu-scrollable` class to make the menu scrollable. This assumes a generally safe maximum height of `80dvh` and sets the overflow for you. ## Submenus Create nested menus with the `.submenu` wrapper class. Submenus support hover and click activation, keyboard navigation, and viewport-aware positioning. On small screens (below `576px`), submenus stack over the parent menu with a back button instead of flying out to the side. Wrap a `.menu-item` trigger and a nested `.menu` inside a `.submenu` element. ```html ``` ### Nested Submenus can be nested to multiple levels. Each level opens to the side and flips direction when there’s not enough viewport space. ```html ``` ## Menu options Use `data-coreui-offset` or `data-coreui-reference` to change the location of the menu. Offset is the distance from the trigger element in pixels. Reference is the element to reference the menu from. ```html

``` ### Auto close behavior By default, the menu is closed when clicking inside or outside the menu. You can use the `autoClose` option to change this behavior of the menu. Regardless of the `autoClose` setting, pressing Esc while focus is within the menu (its toggle or items) closes the menu and returns focus to the toggle. ```html

``` ## 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. CoreUI’s menus, 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 menus that contain additional inputs and form controls, such as search fields or login forms. For this reason, CoreUI 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. ### Keyboard navigation Menus include built-in keyboard support for navigating menu items. | Key | Action | | --- | --- | | `↓` / `↑` | Navigate to next/previous menu item | | `→` | Enter submenu (or `←` in RTL) | | `←` | Exit submenu and return to parent (or `→` in RTL) | | `Enter` / `Space` | Activate focused item or open submenu | | `Esc` | Close the menu | | `Home` / `End` | Jump to first/last menu item | | `Tab` | Move focus and close the menu | ## Usage Via data attributes or JavaScript, the menu plugin toggles hidden content (menus) by toggling the `.show` class on the `.menu`. The `data-coreui-toggle="menu"` attribute is relied on for closing menus at an application level, so it’s a good idea to always use it. > On touch-enabled devices, opening a menu adds empty `mouseover` handlers to the immediate children of the `` 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 menu from triggering the code that closes the menu. Once the menu is closed, these additional empty `mouseover` handlers are removed. ### Via data attributes Add `data-coreui-toggle="menu"` to a link or button to toggle a menu. | Attribute | Description | | --- | --- | | `data-coreui-toggle="menu"` | Initializes the menu on the trigger and wires global close behavior. | ```html ``` ### Via JavaScript > Menus must have `data-coreui-toggle="menu"` on their trigger element, regardless of whether you call your menu via JavaScript or use the data-api. Call the menus via JavaScript: ```js const menuElementList = document.querySelectorAll('[data-coreui-toggle="menu"]') const menuList = [...menuElementList].map(menuToggleEl => new coreui.Menu(menuToggleEl)) ``` To open, close, or toggle a menu programmatically, get its instance from the trigger element (the one with `data-coreui-toggle="menu"`) and call the corresponding method: ```js const menuToggleEl = document.querySelector('#myMenuToggle') const menu = coreui.Menu.getOrCreateInstance(menuToggleEl) menu.show() menu.hide() menu.toggle() ``` ### Options | Name | Type | Default | Description | | --- | --- | --- | --- | | `autoClose` | boolean, string | `true` | Configure the auto close behavior of the menu:

`true` - the menu will be closed by clicking outside or inside the menu.
`false` - the menu 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 menu will be closed (only) by clicking inside the menu.
`'outside'` - the menu will be closed (only) by clicking outside the menu.

Note: the menu can always be closed with the Esc key. | | `boundary` | string, element | `'clippingParents'` | Overflow constraint boundary of the menu (applies only to the shift middleware). By default it’s `clippingParents` and can accept an HTMLElement reference (via JavaScript only). For more information refer to Floating UI’s [shift docs](https://floating-ui.com/docs/shift). | | `container` | string, element, boolean | `false` | Appends the menu to a specific element when shown. Use `'body'` or `true` to append to the document body, which helps escape containers with `overflow: hidden`. The menu is moved back to its original position when hidden. Inside a modal dialog it goes into the dialog instead, because the rest of the page is inert. | | `display` | string | `'dynamic'` | By default, we use Floating UI for dynamic positioning. Disable this with `static`. | | `floatingConfig` | null, object, function | `null` | To change Bootstrap’s default Floating UI config, see [Floating UI’s configuration](https://floating-ui.com/docs/computePosition). When a function is used to create the Floating UI configuration, it’s called with an object that contains the Bootstrap’s default Floating UI configuration. It helps you use and merge the default with your own configuration. The function must return a configuration object for Floating UI. | | `menu` | null, element | `null` | The `.menu` to open (JavaScript only). By default the plugin takes the `.menu` next to the toggle, or the one inside the toggle's wrapper. | | `offset` | array, string, function | `[0, 2]` | Offset of the menu relative to its target. You can pass a string in data attributes with comma separated values like: `data-coreui-offset="10,20"`. When a function is used to determine the offset, it is called with an object containing the placement, the reference, and floating 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, distance]. For more information refer to Floating UI’s [offset docs](https://floating-ui.com/docs/offset). | | `placement` | string | `'bottom-start'` | Placement of the menu. Physical placements: `'top'`, `'bottom'`, `'left'`, `'right'`. Logical placements (RTL-aware): `'start'`, `'end'`. All support alignment modifiers: `-start`, `-end`. Supports responsive prefixes like `'bottom-start md:end'`. | | `reference` | string, element, object | `'toggle'` | Reference element of the menu. Accepts the values of `'toggle'`, `'parent'`, an HTMLElement reference or an object providing `getBoundingClientRect`. For more information refer to Floating UI’s [virtual elements docs](https://floating-ui.com/docs/virtual-elements). | | `strategy` | string | `'absolute'` | Positioning strategy for the menu. Use `'absolute'` for default positioning, or `'fixed'` to escape containers with `overflow: hidden`. For more information refer to Floating UI’s [strategy docs](https://floating-ui.com/docs/computePosition#strategy). | | `submenuDelay` | number | `100` | Delay in milliseconds before closing a submenu when the mouse leaves. Provides a grace period for diagonal mouse movement toward the submenu. | | `submenuTrigger` | string | `'both'` | How submenus are triggered. Use `'click'` for click only, `'hover'` for hover only, or `'both'` for both click and hover activation. | #### Using function with `floatingConfig` ```js const menu = new coreui.Menu(element, { floatingConfig(defaultBsFloatingConfig) { // const newFloatingConfig = {...} // use defaultBsFloatingConfig if needed... // return newFloatingConfig } }) ``` ### Methods | Method | Description | | --- | --- | | `dispose` | Destroys an element’s menu. (Removes stored data on the DOM element) | | `getInstance` | Static method which allows you to get the menu instance associated to a DOM element, you can use it like this: `coreui.Menu.getInstance(element)`. | | `getOrCreateInstance` | Static method which returns a menu instance associated to a DOM element or create a new one in case it wasn’t initialized. You can use it like this: `coreui.Menu.getOrCreateInstance(element)`. | | `hide` | Hides the menu of a given navbar or tabbed navigation. | | `show` | Shows the menu of a given navbar or tabbed navigation. | | `toggle` | Toggles the menu of a given navbar or tabbed navigation. | | `update` | Updates the position of an element’s menu. | ### Events All menu events are fired at the toggling element and then bubbled up. So you can also add event listeners on the `.menu`'s parent element. `hide.coreui.menu` and `hidden.coreui.menu` events have a `clickEvent` property (only when the original Event type is `click`) that contains an Event Object for the click event. | Event type | Description | | --- | --- | | `hidden.coreui.menu` | Fired when the menu has finished being hidden from the user and CSS transitions have completed. | | `hide.coreui.menu` | Fires immediately when the `hide` instance method has been called. | | `show.coreui.menu` | Fires immediately when the `show` instance method is called. | | `shown.coreui.menu` | Fired when the menu has been made visible to the user and CSS transitions have completed. | ```js const myMenu = document.getElementById('myMenu') myMenu.addEventListener('show.coreui.menu', event => { // do something... }) ``` ## Customizing ### CSS variables ```scss $menu-tokens: defaults( ( --cui-menu-zindex: var(--cui-z-menu), --cui-menu-gap: .125rem, --cui-menu-min-width: 10rem, --cui-menu-max-height: none, --cui-menu-overflow-y: visible, --cui-menu-padding-x: .25rem, --cui-menu-padding-y: .25rem, --cui-menu-font-size: var(--cui-font-size-sm), --cui-menu-color: var(--cui-fg-body), --cui-menu-bg: var(--cui-bg-body), --cui-menu-border-color: var(--cui-border-color-translucent), --cui-menu-border-radius: var(--cui-radius-7), --cui-menu-border-width: var(--cui-border-width), --cui-menu-box-shadow: var(--cui-box-shadow-lg), --cui-menu-divider-bg: var(--cui-border-color-translucent), --cui-menu-divider-margin-y: .125rem, --cui-menu-divider-margin-x: .25rem, --cui-menu-item-color: var(--cui-menu-color, var(--cui-fg-body)), --cui-menu-item-hover-color: var(--cui-menu-color, var(--cui-fg-body)), --cui-menu-item-hover-bg: var(--cui-bg-1), --cui-menu-item-active-color: var(--cui-primary-contrast), --cui-menu-item-active-bg: var(--cui-primary-bg), --cui-menu-item-disabled-color: var(--cui-fg-3), --cui-menu-item-font-weight: var(--cui-font-weight-normal), --cui-menu-item-gap: .5rem, --cui-menu-item-padding-x: .75rem, --cui-menu-item-padding-y: .25rem, --cui-menu-item-border-radius: var(--cui-radius-5), --cui-menu-icon-size: 1rem, --cui-menu-description-font-size: calc(var(--cui-body-font-size) * .75), --cui-menu-check-color: currentcolor, --cui-menu-header-color: var(--cui-fg-3), --cui-menu-header-padding-x: .75rem, --cui-menu-header-padding-y: .25rem, --cui-menu-transition-property: #{"opacity, transform, display"}, --cui-menu-transition-duration: .15s, --cui-menu-transition-timing: var(--cui-transition-timing-overlay), ), $menu-tokens ); ```

Menu header