Capacitor SDK

The Quiltt Capacitor SDK provides native Capacitor plugin support for Quiltt Connector, with framework-specific adapters for React and Vue 3.

Package	Use case
@quiltt/capacitor	Any framework (Vue, Angular, Svelte, vanilla JS)
@quiltt/capacitor/vue	Vue 3 components and composables
@quiltt/capacitor/react	React components and hooks

Link to this section#Installation

Link to this section#Deep Link Configuration

OAuth bank authentication redirects the user back to your app via a deep link. You need to configure a URL scheme for this callback.

Link to this section#iOS — ios/App/App/Info.plist

Link to this section#Android — android/app/src/main/AndroidManifest.xml

After making configuration changes, run npx cap sync to propagate them to the native projects.

Link to this section#React

OAuth is handled automatically — bank auth opens in the system browser and deep link callbacks are captured on return.

For modal-based connection, use QuilttButton:

@quiltt/capacitor/react re-exports everything from @quiltt/react, including QuilttProvider, QuilttButton, QuilttContainer, useQuilttSession, useQuilttConnector, useQuilttClient, useQuery, useMutation, and gql.

Link to this section#Vue

Register the plugin and set up deep link handling:

For modal-based connection:

@quiltt/capacitor/vue re-exports everything from @quiltt/vue.

Link to this section#Other Frameworks

Use the native plugin directly with Angular, Svelte, or vanilla JS:

Link to this section#Reconnection

Pass connectionId (React) or connection-id (Vue) to repair or reconnect an existing Connection. See the Reconnect Flow guide for more information.

Link to this section#API Reference

Link to this section#Native Plugin

Method	Description
openUrl({ url })	Opens a URL in the system browser
getLaunchUrl()	Returns the URL that launched the app
addListener('deepLink', callback)	Listens for deep link callbacks
removeAllListeners()	Removes all event listeners

Link to this section#Component Props

Prop	Type	Description
connectorId	string	Required. Quiltt Connector ID
connectionId	string	Existing connection ID for reconnection
institution	string	Pre-select an institution
appLauncherUrl	string	Deep link URL for OAuth callbacks
onLoad	(metadata) => void	Connector loaded
onExitSuccess	(metadata) => void	Connection successful
onExitAbort	(metadata) => void	User cancelled
onExitError	(metadata) => void	Error occurred

Link to this section#Troubleshooting

Link to this section#OAuth redirects not working

• Verify appLauncherUrl matches your configured URL scheme.
• Run npx cap sync after any configuration changes.

Link to this section#Blank screen after bank auth

• Check the browser console for errors.
• Verify your Connector ID is correct.