# Dialogs Plugin

Tested Version: [2.0.2](https://github.com/apache/cordova-plugin-dialogs/releases/tag/2.0.2)

{% hint style="info" %}
This document is based on the original Cordova docs available at [Cordova Docs](https://github.com/apache/cordova-plugin-dialogs).
{% endhint %}

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.

```javascript
document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    console.log(navigator.notification);
}
```

## Plugin ID

```javascript
cordova-plugin-dialogs
```

## Adding the Plugin in Monaca

In order to use this plugin, please [enable](/products_guide/monaca_ide/dependencies/cordova_plugin.md#import-cordova-plugins) `Notification` plugin in Monaca Cloud IDE.

## Methods

* `navigator.notification.alert`
* `navigator.notification.confirm`
* `navigator.notification.prompt`
* `navigator.notification.beep`

### navigator.notification.alert

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.

```javascript
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`)

#### Example

```javascript
function alertDismissed() {
    // do something
}

navigator.notification.alert(
    'You are the winner!',  // message
    alertDismissed,         // callback
    'Game Over',            // title
    'Done'                  // buttonName
);
```

#### Supported Platforms

* Android
* iOS

### navigator.notification.confirm

Displays a customizable confirmation dialog box.

```javascript
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`])

#### confirmCallback

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.

#### Example

```javascript
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
);
```

#### Supported Platforms

* Android
* iOS

#### Android Quirks

* Android supports a maximum of three buttons, and ignores any more than that.

### navigator.notification.prompt

Displays a native dialog box that is more customizable than the browser's `prompt` function.

```javascript
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)

#### promptCallback

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)*

#### Example

```javascript
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
);
```

#### Supported Platforms

* Android
* iOS

#### Android Quirks

* 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.

### navigator.notification.beep

The device plays a beep sound.

```javascript
navigator.notification.beep(times);
```

* **times**: The number of times to repeat the beep. *(Number)*

#### Example

```javascript
// Beep twice!
navigator.notification.beep(2);
```

#### Supported Platforms

* Android
* iOS

#### Android Quirks

* Android plays the default **Notification ringtone** specified under the **Settings/Sound & Display** panel.

See Also:

* [Third-party Cordova Plugins](/reference/third_party_phonegap.md)
* [Core Cordova Plugins](/reference/core-cordova-plugins.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://en.docs.monaca.io/reference/core-cordova-plugins/cordova_10.0/dialogs.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.