Loading
×Sorry to interrupt
CSS Error
Aura Component

Checkbox Menu Item

  • ​Deprecated as of API version 47.0. We recommend migrating to Lightning Web Components and using the lightning-button-menu component.

    Descriptor

    ui:checkboxMenuItem

    Targets

    Lightning Experience, Experience Builder Sites, Salesforce Mobile App, Lightning Out / Visualforce, Standalone Lightning App

Deprecation Guidelines

We recommend using Lightning Web Components whenever possible. When migrating to Lightning Web Components, use lightning-menu-item with lightning-button-menu.

For more information, see Aura Components in the ui Namespace Are Deprecated.

Usage Overview (Deprecated)

A ui:checkboxMenuItem component represents a menu list item that enables multiple selection. Use aura:iteration to iterate over a list of values and display the menu items. A ui:menuTriggerLink component displays and hides your menu items.

<aura:attribute name="status" type="String[]" default="Open, Closed, Closed Won, Any"/> <ui:menu> <ui:menuTriggerLink aura:id="checkboxMenuLabel" label="Multiple selection"/> <ui:menuList aura:id="checkboxMenu" class="checkboxMenu"> <aura:iteration items="{!v.status}" var="s"> <ui:checkboxMenuItem label="{!s}"/> </aura:iteration> </ui:menuList> </ui:menu>
Documentation
Specification