Files
tangara-fw/luals-stubs/alerts.lua
T
jacqueline 36a19182be 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.
2024-03-07 17:22:06 +11:00

16 lines
591 B
Lua

--- @meta
--- The `alerts` module contains functions for showing transient popups over
--- the current screen.
--- @class alerts
local alerts = {}
--- 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