Class “AlertDialog”

Object > NativeObject > Popup > AlertDialog

An AlertDialog represents a native dialog pop-up showing a message and up to three buttons. Is automatically disposed when closed.

AlertDialog on Android
Android
AlertDialog on iOS
iOS
Constructor public
Singleton No
Namespace tabris
Direct subclasses None
JSX support Element: <AlertDialog/>
Child elements: None
Text content: Sets message property

Example

import {AlertDialog} from 'tabris';

new AlertDialog({
  title: 'Document saved',
  buttons: {ok: 'OK'}
}).open();

See also:

Constructor

new AlertDialog(properties?)

Parameter Type Optional Description
properties Properties<AlertDialog> Yes Sets all key-value pairs in the properties object as widget properties.

Static Methods

open(alertDialog)

Makes the given alert dialog visible. Meant to be used with inline-JSX. In TypeScript it also casts the given JSX element from any to an actual AlertDialog.

Parameter Type Optional Description
alertDialog AlertDialog No The alert dialog to open

Returns AlertDialog

open(message)

Creates and opens an alert dialog with one ‘OK’ button and the given message.

Parameter Type Optional Description
message string No The message to display

Returns AlertDialog

Properties

buttons

An object with the texts of the buttons to display. There are up to three buttons: ok, cancel and neutral. If no text is given for a button it will not be displayed. Example: {ok: 'Yes', cancel: 'No'} shows ‘Yes’ and ‘No’, but no ‘neutral’ button.

Type {ok?: string, cancel?: string, neutral?: string}
Settable Yes
Change events Yes

message

The message to display inside the dialog.

Type string
Settable Yes
Change events Yes
JSX content type string

When using AlertDialog as an JSX element the element content is mapped to this property. Therefore

<AlertDialog>Hello World</AlertDialog>

has the same effect as:

<AlertDialog message='Hello World' />

textInputs

A composite that may contain TextInput widgets to be displayed alongside the title and message. The text values inserted by the user can be read in the dialogs close event via its texts property. Eg.: dialog.on('close', (e) => e.texts[0])

In an AlertDialog JSX element the TextInput widgets may be given as child elements.

Type ContentView
Default ContentView
Settable No
Change events No

This property can only be set via constructor or JSX. Once set, it cannot change anymore.

title

The title of the dialog.

Type string
Settable Yes
Change events Yes

Events

close

Fired when the dialog was closed for any reason.

Parameter Type Description
button 'ok' | 'cancel' | 'neutral' | null The type of button that was used to close the dialog. Can also be null, e.g. when the global back button was pressed.
texts string[] An array containing the corresponding text values of all textInputs elements.

closeOk

Fired when the dialog was closed by pressing the ‘ok’ button.

closeCancel

Fired when the dialog was closed by pressing the ‘cancel’ button.

closeNeutral

Fired when the dialog was closed by pressing the ‘neutral’ button.

Change Events

titleChanged

Fired when the title property has changed.

Parameter Type Description
value string The new value of title.

messageChanged

Fired when the message property has changed.

Parameter Type Description
value string The new value of message.

buttonsChanged

Fired when the buttons property has changed.

Parameter Type Description
value {ok?: string, cancel?: string, neutral?: string} The new value of buttons.