Menu Lightning Web Component ReadMe (Managed Package)

For the managed package runtime, this page contains a Menu 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 Menu Lightning Web Component creates a menu from the list of menu items provided.

Available c-menu Attributes

Attribute

Value

Type

Required

Description

checked

single, multiple, true, false (Default: false)

string

 

To create a menu with multi selectable or single selectable items, set this value.

disabled

true, false (Default: false)

boolean

 

To disable menu, set to false.

extra-class

 

value:string

 

sets the class for menu

icon-name

(Format: standard:arrow) (Default: utility:down)

string

 

Sets the icon for the menu. See SLDS icons.

icon-position

right, left (Default: left)

string

 

Sets icon position for the menu.

icon-size

xx-small, x-small, small, large (Default: xx-small)

string

 

Sets the icon size for the button element inside menu.

menuItems

 

Array

 

Adds the MenuItem LWC inside the Menu LWC.

overflow

true, false (Default: false)

boolean

   

position

left, right, bottom (Default: left)

string

 

Sets the position of the dropdown menu.

record

 

Object

 

Provides the record from which to interpolate the field values.

size

xx-small, x-small, small, medium, large

string

 

Sets the size of dropdown menu.

theme

slds, nds (Default: slds)

   

Sets the theme for the menu.

type

action

string

 

To create a menu where each item is a link that performs an action, set attribute to action.

variant

 

string

 

Sets the style of the menu button based on the typesupported by the chosen theme. For example, success, brand, and so on.

Example menuItems Array

[{ name: name,
      label: "Action",
      iconName: "standard-default",
      actionData: {} }]

Example c-menu Component

<c-menu theme="slds" scroll="5" checked="multiple" type="action" size="large" position="right" icon-name="utility:down">
     </c-menu>
<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 Menu Lightning Web Component creates a menu from the list of menu items provided.

Available c-menu Attributes

Attribute

Value

Type

Required

Description

checked

single, multiple, true, false (Default: false)

string

 

To create a menu with multi selectable or single selectable items, set this value.

icon-name

(Format: standard:arrow) (Default: utility:down)

string

 

Sets the icon for the menu. See SLDS icons.

icon-position

right, left (Default: left)

string

 

Sets icon position for the menu.

icon-size

xx-small, x-small, small, large (Default: xx-small)

string

 

Sets the icon size for the button element inside menu.

overflow

true, false (Default: false)

boolean

   

position

left, right, bottom (Default: left)

string

 

Sets the position of the dropdown menu.

size

xx-small, x-small, small, medium, large

string

 

Sets the size of dropdown menu.

theme

slds, nds (Default: slds)

   

Sets the theme for the menu.

type

action

string

 

To create a menu where each item is a link that performs an action, set attribute to action.

Example c-menu Component

     <c-menu theme="slds" scroll="5" checked="multiple" type="action" size="large" position="right" icon-name="utility:down">
     </c-menu>
  <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 Menu Lightning Web Component creates a menu from the list of menu items provided.

Available c-menu Attributes

Attribute

Value

Type

Required

Description

checked

single, multiple, true, false (Default: false)

string

 

To create a menu with multi selectable or single selectable items, set this value.

icon-name

(Format: standard:arrow) (Default: utility:down)

string

 

Sets the icon for the menu. See SLDS icons.

icon-position

right, left (Default: left)

string

 

Sets icon position for the menu.

overflow

true, false (Default: false)

boolean

   

position

left, right, bottom (Default: left)

string

 

Sets the position of the dropdown menu.

size

xx-small, x-small, small, medium, large

string

 

Sets the size of dropdown menu.

theme

slds, nds (Default: slds)

   

Sets the theme for the menu.

type

action

string

 

To create a menu where each item is a link that performs an action, set attribute to action.

Example c-menu Component

     <c-menu theme="slds" scroll="5" checked="multiple" type="action" size="large" position="right" icon-name="utility:down">
     </c-menu>
  <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>