Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

React Native/Expo Managed Workflow

We recommend using the official npm package: @breeztech/breez-sdk-spark-react-native.

React Native

npm install @breeztech/breez-sdk-spark-react-native

or

yarn add @breeztech/breez-sdk-spark-react-native

Expo Managed Workflow

npx expo install @breeztech/breez-sdk-spark-react-native

Add the plugin to your app.json or app.config.js:

{
  "expo": {
    "plugins": [
      "@breeztech/breez-sdk-spark-react-native"
    ]
  }
}

Plugin Options

To enable Passkey support, set enablePasskey to true. Your app must have the Associated Domains capability enabled. This adds webcredentials:keys.breez.technology to the iOS Associated Domains entitlement:

{
  "expo": {
    "plugins": [
      ["@breeztech/breez-sdk-spark-react-native", {
        "enablePasskey": true
      }]
    ]
  }
}

Developer note

This package contains native code and requires a custom development build. It will not work with Expo Go.