Module: siteKiosk.ui.systemDialog

A module which allows to show system alert dialogs.

Methods

<static> show(options, callback) → {siteKiosk.ui.systemDialog~systemDialog}

Shows a system dialog which will be on top of everything else.
Parameters:
Name Type Description
options siteKiosk.ui.systemDialog~options Specifies dialog options
callback siteKiosk.ui.systemDialog~callback A callback function, which will be called when the dialog closes
Returns:
Type
siteKiosk.ui.systemDialog~systemDialog

Type Definitions

options

Defines system dialog options.
Type:
  • Object
Properties:
Name Type Argument Description
message String <optional>
 The dialog will show the specified message if set
title String <optional>
 The dialog will display a title bar with the specified title if set
buttons Object Specifies the dialog buttons
Properties
Name Type Argument Description
confirm String <optional>
 The dialog will show a confirm button with the specified text if set
deny String <optional>
 The dialog will show a deny button with the specified text if set
cancel String <optional>
 The dialog will show a cancel button with the specified text if set

systemDialog

Type:
  • Object
Properties:
Name Type Description
close function Closes the dialog

callback(type)

This callback will be triggered when a dialog button was clicked.
Parameters:
Name Type Description
type String The type of the button which has been clicked (confirm, deny or cancel).