Exports
All exports are called via exports['flux-ui-pack']:FunctionName(...) from any client script.
Notifications
| Export | Parameters | Description |
|---|---|---|
Notify | (data) | Show a notification |
Text UI
| Export | Parameters | Description |
|---|---|---|
ShowTextUI | (text, options) | Show a text UI element |
HideTextUI | () | Hide the text UI |
IsTextUIOpen | () | Check if text UI is currently open |
Progress
| Export | Parameters | Description |
|---|---|---|
ProgressBar | (data) | Show a progress bar |
ProgressCircle | (data) | Show a circular progress indicator |
ProgressActive | () | Check if a progress indicator is active |
CancelProgress | () | Cancel the current progress indicator |
Radial Menu
| Export | Parameters | Description |
|---|---|---|
AddRadialItem | (items) | Add items to the radial menu |
RemoveRadialItem | (item) | Remove an item from the radial menu |
ClearRadialItems | () | Clear all radial menu items |
RegisterRadial | (radial) | Register a sub-radial menu |
HideRadial | () | Hide the radial menu |
DisableRadial | (state) | Enable or disable the radial menu |
GetCurrentRadialId | () | Get the current radial menu ID |
Skill Check
| Export | Parameters | Description |
|---|---|---|
SkillCheck | (difficulty, inputs, options) | Start a skill check |
SkillCheckActive | () | Check if a skill check is active |
CancelSkillCheck | () | Cancel the current skill check |
Input Dialog
| Export | Parameters | Description |
|---|---|---|
InputDialog | (heading, rows, options) | Open an input dialog |
CloseInputDialog | () | Close the input dialog |
Context Menu
| Export | Parameters | Description |
|---|---|---|
RegisterContext | (context) | Register a context menu |
ShowContext | (id) | Show a registered context menu |
HideContext | (onExit) | Hide the context menu |
GetOpenContextMenu | () | Get the currently open context menu ID |
Alert Dialog
| Export | Parameters | Description |
|---|---|---|
AlertDialog | (data) | Show an alert dialog |
CloseAlertDialog | () | Close the alert dialog |
List Menu
| Export | Parameters | Description |
|---|---|---|
RegisterMenu | (data, cb) | Register a list menu |
ShowMenu | (id) | Show a registered menu |
HideMenu | (onExit) | Hide the menu |
GetOpenMenu | () | Get the currently open menu ID |
SetMenuOptions | (id, options, index) | Update menu options |
For detailed usage of each component, see the individual component pages.
Last updated on