Since Shoelace 2.0 Code stable Pattern stable Figma ready

Menu Item

<sl-menu-item> | SlMenuItem

Menu items provide options for the user to pick from in a menu.

Examples

Basic Menu Item

Menu items look identical to options, but they are designed to be used in a menu, whereas options are meant to be used in a select.

Option 1 Option 2 Option 3 Checkbox Disabled Prefix icon Suffix icon 
<sl-menu style="max-width: 200px;">
  <sl-menu-item>Option 1</sl-menu-item>
  <sl-menu-item>Option 2</sl-menu-item>
  <sl-menu-item>Option 3</sl-menu-item>
  <sl-divider></sl-divider>
  <sl-menu-item type="checkbox" checked>Checkbox</sl-menu-item>
  <sl-menu-item disabled>Disabled</sl-menu-item>
  <sl-divider></sl-divider>
  <sl-menu-item>
    Prefix icon
    <sl-icon slot="prefix" library="fa" name="fal-leaf"></sl-icon>
  </sl-menu-item>
  <sl-menu-item>
    Suffix icon
    <sl-icon slot="suffix" library="fa" name="fal-flower-tulip"></sl-icon>
  </sl-menu-item>
</sl-menu>

sl-menu style="max-width: 200px;"
  sl-menu-item Option 1
  sl-menu-item Option 2
  sl-menu-item Option 3
  sl-divider
  sl-menu-item type="checkbox" checked="true" Checkbox
  sl-menu-item disabled="true" Disabled
  sl-divider
  sl-menu-item
    | Prefix icon
    sl-icon slot="prefix" library="fa" name="fal-leaf"
  sl-menu-item
    | Suffix icon
    sl-icon slot="suffix" library="fa" name="fal-flower-tulip"

import SlDivider from '@teamshares/shoelace/dist/react/divider';
import SlIcon from '@teamshares/shoelace/dist/react/icon';
import SlMenu from '@teamshares/shoelace/dist/react/menu';
import SlMenuItem from '@teamshares/shoelace/dist/react/menu-item';

const App = () => (
  <SlMenu style={{ maxWidth: '200px' }}>
    <SlMenuItem>Option 1</SlMenuItem>
    <SlMenuItem>Option 2</SlMenuItem>
    <SlMenuItem>Option 3</SlMenuItem>
    <SlDivider />
    <SlMenuItem type="checkbox" checked>
      Checkbox
    </SlMenuItem>
    <SlMenuItem disabled>Disabled</SlMenuItem>
    <SlDivider />
    <SlMenuItem>
      Prefix Icon
      <SlIcon slot="prefix" name="gift" />
    </SlMenuItem>
    <SlMenuItem>
      Suffix Icon
      <SlIcon slot="suffix" name="heart" />
    </SlMenuItem>
  </SlMenu>
);

Disabled

Add the disabled attribute to disable a menu item so it cannot be selected.

Option 1 Option 2 Option 3 
<sl-menu style="max-width: 200px;">
  <sl-menu-item>Option 1</sl-menu-item>
  <sl-menu-item disabled>Option 2</sl-menu-item>
  <sl-menu-item>Option 3</sl-menu-item>
</sl-menu>

sl-menu style="max-width: 200px;"
  sl-menu-item Option 1
  sl-menu-item disabled="true" Option 2
  sl-menu-item Option 3

import SlMenu from '@teamshares/shoelace/dist/react/menu';
import SlMenuItem from '@teamshares/shoelace/dist/react/menu-item';

const App = () => (
  <SlMenu style={{ maxWidth: '200px' }}>
    <SlMenuItem>Option 1</SlMenuItem>
    <SlMenuItem disabled>Option 2</SlMenuItem>
    <SlMenuItem>Option 3</SlMenuItem>
  </SlMenu>
);

Prefix & Suffix Icons

Add content to the start and end of menu items using the prefix and suffix slots.

Follow these general guidelines when adding prefix and suffix icons to option items:

  • Use the sl-icon component
  • Use library="fa" (our default Font Awesome icon set)
  • Use the Light icon style, which means you need to add a fal- prefix to the icon name
    • See icons sets for more about Font Awesome icon styles
  • In general don’t resize icons or change their color from the default already set by the sl-option component
Profile Notifications 12 Settings Log out 
<sl-menu style="max-width: 240px;">
  <sl-menu-item>
    <sl-icon slot="prefix" library="fa" name="fal-user"></sl-icon>
    Profile
  </sl-menu-item>

  <sl-menu-item>
    <sl-icon slot="prefix" library="fa" name="fal-bell"></sl-icon>
    Notifications
    <sl-badge slot="suffix">12</sl-badge>
  </sl-menu-item>

  <sl-menu-item>
    <sl-icon slot="prefix" library="fa" name="fal-gear"></sl-icon>
    Settings
  </sl-menu-item>

  <sl-divider></sl-divider>

  <sl-menu-item>
    <sl-icon slot="prefix" library="fa" name="fal-arrow-right-from-bracket"></sl-icon>
    Log out
  </sl-menu-item>
</sl-menu>

sl-menu style="max-width: 240px;"
  sl-menu-item
    sl-icon slot="prefix" library="fa" name="fal-user"
    | Profile
  sl-menu-item
    sl-icon slot="prefix" library="fa" name="fal-bell"
    | Notifications
  sl-menu-item
    sl-icon slot="prefix" library="fa" name="fal-gear"
    | Settings
    sl-badge slot="suffix" variant="primary" pill="true" 12
  sl-divider
  sl-menu-item
    sl-icon slot="prefix" library="fa" name="fal-arrow-right-from-bracket"
    | Log out

import SlBadge from '@teamshares/shoelace/dist/react/badge';
import SlDivider from '@teamshares/shoelace/dist/react/divider';
import SlIcon from '@teamshares/shoelace/dist/react/icon';
import SlMenu from '@teamshares/shoelace/dist/react/menu';
import SlMenuItem from '@teamshares/shoelace/dist/react/menu-item';

const App = () => (
  <SlMenu style={{ maxWidth: '200px' }}>
    <SlMenuItem>
      <SlIcon slot="prefix" name="home" />
      Home
    </SlMenuItem>

    <SlMenuItem>
      <SlIcon slot="prefix" name="envelope" />
      Messages
      <SlBadge slot="suffix" variant="primary" pill>
        12
      </SlBadge>
    </SlMenuItem>

    <SlDivider />

    <SlMenuItem>
      <SlIcon slot="prefix" name="cog-6-tooth" />
      Settings
    </SlMenuItem>
  </SlMenu>
);

Loading

Use the loading attribute to indicate that a menu item is busy. Like a disabled menu item, clicks will be suppressed until the loading state is removed.

Option 1 Option 2 Option 3 
<sl-menu style="max-width: 200px;">
  <sl-menu-item>Option 1</sl-menu-item>
  <sl-menu-item loading>Option 2</sl-menu-item>
  <sl-menu-item>Option 3</sl-menu-item>
</sl-menu>

sl-menu style="max-width: 200px;"
  sl-menu-item Option 1
  sl-menu-item loading="true" Option 2
  sl-menu-item Option 3

import SlMenu from '@shoelace-style/shoelace/dist/react/menu';
import SlMenuItem from '@shoelace-style/shoelace/dist/react/menu-item';

const App = () => (
  <SlMenu style={{ maxWidth: '200px' }}>
    <SlMenuItem>Option 1</SlMenuItem>
    <SlMenuItem loading>Option 2</SlMenuItem>
    <SlMenuItem>Option 3</SlMenuItem>
  </SlMenu>
);

Checkbox Menu Items

Set the type attribute to checkbox to create a menu item that will toggle on and off when selected. You can use the checked attribute to set the initial state.

Checkbox menu items are visually indistinguishable from regular menu items. Their ability to be toggled is primarily inferred from context, much like you’d find in the menu of a native app.

Autosave Check spelling Word wrap 
<sl-menu style="max-width: 200px;">
  <sl-menu-item type="checkbox">Autosave</sl-menu-item>
  <sl-menu-item type="checkbox" checked>Check spelling</sl-menu-item>
  <sl-menu-item type="checkbox">Word wrap</sl-menu-item>
</sl-menu>

sl-menu style="max-width: 200px;"
  sl-menu-item type="checkbox" Autosave
  sl-menu-item type="checkbox" checked="true" Check spelling
  sl-menu-item type="checkbox" Word wrap

import SlMenu from '@teamshares/shoelace/dist/react/menu';
import SlMenuItem from '@teamshares/shoelace/dist/react/menu-item';

const App = () => (
  <SlMenu style={{ maxWidth: '200px' }}>
    <SlMenuItem type="checkbox">Autosave</SlMenuItem>
    <SlMenuItem type="checkbox" checked>
      Check Spelling
    </SlMenuItem>
    <SlMenuItem type="checkbox">Word Wrap</SlMenuItem>
  </SlMenu>
);

Value & Selection

The value attribute can be used to assign a hidden value, such as a unique identifier, to a menu item. When an item is selected, the sl-select event will be emitted and a reference to the item will be available at event.detail.item. You can use this reference to access the selected item’s value, its checked state, and more.

Option 1 Option 2 Option 3 Checkbox 4 Checkbox 5 Checkbox 6 
<sl-menu class="menu-value" style="max-width: 200px;">
  <sl-menu-item value="opt-1">Option 1</sl-menu-item>
  <sl-menu-item value="opt-2">Option 2</sl-menu-item>
  <sl-menu-item value="opt-3">Option 3</sl-menu-item>
  <sl-divider></sl-divider>
  <sl-menu-item type="checkbox" value="opt-4">Checkbox 4</sl-menu-item>
  <sl-menu-item type="checkbox" value="opt-5">Checkbox 5</sl-menu-item>
  <sl-menu-item type="checkbox" value="opt-6">Checkbox 6</sl-menu-item>
</sl-menu>

<script>
  const menu = document.querySelector('.menu-value');

  menu.addEventListener('sl-select', event => {
    const item = event.detail.item;

    // Log value
    if (item.type === 'checkbox') {
      console.log(`Selected value: ${item.value} (${item.checked ? 'checked' : 'unchecked'})`);
    } else {
      console.log(`Selected value: ${item.value}`);
    }
  });
</script>

sl-menu.menu-value style="max-width: 200px;"
  sl-menu-item value="opt-1" Option 1
  sl-menu-item value="opt-2" Option 2
  sl-menu-item value="opt-3" Option 3
  sl-divider
  sl-menu-item type="checkbox" value="opt-4" Checkbox 4
  sl-menu-item type="checkbox" value="opt-5" Checkbox 5
  sl-menu-item type="checkbox" value="opt-6" Checkbox 6

javascript:
  const menu = document.querySelector(.menu-value);

  menu.addEventListener(sl-select, event => {
  const item = event.detail.item;

  // Log value
  if (item.type === checkbox) {
    console.log(`Selected value: ${item.value} (${item.checked ? checked : unchecked})`);
  } else {
    console.log(`Selected value: ${item.value}`);
  }
  });

import SlMenu from '@teamshares/shoelace/dist/react/menu';
import SlMenuItem from '@teamshares/shoelace/dist/react/menu-item';

const App = () => {
  function handleSelect(event) {
    const item = event.detail.item;

    // Toggle checked state
    item.checked = !item.checked;

    // Log value
    console.log(`Selected value: ${item.value}`);
  }

  return (
    <SlMenu style={{ maxWidth: '200px' }} onSlSelect={handleSelect}>
      <SlMenuItem value="opt-1">Option 1</SlMenuItem>
      <SlMenuItem value="opt-2">Option 2</SlMenuItem>
      <SlMenuItem value="opt-3">Option 3</SlMenuItem>
    </SlMenu>
  );
};

Usage Guidelines

Importing

If you’re using the autoloader or the traditional loader, you can ignore this section. Otherwise, feel free to use any of the following snippets to cherry pick this component.

Script Import Bundler React

To import this component from the CDN using a script tag: 

<script type="module" src="https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace@2.1.0/cdn/components/menu-item/menu-item.js"></script>

To import this component from the CDN using a JavaScript import: 

import 'https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace@2.1.0/cdn/components/menu-item/menu-item.js';

To import this component using a bundler: 

import '@shoelace-style/shoelace/dist/components/menu-item/menu-item.js';

To import this component as a React component: 

import SlMenuItem from '@shoelace-style/shoelace/dist/react/menu-item';

Slots

Name Description
(default) The menu item’s label.
prefix Used to prepend an icon or similar element to the menu item.
suffix Used to append an icon or similar element to the menu item.
submenu Used to denote a nested menu.

Learn more about using slots.

Properties

Name Description Reflects Type Default
type The type of menu item to render. To use checked, this value must be set to checkbox. 'normal' | 'checkbox' 'normal'
checked Draws the item in a checked state. boolean false
value A unique value to store in the menu item. This can be used as a way to identify menu items when selected. string ''
loading Draws the menu item in a loading state. boolean false
disabled Draws the menu item in a disabled state, preventing selection. boolean false
updateComplete A read-only promise that resolves when the component has finished updating.

Learn more about attributes and properties.

Methods

Name Description Arguments
getTextLabel() Returns a text label based on the contents of the menu item’s default slot. -

Learn more about methods.

Custom Properties

Name Description Default
--submenu-offset The distance submenus shift to overlap the parent menu. -2px

Learn more about customizing CSS custom properties.

Parts

Name Description
base The component’s base wrapper.
checked-icon The checked icon, which is only visible when the menu item is checked.
prefix The prefix container.
label The menu item label.
suffix The suffix container.
spinner The spinner that shows when the menu item is in the loading state.
spinner__base The spinner’s base part.
submenu-icon The submenu icon, visible only when the menu item has a submenu (not yet implemented).

Learn more about customizing CSS parts.

Dependencies

This component automatically imports the following dependencies.

  • <sl-icon>
  • <sl-popup>
  • <sl-spinner>