Getting Started

Copy a setup prompt with the install steps and the full markdown guide for this plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-autofill-save-password`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/autofill-save-password/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-autofill-save-password` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

bun add @capgo/capacitor-autofill-save-password
bunx cap sync

Import

import { SavePassword } from '@capgo/capacitor-autofill-save-password';

API Overview

`promptDialog`

Save a password to the keychain.

import { SavePassword } from '@capgo/capacitor-autofill-save-password';

await SavePassword.promptDialog({
  username: 'your-username',
  password: 'your-password'
});

`readPassword`

Read a password from the keychain. Requires the developer to setup associated domain for the app for iOS.

import { SavePassword } from '@capgo/capacitor-autofill-save-password';

await SavePassword.readPassword();

Type Reference

`Options`

export interface Options {
  /**
   * The username to save.
   */
  username: string;
  /**
   * The password to save.
   */
  password: string;
  /**
   * The url to save the password for. (For example: "console.capgo.app")
   * iOS only.
   */
  url?: string;
}

`ReadPasswordResult`

export interface ReadPasswordResult {
  /**
   * The username of the password.
   */
  username: string;
  /**
   * The password of the password.
   */
  password: string;
}

Source Of Truth

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.

Keep going from Getting Started

If you are using Getting Started to plan authentication and account flows, connect it with Using @capgo/capacitor-autofill-save-password for the native capability in Using @capgo/capacitor-autofill-save-password, @capgo/capacitor-social-login for the implementation detail in @capgo/capacitor-social-login, @capgo/capacitor-passkey for the implementation detail in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric for the implementation detail in @capgo/capacitor-native-biometric, and Two-factor authentication for the implementation detail in Two-factor authentication.