--- schema_version: "1" id: e47317677d344278ab3e5b0238ecf4da7ea180ec588b115d87579bd9cd2029a8 title: MenuItem Lightning Web Component ReadMe (Managed Package) collection: admin version: current locale: en-us portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/os_menuitem_lightning_web_component_readme.md canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.os_menuitem_lightning_web_component_readme.htm&release=264.0.0&type=5 source_site: help.salesforce.com content_type: documentation content_hash: 7d1e3670a06b4acbfb5a88b3da53a84dd08153b0263d0b2fcdc5fff85fe63b32 description: For the managed package runtime, this page contains a MenuItem LWC ReadMe for each Vlocity release. products: - Omnistudio release: "264" --- # MenuItem Lightning Web Component ReadMe (Managed Package) For the managed package runtime, this page contains a MenuItem LWC ReadMe for each Vlocity release. ![Managed Package app icon](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/resources-global/_corporate/images/managedpackageicon.png) This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see [Omnistudio Help](https://help.salesforce.com/s/articleView?id=xcloud.os_omnistudio_standard.htm&language=en_US). ## Vlocity Insurance and Health Summer '20 The _MenuItem Lightning Web Component_ is the basic element inside the _Menu Lightning Web Component_. Each `c-menu-item` component adds an item to the menu. ## Available c-menu-item Attributes

Attribute

Value

Type

Required

Description

name

unique

string

  

Sets the visible menu item name.

record

  

string

  

Contains the menu item data.

theme

slds, nds (Default: slds)

string

  

Sets which theme menu uses.

icon-name

(Format: standard:arrow)

string

  

Sets the icon for the menu item. See SLDS icons.

icon-position

right, left (Default: left)

string

  

Sets icon position for the menu item data.

type

header, action

string

  

To the make menu item a sub-header of the menu, set to header. To create a menu where each item is a link that performs an action, set to action.

action-url

  

string

  

Sets the action URL for the menu item. Must set type to action.

open-url-in

newTab, currentTab (Default: newTab)

string

  

Sets the mode in which the action URL should be opened.

status

error, warning, success

string

  

Sets the status for the menu item and updates the menu item style.

checked

true, false (Default: false)

boolean

  

To set a default selected menu item, set to true.

label

  

string

  

Contains the menu item label.

obj

  

Object

  

Provides the record to set the stateObject property of an action LWC.

actionData

  

Object

  

Adds the details of an action menu item LWC.
## Example c-menu-item Component ``` ``` ``` ``` ## Example actionData Object ``` actionData: { stateObj: "{record}", card: "{card}", stateAction: { id: "test-action", type: "Custom", displayName: "Action", vlocityIcon: "standard-default", targetType: "Web Page", openUrlIn: "Current Window", "Web Page": { targetName: "/apex" } } } ``` ## Vlocity Insurance and Health Spring '20 The _MenuItem Lightning Web Component_ is the basic element inside the _Menu Lightning Web Component_. Each `c-menu-item` component adds an item to the menu. ## Available c-menu-item Attributes

Attribute

Value

Type

Required

Description

name

unique

string

yes

Sets the visible menu item name.

record

  

string

  

Contains the menu item data.

theme

slds, nds (Default: slds)

string

  

Sets which theme menu uses.

icon-name

(Format: standard:arrow)

string

  

Sets the icon for the menu item. See SLDS icons.

icon-position

right, left (Default: left)

string

  

Sets icon position for the menu item data.

type

header, action

string

  

To make the menu item a sub-header of the menu, set to header. To create a menu where each item is a link that performs an action, set to action.

action-url

  

string

  

Sets the action URL for the menu item. Must set type to "action".

open-url-in

newTab, currentTab (Default: newTab)

string

  

Sets the mode in which the action URL should be opened.

status

error, warning, success

string

  

Sets the status for the menu item.

checked

true, false (Default: false)

boolean

  

To set a default selected menu item, set to true.

label

  

string

  

Contains the menu item label.
## Example c-menu-item Component ``` ``` ``` ``` ## Vlocity Insurance and Health Winter '20 and Vlocity CME Spring '20 The _MenuItem Lightning Web Component_ is the basic element inside the _Menu Lightning Web Component_. Each `c-menu-item` component adds an item to the menu. ## Available c-menu-item Attributes

Attribute

Value

Type

Required

Description

name

unique

string

yes

Sets the visible menu item name.

record

  

string

yes

Contains the menu item data.

theme

slds, nds (Default: slds)

string

  

Sets which theme menu uses.

icon-name

(Format: standard:arrow)

string

  

Sets the icon for the menu item. See SLDS icons.

icon-position

right, left (Default: left)

string

  

Sets icon position for the menu item data.

type

header, action

string

  

To make the menu item a sub-header of the menu, set to header. To create a menu where each item is a link that performs an action, set to action.

action-url

  

string

  

Sets the action URL for the menu item. Must set type to "action".

open-url-in

newTab, currentTab (Default: newTab)

string

  

Sets the mode in which the action URL should be opened.

status

error, warning, success

string

  

Sets the status for the menu item.

checked

true, false (Default: false)

boolean

  

To set a default selected menu item, set to true.
## Example c-menu-item Component ``` ``` ``` ``` ## Vlocity Insurance and Health Summer '19 and Vlocity CME Fall '19 The _MenuItem Lightning Web Component_ is the basic element inside the_Menu Lightning Web Component_. Each `c-menu-item` component adds an item to the menu. ## Available c-menu-item Attributes

Attribute

Value

Type

Required

Description

name

unique

string

yes

Sets the visible menu item name.

record

  

string

yes

Contains the menu item data.

theme

slds, nds (Default: slds)

string

  

Sets which theme menu uses.

icon-name

(Format: standard:arrow)

string

  

Sets the icon for the menu item. See SLDS icons.

icon-position

right, left (Default: left)

string

  

Sets icon position for the menu item data.

type

header, action

string

  

To make the menu item a sub-header of the menu, set to header. To create a menu where each item is a link that performs an action, set to action.

action-url

  

string

  

Sets the action url for the menu item. Must set type to "action".

open-url-in

newTab, currentTab (Default: newTab)

string

  

Sets the mode in which the action URL should be opened.

status

error, warning, success

string

  

Sets the status for the menu item.

checked

true, false (Default: false)

boolean

  

To set a default selected menu item, set to true.
## Example c-menu-item Component ``` ``` ``` ```