@capgo/capacitor-autofill-save-password

Prompt to display dialog for saving password to keychain from webview app

Fork of original plugin to work with Capacitor 7

IOS work for old versions and 18.3

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/autofill-save-password/

Compatibility

Plugin version	Capacitor compatibility	Maintained
v8.*.*	v8.*.*	✅
v7.*.*	v7.*.*	On demand
v6.*.*	v6.*.*	❌
v5.*.*	v5.*.*	❌

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

npm install @capgo/capacitor-autofill-save-password
npx cap sync

Prerequisite

You must set up your app’s associated domains. To learn how to set up your app’s associated domains, see Supporting Associated Domains in Apple Developer document.

Then add in your App.entitlements

	<key>com.apple.developer.associated-domains</key>
	<array>
		<string>webcredentials:YOURDOMAIN</string>
	</array>

To associate your domain to your app.

How to use

import { Capacitor } from '@capacitor/core';
import { SavePassword } from '@capgo/capacitor-autofill-save-password';
    
login(username: string, password: string) {
    // your login logic here
        
        SavePassword.promptDialog({
            username: username,
            password: password,
        })
        .then(() => console.log('promptDialog success'))
        .catch((err) => console.error('promptDialog failure', err));
}

Android

Add apply plugin: 'com.google.gms.google-services' beneath apply plugin: 'com.android.application' in android/app/build.gradle

this will allow the plugin to import the proper lib.

Then you need to make sure you did set properly your domain and did add google-services.json.

guide here https://developer.android.com/identity/sign-in/credential-manager

You need to have the file at this path android/google-services.json set, if you dont use firebase add empty json

then add your domain in example-app/android/app/src/main/res/values/strings.xml

with

    <string name="asset_statements" translatable="false">
    [{
    \"include\": \"https://YOURDOMAIN/.well-known/assetlinks.json\"
    }]
    </string>

API

• promptDialog(...)
• readPassword()
• getPluginVersion()
• Interfaces

promptDialog(...)

promptDialog(options: Options) => Promise<void>

Save a password to the keychain.

Param	Type	Description
options	Options	- The options for the password.

---

readPassword()

readPassword() => Promise<ReadPasswordResult>

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

Returns: Promise<ReadPasswordResult>

---

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

Since: 1.0.0

---

Interfaces

Options

Prop	Type	Description
username	string	The username to save.
password	string	The password to save.
url	string	The url to save the password for. (For example: "console.capgo.app") iOS only.

ReadPasswordResult

Prop	Type	Description
username	string	The username of the password.
password	string	The password of the password.