Skip to content

MenuEntry

Properties

Option

Type

luau

Code block has not loaded. An error may have occurred.

AppearanceOverride

Type

luau

Code block has not loaded. An error may have occurred.

FallbackColor

The color to use when no color is provided by the option. All tailwind colors are available.

Type

luau

Code block has not loaded. An error may have occurred.

Pressing

Type

luau

Code block has not loaded. An error may have occurred.

Selected

Type

luau

Code block has not loaded. An error may have occurred.

Interactable

Whether the menu entry should be interactable. This disables hovering and pressing.

Type

luau

Code block has not loaded. An error may have occurred.

OnClick

Type

luau

Code block has not loaded. An error may have occurred.

OnMouseButton1Changed

Type

luau

Code block has not loaded. An error may have occurred.

OnHover

Type

luau

Code block has not loaded. An error may have occurred.

Instance Properties

This instance takes all the properties of a Frame. SpecialKeys, such as fusion.Children will also be passed to the instance.

option.Color

The color of the menu entry. All tailwind colors are available.

Type

luau

Code block has not loaded. An error may have occurred.

option.AppearanceOverride

Type

luau

Code block has not loaded. An error may have occurred.

option.Static

A "static" menu entry is one that does not respond to any events and cannot be selected. It will always appear in it's base state.

Type

luau

Code block has not loaded. An error may have occurred.

option.Disabled

Type

luau

Code block has not loaded. An error may have occurred.

option.Label

Type

luau

Code block has not loaded. An error may have occurred.

option.LabelFullSize

Whether the label should take up the full size available instead of sizing to its content.

Type

luau

Code block has not loaded. An error may have occurred.

option.Icon

Type

luau

Code block has not loaded. An error may have occurred.

option.Slots

Slots for the menu entry. These slots are identical to the top-level slots, but can instead be specified through the option. However, the top-level slots will take precedence.

Type

luau

Code block has not loaded. An error may have occurred.

Slots

Slots allow you to customize specific aspects of the component completely, often replacing the old instances. Slots are passed parameters that allow the slot to interact with component data that is normally not exposed. Generally, an useColor (the function passed by theme:get()) function is passed as first parameter to allow the new components to use the same color as the parent component. When using slots, make sure to wrap any code that uses reactive values in a Computed (or any other classes that isolate state), to prevent unnecessary updates.

Left

Content to be placed before (left of) the label, overwriting the set icon.

Function Type

luau

Code block has not loaded. An error may have occurred.

Center

Content to be placed in the middle of the label, overwriting the default content.

Function Type

luau

Code block has not loaded. An error may have occurred.

Right

Content to be placed after (right of) the label.

Function Type

luau

Code block has not loaded. An error may have occurred.

Wrapper

A slot to wrap the entire menu entry in a component. This is especially useful for adding tooltips or other content that should be displayed when interacting with the menu entry.

Function Type

luau

Code block has not loaded. An error may have occurred.

Theming

States

StateDescription
Base
Hover
Pressing
Selected
SelectedDisabled
Disabled

Colors

ColorDescription
Background
Text

Types

Certain types are reused across different components. To make these types easily accessible, they are available below:

slots

luau

Code block has not loaded. An error may have occurred.

option

luau

Code block has not loaded. An error may have occurred.