diff options
| author | jacqueline <me@jacqueline.id.au> | 2024-03-07 17:22:06 +1100 |
|---|---|---|
| committer | jacqueline <me@jacqueline.id.au> | 2024-03-07 17:22:06 +1100 |
| commit | 36a19182bec171d6376e51f5689aaf70b9d6fbad (patch) | |
| tree | b75be5f1567510ce2c60693c978a6ddf0b879905 /luals-stubs/alerts.lua | |
| parent | beb1f654958c28429323fcb9622c9c8d206979a3 (diff) | |
| download | tangara-fw-36a19182bec171d6376e51f5689aaf70b9d6fbad.tar.gz | |
Use luals-stubs as the source of truth for docs, instead of maintaining
separate docs stubs
Includes introducing a cool new script to turn lua-language-server's
json output into markdown documentation.
Diffstat (limited to 'luals-stubs/alerts.lua')
| -rw-r--r-- | luals-stubs/alerts.lua | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/luals-stubs/alerts.lua b/luals-stubs/alerts.lua index d430f12d..420194eb 100644 --- a/luals-stubs/alerts.lua +++ b/luals-stubs/alerts.lua @@ -1,11 +1,15 @@ --- @meta +--- The `alerts` module contains functions for showing transient popups over +--- the current screen. --- @class alerts local alerts = {} ---- @param constructor function +--- Shows a new alert, replacing any other alerts. +--- @param constructor function Called to create the UI for the alert. A new default root object and group will be set before calling this function.i Alerts are non-interactable; the group created for the constructor will not be granted focus. function alerts.show(constructor) end +--- Dismisses any visible alerts, removing them from the screen. function alerts.hide() end return alerts |