@frigade/react-native

The official React Native SDK for Frigade.

Installation

Install the package with either npm or yarn:

1npm install @frigade/react-native

or

1yarn add @frigade/react-native

Quick start

Place the FrigadeProvider at the root level of your app. This will provide the context for the Frigade component. If available, you can optionally set the identifier of the signed in user using the userId param. This will allow Frigade to track the user's across flows.

1import {FrigadeProvider} from '@frigade/react-native';
2
3const App = () => {
4  return (
5    <FrigadeProvider publicApiKey='<MY_PUBLIC_API_KEY>'
6                     userId='<OPTIONAL_USER_ID>'>
7      ...
8    </FrigadeProvider>
9  );
10};

With the FrigadeProvider in place, you can now use the FrigadeFlow component to render a flow. Make sure to pass the flowId of the flow you want to render (copied from the Frigade dashboard).

1import {FrigadeFlow} from '@frigade/react-native';
2
3const App = () => {
4  return (
5    <FrigadeFlow flowId='flow_6EoJIzZlOmCACn'/>
6  );
7};

Docs

The official docs are available at docs.frigade.com.

Get in touch

Questions? Comments? Suggestions? Join the Frigade Discord or visit the Frigade website.