@stripe/react-connect-js

React Connect.js

React components for Connect.js and Connect embedded components

This project is a thin React wrapper around Connect embedded components. It allows you to add embedded components to any React app, and manages the state and lifecycle of embedded components for you.

Note: Some Connect embedded components are currently still in preview. These can be viewed on our doc site, where you can also request preview access.

Components

The list of supported components and their required parameters can be found here

Minimal example

First, install React Connect.js and Connect.js.

1npm install @stripe/react-connect-js @stripe/connect-js

You have to wrap your components with ConnectComponentsProvider in order to provide the ConnectInstance context to create or update components

Example

See more examples in the /examples folder

1import React from 'react';
2import ReactDOM from 'react-dom';
3import {loadConnectAndInitialize} from '@stripe/connect-js';
4import {
5  ConnectPayments,
6  ConnectPayouts,
7  ConnectPaymentDetails,
8  ConnectComponentsProvider,
9} from '@stripe/react-connect-js';
10
11const fetchClientSecret = async () => {
12  // Fetch the AccountSession client secret by making an API call to your service
13};
14const connectInstance = loadConnectAndInitialize({
15  publishableKey: '{{pk test123}}',
16  fetchClientSecret: fetchClientSecret,
17  appearance: {
18    variables: {
19      colorPrimary: '#228403', //optional appearance param,
20    },
21  },
22});
23
24const App = () => (
25  <ConnectComponentsProvider connectInstance={connectInstance}>
26    <ConnectPayments />
27    <ConnectPayouts />
28    <ConnectPaymentDetails
29      onClose={() => {
30        console.log('closed');
31      }}
32      payment="pi_test123"
33    />
34  </ConnectComponentsProvider>
35);
36
37ReactDOM.render(<App />, document.body);

The stripeConnect.initalize function returns a ConnectInstance once you initialize it with a publishable key and a client secret returned from the Account Session API call.

We’ve placed a placeholder API key in this example. Replace it with your actual publishable API keys to test this code through your Connect account.

Contributing

If you would like to contribute to React Connect.js, please make sure to read our contributor guidelines.