React Dropdown Component API

Specifies the alignment of the React Dropdown Menu within this React Dropdown.

// Align dropdown menu to the end on large devices, otherwise start
<CDropdown alignment={{ lg: 'end', xs: 'start' }}>
  <CDropdownToggle>Toggle dropdown</CDropdownToggle>
  <CDropdownMenu>
    <CDropdownItem>Action</CDropdownItem>
    <CDropdownItem>Another Action</CDropdownItem>
  </CDropdownMenu>
</CDropdown>

Determines the root node component (native HTML element or a custom React component) for the React Dropdown.

Configures automatic closing behavior for the React Dropdown:

• true - Close on clicks inside or outside of the React Dropdown Menu.
• false - Disable auto-close; manually call hide or toggle (also not closed by Escape).
• 'inside' - Close only when clicking inside the React Dropdown Menu.
• 'outside' - Close only when clicking outside the React Dropdown Menu.

// Close only when user clicks outside of the menu
<CDropdown autoClose="outside" />

Adds custom classes to the React Dropdown root element.

Appends the React Dropdown Menu to a specific element. You can pass an HTML element or a function returning an element. Defaults to document.body.

// Append the menu to a custom container
const myContainer = document.getElementById('my-container')

<CDropdown container={myContainer} />

Applies a darker color scheme to the React Dropdown Menu, often used within dark navbars.

Specifies the direction of the React Dropdown.

Defines x and y offsets ([x, y]) for the React Dropdown Menu relative to its target.

// Offset the menu 10px in X and 5px in Y direction
<CDropdown offset={[10, 5]}>
  ...
</CDropdown>

Callback fired right before the React Dropdown becomes hidden.

Callback fired immediately after the React Dropdown is displayed.

Determines the placement of the React Dropdown Menu after Popper.js modifiers.

Enables or disables dynamic positioning via Popper.js for the React Dropdown Menu.

Provides a custom Popper.js configuration or a function that returns a modified Popper.js configuration for advanced positioning of the React Dropdown Menu. Read more

// Providing a custom popper config
<CDropdown
  popperConfig={{
    modifiers: [
      {
        name: 'flip',
        options: { fallbackPlacements: ['bottom', 'top'] },
      },
    ],
  }}
>...</CDropdown>

Renders the React Dropdown Menu using a React Portal, allowing it to escape the DOM hierarchy for improved positioning.

Sets the reference element for positioning the React Dropdown Menu.

• toggle - The React Dropdown Toggle button (default).
• parent - The React Dropdown wrapper element.
• HTMLElement - A custom HTML element.
• React.RefObject - A custom reference element.

// Use the parent element as reference for positioning
<CDropdown reference="parent">
  <CDropdownToggle>Toggle dropdown</CDropdownToggle>
  <CDropdownMenu>
    <CDropdownItem>Action</CDropdownItem>
    <CDropdownItem>Another Action</CDropdownItem>
  </CDropdownMenu>
</CDropdown>

Defines the visual variant of the React Dropdown

Controls the visibility of the React Dropdown Menu:

• true - Visible
• false - Hidden

// Programmatically manage the dropdown visibility
const [visible, setVisible] = useState(false)

<CDropdown visible={visible}>
  ...
</CDropdown>

A string of all className you want applied to the component.

Component used for the root node. Either a string to use a HTML element or a component.

A string of all className you want applied to the component.

Toggle the active state for the component.

Component used for the root node. Either a string to use a HTML element or a component.

A string of all className you want applied to the component.

Toggle the disabled state for the component.

The href attribute specifies the URL of the page the link goes to.

Component used for the root node. Either a string to use a HTML element or a component.

A string of all className you want applied to the component.

Component used for the root node. Either a string to use a HTML element or a component.

A string of all className you want applied to the base component.

Toggle the active state for the component.

Component used for the root node. Either a string to use a HTML element or a component.

Enables pseudo element caret on toggler.

A string of all className you want applied to the base component.

Sets the color context of the component to one of CoreUI’s themed colors.

Create a custom toggler which accepts any content.

Toggle the disabled state for the component.

The href attribute specifies the URL of the page the link goes to.

If a dropdown variant is set to nav-item then render the toggler as a link instead of a button.

The role attribute describes the role of an element in programs that can make use of it, such as screen readers or magnifiers.

Select the shape of the component.

Size the component small or large.

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

Screen reader label for split button dropdown toggle.

Sets which event handlers you'd like provided to your toggle prop. You can specify one trigger or an array of them.

Set the button variant to an outlined button or a ghost button.