Skip to main content
Buttons register with Quick Commands automatically. By default they execute once; InternalInfo.Toggle = true turns the same component into a boolean toggle.

Action button

A normal button callback receives no arguments.

Toggle button

Toggle callbacks receive the new boolean state.

Rich text

Button titles and description tooltips render Roblox rich-text markup by default:
Set RichText = false on the button config or inside Info to render both as plain text:

Configuration

string
default:"\"Button\""
Button title. For toggles this is also the displayed toggle label.
string
Tooltip text displayed instantly while hovering the control. Use \n for line breaks.
boolean
default:"true"
Enables rich-text markup for the button title and description tooltip. Set to false to opt out. Info.RichText is also accepted.
string
Stable command ID. A random ID is generated when omitted.
boolean
default:"false"
Turns the action button into a stateful boolean toggle.
boolean
default:"false"
Adds a right-click menu for assigning or removing a keyboard shortcut.
boolean
default:"false"
Adds a right-click Toggle Startup option. For buttons, a saved startup flag executes the callback with true during the next library initialization.
string[]
Alternate Quick Commands names. Info.Aliases and InternalInfo.Aliases are also recognized.
function
Normal button: Callback(). Toggle button: Callback(state).

Quick Commands

Normal buttons are invoked by command name or alias:
Toggle buttons accept an explicit state or flip when no state is supplied:

Right-click actions

When Bindable or StartupAvailable is enabled, right-clicking the button opens its flyout.
  • Assign a New Keybind stores the selected keyboard key by command ID.
  • Remove Keybind clears the saved binding.
  • Toggle Startup stores the startup flag.

Returned handle

AddButton() returns a handle with both GUI references and control methods:
activate() and setVisualState() are convenient programmatic hooks, but they do not add new persistence semantics beyond what the component already implements.