summaryrefslogtreecommitdiff
path: root/luals-stubs/alerts.lua
blob: 12564b4d788e70f5110e8194357066ce95800031 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
-- SPDX-FileCopyrightText: 2023 jacqueline <me@jacqueline.id.au>
--
-- SPDX-License-Identifier: GPL-3.0-only

--- @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