Getting Started

Install

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.