Overview

Start with a tab, add sections to it, then add controls (toggles, sliders, color pickers…) inside the sections.

tab

api.ui.tab(title: string, icon: string?): Tab

A tab in the menu. One per script. See Tab.

title

string

required

Tab label.

icon

string

Name of an image asset (resolved via getAsset).

api.ui.find(fullName: string): ElementHandle?

Look up any saved control by its full name (yours or another script’s), e.g. luau.my_script.enabled. Returns nil if not found.

api.ui.notify(spec: NotifySpec): NotifyHandle

Pop a toast notification in the top-right corner. Returns a handle to update or dismiss it. See Notify.

api.ui.isOpen(): boolean

Returns true while the menu is open.

api.ui.onToggle: Signal

Signal. Call :Connect(cb). Your cb(open) runs every time the menu opens or closes, with the new boolean. Disconnects on unload.