Contract for loading overlay management in Decaf applications.
- Since:
- 2026-06-19
Members
Promise.<string>
# getMessage
Returns the message currently being displayed in the active loading overlay.
Retrieves the current loading message.
Promise.<Record.<string, any>>
# getOptions
Combines defaults with user-provided options. The message parameter
takes precedence over any message set in options.
Merges custom options with the default loading configuration.
boolean
# isVisible
Returns true when a loading overlay is active and displayed to the user.
Checks if a loading overlay is currently visible.
Promise.<void>
# remove
Dismisses the active loading overlay and resets internal progress state. Safe to call even when no overlay is active.
Removes the loading overlay from display.
Promise.<void>
# show
Creates and presents a loading overlay. If one is already visible, updates the existing overlay instead of creating a new one.
Displays a loading overlay with the specified message and options.
Promise.<void>
# update
Modifies the current overlay message. When isProgressUpdate is a number,
displays progress as a percentage. When no overlay exists, creates one with a default duration.
Updates the loading overlay message and optionally tracks progress.