Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...

    Function showError

    • Show a user-facing error dialog over the viewport with the given message.

      Any dialog from a previous call is torn down first (its auto-dismiss timer cancelled and focus trap released) so failures never stack. The new dialog is dismissible by click or Escape, optionally auto-dismisses after config.ui.timings.errorAutoDismissMs, and traps keyboard focus while open.

      Parameters

      • message: string

        Human-readable error text to display to the user.

      • OptionalshortcutForAction: ShortcutForAction

        Optional live shortcut-label lookup.

      • OptionalshortcutActions: ErrorShortcutActions

        Action ids to resolve. Authored labels are used when input has not been initialized yet or an action is unbound.

      • options: ErrorDisplayOptions = {}

        Display behavior. Set autoDismiss to false for fatal errors that must remain visible until the user dismisses them.

      Returns void