Component:ContextMenuSubmenu

Component image

**Context Menu Submenu** component as seen in the Scene Inspector

The ContextMenuSubmenu component can be used in combination with any button component to make said button open a custom context menu when clicked.

Fields

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
`ItemsRoot`	Slot	All Context Menu Item Sources on slots immediately under this one will be included in the submenu.
`SearchWholeHierarchy`	Bool	Display all items under `ItemsRoot</slot> including sub slots, not just ones immediately under.`
`DisableFlick`	Bool	Whether to allow opening of the sub menu by clicking on the context menu center and moving it to this component's Context Menu Item Source on the same slot.
`SpeedOverride`	Nullable`1<Float>	Override the speed at which the new context menu will open.
`CounterClockwise`	Bool	Whether the items should be arranged clockwise or counter-clockwise in the submenu.
`KeepPosition`	Bool	When set, the context menu will stay in the same place as the submenu opens. Otherwise, the context menu will recenter on the user's laser.
`Hidden`	Bool	If set, the submenu is only visible to the user that opened it.

Usage

Attach this component to a slot and attach a Context Menu Item Source along side it.

If this component has an active user (i.e. as part of an avatar, or on a grabbed item), the context menu will only be functional to the active user and will not open for other users. See issue #1822

Examples

This is commonly used on avatars, using a RootContextMenuItem as the button, but can also be used on anything else.

Related Issues