Cordova Notification Plugin
npm install cordova-plugin-dialogs---
title: Dialogs
description: Use native dialog UI elements
---
|AppVeyor|Travis CI|
|:-:|:-:|
|||
This plugin provides access to some native dialog UI elements
via a global navigator.notification object.
Although the object is attached to the global scoped navigator, it is not available until after the deviceready event.
document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
console.log(navigator.notification);
}
cordova plugin add cordova-plugin-dialogs
- navigator.notification.alert
- navigator.notification.confirm
- navigator.notification.prompt
- navigator.notification.beep
Shows a custom alert or dialog box. Most Cordova implementations use a native
dialog box for this feature, but some platforms use the browser's alert
function, which is typically less customizable.
navigator.notification.alert(message, alertCallback, [title], [buttonName])
- __message__: Dialog message. _(String)_
- __alertCallback__: Callback to invoke when alert dialog is dismissed. _(Function)_
- __title__: Dialog title. _(String)_ (Optional, defaults to Alert)
- __buttonName__: Button name. _(String)_ (Optional, defaults to OK)
function alertDismissed() {
// do something
}
navigator.notification.alert(
'You are the winner!', // message
alertDismissed, // callback
'Game Over', // title
'Done' // buttonName
);
- Android
- Browser
- iOS
- Windows
Displays a customizable confirmation dialog box.
navigator.notification.confirm(message, confirmCallback, [title], [buttonLabels])
- __message__: Dialog message. _(String)_
- __confirmCallback__: Callback to invoke with index of button pressed (1, 2, or 3) or when the dialog is dismissed without a button press (0). _(Function)_
- __title__: Dialog title. _(String)_ (Optional, defaults to Confirm)
- __buttonLabels__: Array of strings specifying button labels. _(Array)_ (Optional, defaults to [OK,Cancel])
The confirmCallback executes when the user presses one of the
buttons in the confirmation dialog box.
The callback takes the argument buttonIndex _(Number)_, which is the
index of the pressed button. Note that the index uses one-based
indexing, so the value is 1, 2, 3, etc.
function onConfirm(buttonIndex) {
alert('You selected button ' + buttonIndex);
}
navigator.notification.confirm(
'You are the winner!', // message
onConfirm, // callback to invoke with index of button pressed
'Game Over', // title
['Restart','Exit'] // buttonLabels
);
- Android
- Browser
- iOS
- Windows
- Android supports a maximum of three buttons, and ignores any more than that.
- Android dialog title cannot exceed 2 lines of content, it will ignore any more than this.
- On Windows8/8.1 it is not possible to add more than three buttons to MessageDialog instance.
- On Windows Phone 8.1 it's not possible to show dialog with more than two buttons.
Displays a native dialog box that is more customizable than the browser's prompt function.
navigator.notification.prompt(message, promptCallback, [title], [buttonLabels], [defaultText])
- __message__: Dialog message. _(String)_
- __promptCallback__: Callback to invoke with index of button pressed (1, 2, or 3) or when the dialog is dismissed without a button press (0). _(Function)_
- __title__: Dialog title _(String)_ (Optional, defaults to Prompt)
- __buttonLabels__: Array of strings specifying button labels _(Array)_ (Optional, defaults to ["OK","Cancel"])
- __defaultText__: Default textbox input value (String) (Optional, Default: empty string)
The promptCallback executes when the user presses one of the buttons
in the prompt dialog box. The results object passed to the callback
contains the following properties:
- __buttonIndex__: The index of the pressed button. _(Number)_ Note that the index uses one-based indexing, so the value is 1, 2, 3, etc.
- __input1__: The text entered in the prompt dialog box. _(String)_
function onPrompt(results) {
alert("You selected button number " + results.buttonIndex + " and entered " + results.input1);
}
navigator.notification.prompt(
'Please enter your name', // message
onPrompt, // callback to invoke
'Registration', // title
['Ok','Exit'], // buttonLabels
'Jane Doe' // defaultText
);
- Android
- Browser
- iOS
- Windows
- Android supports a maximum of three buttons, and ignores any more than that.
- On Android 3.0 and later, buttons are displayed in reverse order for devices that use the Holo theme.
- On Windows prompt dialog is html-based due to lack of such native api.
The device plays a beep sound.
navigator.notification.beep(times);
- __times__: The number of times to repeat the beep. _(Number)_
// Beep twice!
navigator.notification.beep(2);
- Android
- Browser
- iOS
- Windows 8
- Android plays the default __Notification ringtone__ specified under the __Settings/Sound & Display__ panel.