Dropdown Item
<wa-dropdown-item>
Represents an individual item within a dropdown menu, supporting standard items, checkboxes, and submenus.
This component must be used as a child of <wa-dropdown>. Please see the Dropdown docs to see examples of this component in action.
Importing
Jump to heading
Autoloading components via projects is the recommended way to import components. If you prefer to do it manually, use one of the following code snippets.
Let your project code do the work! Sign up for free to use a project with your very own CDN — it's the fastest and easiest way to use Web Awesome.
To manually import this component from NPM, use the following code.
import '@awesome.me/webawesome/dist/components/dropdown-item/dropdown-item.js';
To manually import this component from React, use the following code.
import WaDropdownItem from '@awesome.me/webawesome/dist/react/dropdown-item';
Slots
Jump to heading
Learn more about using slots.
| Name | Description |
|---|---|
| (default) | The dropdown item's label. |
details
|
Additional content or details to display after the label. |
icon
|
An optional icon to display before the label. |
submenu
|
Submenu items, typically <wa-dropdown-item> elements, to create a nested menu. |
Attributes & Properties
Jump to heading
Learn more about attributes and properties.
| Name | Description | Reflects | |
|---|---|---|---|
checkedchecked |
Set to true to check the dropdown item. Only valid when
type is checkbox.Type
booleanDefault
false |
||
css |
One or more CSSResultGroup to include in the component's shadow root. Host styles are automatically prepended.
Type
CSSResultGroup | undefinedDefault
styles |
||
customStates |
Methods for setting and checking custom states.
Type
objectDefault
{ /** Adds or removes the specified custom state. / set: (customState: string, active: boolean) => { if (!Boolean(this.internals?.states)) return; try { if (active) { this.internals.states.add(customState); } else { this.internals.states.delete(customState); } } catch (e) { if (String(e).includes("must start with '--'")) { / eslint-disable-next-line / console.error('Your browser implements an outdated version of CustomStateSet. Consider using a polyfill'); } else { throw e; } } }, /* Determines whether or not the element currently has the specified state. */ has: (customState: string) => { if (!Boolean(this.internals?.states)) return false; try { return this.internals.states.has(customState); } catch { return false; } }, } |
||
disableddisabled |
Disables the dropdown item.
Type
booleanDefault
false |
|
|
submenuOpensubmenuOpen |
Whether the submenu is currently open.
Type
booleanDefault
false |
|
|
typetype |
Set to
checkbox to make the item a checkbox.Type
'normal' | 'checkbox'Default
'normal' |
|
|
valuevalue |
An optional value for the menu item. This is useful for determining which item was selected when listening to the
dropdown's
wa-select event.Type
string |
||
variantvariant |
The type of menu item to render.
Type
'danger' | 'default'Default
'default' |
|
Methods
Jump to heading
Learn more about methods.
| Name | Description | Arguments |
|---|---|---|
closeSubmenu() |
Closes the submenu. | |
openSubmenu() |
Opens the submenu. | |
relayNativeEvent() |
Given a native event, this function cancels it and dispatches it again from the host element using the desired event options. |
event: Event,
eventOptions: EventInit
|
Events
Jump to heading
Learn more about events.
| Name | Description |
|---|---|
blur |
Emitted when the dropdown item loses focus. |
focus |
Emitted when the dropdown item gains focus. |
CSS parts
Jump to heading
Learn more about CSS parts.
| Name | Description | CSS selector |
|---|---|---|
checkmark |
The checkmark icon (a <wa-icon> element) when the item is a checkbox. |
::part(checkmark)
|
details |
The container for the details slot. |
::part(details)
|
icon |
The container for the icon slot. |
::part(icon)
|
label |
The container for the label slot. |
::part(label)
|
submenu |
The submenu container. |
::part(submenu)
|
submenu-icon |
The submenu indicator icon (a <wa-icon> element). |
::part(submenu-icon)
|
Dependencies
Jump to heading
This component automatically imports the following elements. Sub-dependencies, if any exist, will also be included in this list.