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 This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

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	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

<c-menu-item
     name="home"
     record={menuItem1}
     icon-position="right"
     icon-name="action:info"
     status="error"
     checked
     >

<c-menu theme="slds" icon-name="utility:down">
      <c-menu-item
        record={data1}
        icon-name="action:info"
      ></c-menu-item>
      <c-menu-item
        record={data2}
        icon-position="right"
        icon-name="action:info"
      ></c-menu-item>
  </c-menu>

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

<c-menu-item
     name="home"
     record={menuItem1}
     icon-position="right"
     icon-name="action:info"
     status="error"
     checked
     >

<c-menu theme="slds" icon-name="utility:down">
      <c-menu-item
        record={data1}
        icon-name="action:info"
      ></c-menu-item>
      <c-menu-item
        record={data2}
        icon-position="right"
        icon-name="action:info"
      ></c-menu-item>
  </c-menu>

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

     <c-menu-item
     name="home"
     record={menuItem1}
     icon-position="right"
     icon-name="action:info"
     status="error"
     checked
     >

  <c-menu theme="slds" icon-name="utility:down">
      <c-menu-item
        record={data1}
        icon-name="action:info"
      ></c-menu-item>
      <c-menu-item
        record={data2}
        icon-position="right"
        icon-name="action:info"
      ></c-menu-item>
  </c-menu>

Vlocity Insurance and Health Summer '19 and Vlocity CME Fall '19

The MenuItem Lightning Web Component is the basic element inside theMenu 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

     <c-menu-item
     name="home"
     record={menuItem1}
     icon-position="right"
     icon-name="action:info"
     status="error"
     checked
     >

  <c-menu theme="slds" icon-name="utility:down">
      <c-menu-item
        record={data1}
        icon-name="action:info"
      ></c-menu-item>
      <c-menu-item
        record={data2}
        icon-position="right"
        icon-name="action:info"
      ></c-menu-item>
  </c-menu>