--- description: Capacitor plugin for native alert, confirm, and prompt dialogs on Android, iOS, and the web. title: Capacitor Dialog Plugin for Android, iOS & Web - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/dialog.png --- [Skip to content ](#capacitor-dialog-plugin) [🔐 Introducing the **Capacitor Vault** plugin — store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/) * [ SDKs ](/docs/sdks/) * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Migrating from @capacitor/dialog ](#migrating-from-capacitordialog) * [ Changelog ](#changelog) * [ License ](#license) * [ Facebook Sign-In ](/docs/sdks/capacitor/facebook-sign-in/) * [ File Compressor ](/docs/sdks/capacitor/file-compressor/) * [ File Opener ](/docs/sdks/capacitor/file-opener/) * [ File Picker ](/docs/sdks/capacitor/file-picker/) * [ Firebase ](/docs/sdks/capacitor/firebase/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ Gyroscope ](/docs/sdks/capacitor/gyroscope/) * [ Haptics ](/docs/sdks/capacitor/haptics/) * [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/) * [ Install Referrer ](/docs/sdks/capacitor/install-referrer/) * [ Keep Awake ](/docs/sdks/capacitor/keep-awake/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Localization ](/docs/sdks/capacitor/localization/) * [ Mail Composer ](/docs/sdks/capacitor/mail-composer/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ Network ](/docs/sdks/capacitor/network/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ Node.js ](/docs/sdks/capacitor/nodejs/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Passkeys ](/docs/sdks/capacitor/passkeys/) * [ Password Autofill ](/docs/sdks/capacitor/password-autofill/) * [ PDF Generator ](/docs/sdks/capacitor/pdf-generator/) * [ PDF Viewer ](/docs/sdks/capacitor/pdf-viewer/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ PixLive ](/docs/sdks/capacitor/pixlive/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Root Detection ](/docs/sdks/capacitor/root-detection/) * [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screen Reader ](/docs/sdks/capacitor/screen-reader/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Settings Launcher ](/docs/sdks/capacitor/settings-launcher/) * [ Shake ](/docs/sdks/capacitor/shake/) * [ Silent Mode ](/docs/sdks/capacitor/silent-mode/) * [ SIM ](/docs/sdks/capacitor/sim/) * [ SMS Composer ](/docs/sdks/capacitor/sms-composer/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ Text Zoom ](/docs/sdks/capacitor/text-zoom/) * [ Thermal State ](/docs/sdks/capacitor/thermal-state/) * [ Toast ](/docs/sdks/capacitor/toast/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Volume ](/docs/sdks/capacitor/volume/) * [ Wallet ](/docs/sdks/capacitor/wallet/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Migrating from @capacitor/dialog ](#migrating-from-capacitordialog) * [ Changelog ](#changelog) * [ License ](#license) # Capacitor Dialog Plugin[¶](#capacitor-dialog-plugin "Permanent link") Capacitor plugin for native alert, confirm, and prompt dialogs. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Features[¶](#features "Permanent link") * 💬 **Alert**: Display a native alert dialog with a single button. * ❓ **Confirm**: Ask the user to confirm or cancel an action. * ⌨️ **Prompt**: Request text input from the user. * 🌐 **Cross-platform**: Works on Android, iOS, and the web. * 🔒 **App Store safe**: Uses only official platform APIs. * 📦 **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS. * 🔁 **Up-to-date**: Always supports the latest Capacitor version. Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look! ## Newsletter[¶](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Compatibility[¶](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 0.x.x | \>=8.x.x | Active support | ## Installation[¶](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-dialog` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below: `[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-dialog [](#%5F%5Fcodelineno-2-2)npx cap sync ` ### Android[¶](#android "Permanent link") No additional configuration is required for this plugin. ### iOS[¶](#ios "Permanent link") No additional configuration is required for this plugin. ## Configuration[¶](#configuration "Permanent link") No configuration required for this plugin. ## Usage[¶](#usage "Permanent link") `[](#%5F%5Fcodelineno-3-1)import { Dialog } from '@capawesome/capacitor-dialog'; [](#%5F%5Fcodelineno-3-2) [](#%5F%5Fcodelineno-3-3)const alert = async () => { [](#%5F%5Fcodelineno-3-4) await Dialog.alert({ [](#%5F%5Fcodelineno-3-5) title: 'Success', [](#%5F%5Fcodelineno-3-6) message: 'Your changes have been saved.', [](#%5F%5Fcodelineno-3-7) }); [](#%5F%5Fcodelineno-3-8)}; [](#%5F%5Fcodelineno-3-9) [](#%5F%5Fcodelineno-3-10)const confirm = async () => { [](#%5F%5Fcodelineno-3-11) const { value } = await Dialog.confirm({ [](#%5F%5Fcodelineno-3-12) title: 'Confirm', [](#%5F%5Fcodelineno-3-13) message: 'Do you want to delete this item?', [](#%5F%5Fcodelineno-3-14) }); [](#%5F%5Fcodelineno-3-15) console.log('Confirmed:', value); [](#%5F%5Fcodelineno-3-16)}; [](#%5F%5Fcodelineno-3-17) [](#%5F%5Fcodelineno-3-18)const prompt = async () => { [](#%5F%5Fcodelineno-3-19) const { value, canceled } = await Dialog.prompt({ [](#%5F%5Fcodelineno-3-20) title: 'Name', [](#%5F%5Fcodelineno-3-21) message: 'What is your name?', [](#%5F%5Fcodelineno-3-22) inputPlaceholder: 'Enter your name', [](#%5F%5Fcodelineno-3-23) }); [](#%5F%5Fcodelineno-3-24) console.log('Value:', value, 'Canceled:', canceled); [](#%5F%5Fcodelineno-3-25)}; ` ## API[¶](#api "Permanent link") * [alert(...)](#alert) * [confirm(...)](#confirm) * [prompt(...)](#prompt) * [Interfaces](#interfaces) ### alert(...)[¶](#alert "Permanent link") `[](#%5F%5Fcodelineno-4-1)alert(options: AlertOptions) => Promise ` Display an alert dialog with a single button. | Param | Type | | ----------- | ----------------------------- | | **options** | [AlertOptions](#alertoptions) | **Since:** 0.1.0 --- ### confirm(...)[¶](#confirm "Permanent link") `[](#%5F%5Fcodelineno-5-1)confirm(options: ConfirmOptions) => Promise ` Display a confirmation dialog with two buttons. | Param | Type | | ----------- | --------------------------------- | | **options** | [ConfirmOptions](#confirmoptions) | **Returns:** `Promise<[ConfirmResult](#confirmresult)>` **Since:** 0.1.0 --- ### prompt(...)[¶](#prompt "Permanent link") `[](#%5F%5Fcodelineno-6-1)prompt(options: PromptOptions) => Promise ` Display a prompt dialog with a text input, a confirm and a cancel button. | Param | Type | | ----------- | ------------------------------- | | **options** | [PromptOptions](#promptoptions) | **Returns:** `Promise<[PromptResult](#promptresult)>` **Since:** 0.1.0 --- ### Interfaces[¶](#interfaces "Permanent link") #### AlertOptions[¶](#alertoptions "Permanent link") | Prop | Type | Description | Default | Since | | --------------- | ------ | ------------------------------------------------------------------------------------------------------------------- | ------- | ----- | | **buttonTitle** | string | The title of the button that confirms the dialog. On the web, the button title cannot be customized and is ignored. | 'OK' | 0.1.0 | | **message** | string | The message to display in the dialog. | | 0.1.0 | | **title** | string | The title of the dialog. On the web, the title cannot be customized and is ignored. | | 0.1.0 | #### ConfirmResult[¶](#confirmresult "Permanent link") | Prop | Type | Description | Since | | --------- | ------- | -------------------------------------- | ----- | | **value** | boolean | Whether the user confirmed the dialog. | 0.1.0 | #### ConfirmOptions[¶](#confirmoptions "Permanent link") | Prop | Type | Description | Default | Since | | --------------------- | ------ | ------------------------------------------------------------------------------------------------------------------- | -------- | ----- | | **cancelButtonTitle** | string | The title of the button that cancels the dialog. On the web, the button title cannot be customized and is ignored. | 'Cancel' | 0.1.0 | | **message** | string | The message to display in the dialog. | | 0.1.0 | | **okButtonTitle** | string | The title of the button that confirms the dialog. On the web, the button title cannot be customized and is ignored. | 'OK' | 0.1.0 | | **title** | string | The title of the dialog. On the web, the title cannot be customized and is ignored. | | 0.1.0 | #### PromptResult[¶](#promptresult "Permanent link") | Prop | Type | Description | Since | | ------------ | ------- | ------------------------------------- | ----- | | **canceled** | boolean | Whether the user canceled the dialog. | 0.1.0 | | **value** | string | The value of the text input. | 0.1.0 | #### PromptOptions[¶](#promptoptions "Permanent link") | Prop | Type | Description | Default | Since | | --------------------- | ------ | ------------------------------------------------------------------------------------------------------------------- | -------- | ----- | | **cancelButtonTitle** | string | The title of the button that cancels the dialog. On the web, the button title cannot be customized and is ignored. | 'Cancel' | 0.1.0 | | **inputPlaceholder** | string | The placeholder of the text input. On the web, the placeholder cannot be customized and is ignored. | | 0.1.0 | | **inputText** | string | The initial value of the text input. | | 0.1.0 | | **message** | string | The message to display in the dialog. | | 0.1.0 | | **okButtonTitle** | string | The title of the button that confirms the dialog. On the web, the button title cannot be customized and is ignored. | 'OK' | 0.1.0 | | **title** | string | The title of the dialog. On the web, the title cannot be customized and is ignored. | | 0.1.0 | ## Migrating from `@capacitor/dialog`[¶](#migrating-from-capacitordialog "Permanent link") This plugin is API-compatible with the official [@capacitor/dialog](https://github.com/ionic-team/capacitor-plugins/tree/main/dialog) plugin, with a single difference: the `prompt(...)` result uses the property `canceled` (one `l`) instead of `cancelled` (two `l`s). | @capacitor/dialog | @capawesome/capacitor-dialog | | -------------------------------------- | -------------------------------------- | | alert({ title, message, buttonTitle }) | alert({ title, message, buttonTitle }) | | confirm({ ... }) → { value } | confirm({ ... }) → { value } | | prompt({ ... }) → { value, cancelled } | prompt({ ... }) → { value, canceled } | ## Changelog[¶](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/dialog/CHANGELOG.md). ## License[¶](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/dialog/LICENSE). July 7, 2026 Back to top ```json {"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/dialog/#article", "headline": "Capacitor Dialog Plugin for Android, iOS & Web", "name": "Capacitor Dialog Plugin for Android, iOS & Web", "description": "Capacitor plugin for native alert, confirm, and prompt dialogs on Android, iOS, and the web.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/dialog/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/dialog/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/dialog/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/dialog/#software", "name": "Capacitor Dialog Plugin for Android, iOS & Web", "description": "Capacitor plugin for native alert, confirm, and prompt dialogs on Android, iOS, and the web.", "url": "https://capawesome.io/docs/sdks/capacitor/dialog/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]} ```