• Stars
    star
    1,612
  • Rank 27,805 (Top 0.6 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created over 4 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

React components for Stripe.js and Stripe Elements

React Stripe.js

React components for Stripe.js and Elements.

build status npm version

Requirements

The minimum supported version of React is v16.8. If you use an older version, upgrade React to use this library. If you prefer not to upgrade your React version, we recommend using legacy react-stripe-elements.

Getting started

Documentation

Minimal example

First, install React Stripe.js and Stripe.js.

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

Using hooks

import React from 'react';
import ReactDOM from 'react-dom';
import {loadStripe} from '@stripe/stripe-js';
import {
  PaymentElement,
  Elements,
  useStripe,
  useElements,
} from '@stripe/react-stripe-js';

const CheckoutForm = () => {
  const stripe = useStripe();
  const elements = useElements();

  const [errorMessage, setErrorMessage] = useState(null);

  const handleSubmit = async (event) => {
    event.preventDefault();

    if (elements == null) {
      return;
    }

    // Trigger form validation and wallet collection
    const {error: submitError} = await elements.submit();
    if (submitError) {
      // Show error to your customer
      setErrorMessage(submitError.message);
      return;
    }

    // Create the PaymentIntent and obtain clientSecret from your server endpoint
    const res = await fetch('/create-intent', {
      method: 'POST',
    });

    const {client_secret: clientSecret} = await res.json();

    const {error} = await stripe.confirmPayment({
      //`Elements` instance that was used to create the Payment Element
      elements,
      clientSecret,
      confirmParams: {
        return_url: 'https://example.com/order/123/complete',
      },
    });

    if (error) {
      // This point will only be reached if there is an immediate error when
      // confirming the payment. Show error to your customer (for example, payment
      // details incomplete)
      setErrorMessage(error.message);
    } else {
      // Your customer will be redirected to your `return_url`. For some payment
      // methods like iDEAL, your customer will be redirected to an intermediate
      // site first to authorize the payment, then redirected to the `return_url`.
    }
  };

  return (
    <form onSubmit={handleSubmit}>
      <PaymentElement />
      <button type="submit" disabled={!stripe || !elements}>
        Pay
      </button>
      {/* Show error message to your customers */}
      {errorMessage && <div>{errorMessage}</div>}
    </form>
  );
};

const stripePromise = loadStripe('pk_test_6pRNASCoBOKtIshFeQd4XMUh');

const options = {
  mode: 'payment',
  amount: 1099,
  currency: 'usd',
  // Fully customizable with appearance API.
  appearance: {
    /*...*/
  },
};

const App = () => (
  <Elements stripe={stripePromise} options={options}>
    <CheckoutForm />
  </Elements>
);

ReactDOM.render(<App />, document.body);

Using class components

import React from 'react';
import ReactDOM from 'react-dom';
import {loadStripe} from '@stripe/stripe-js';
import {
  PaymentElement,
  Elements,
  ElementsConsumer,
} from '@stripe/react-stripe-js';

class CheckoutForm extends React.Component {
  handleSubmit = async (event) => {
    event.preventDefault();
    const {stripe, elements} = this.props;

    if (elements == null) {
      return;
    }

    // Trigger form validation and wallet collection
    const {error: submitError} = await elements.submit();
    if (submitError) {
      // Show error to your customer
      return;
    }

    // Create the PaymentIntent and obtain clientSecret
    const res = await fetch('/create-intent', {
      method: 'POST',
    });

    const {client_secret: clientSecret} = await res.json();

    const {error} = await stripe.confirmPayment({
      //`Elements` instance that was used to create the Payment Element
      elements,
      clientSecret,
      confirmParams: {
        return_url: 'https://example.com/order/123/complete',
      },
    });

    if (error) {
      // This point will only be reached if there is an immediate error when
      // confirming the payment. Show error to your customer (for example, payment
      // details incomplete)
    } else {
      // Your customer will be redirected to your `return_url`. For some payment
      // methods like iDEAL, your customer will be redirected to an intermediate
      // site first to authorize the payment, then redirected to the `return_url`.
    }
  };

  render() {
    const {stripe} = this.props;
    return (
      <form onSubmit={this.handleSubmit}>
        <PaymentElement />
        <button type="submit" disabled={!stripe}>
          Pay
        </button>
      </form>
    );
  }
}

const InjectedCheckoutForm = () => (
  <ElementsConsumer>
    {({stripe, elements}) => (
      <CheckoutForm stripe={stripe} elements={elements} />
    )}
  </ElementsConsumer>
);

const stripePromise = loadStripe('pk_test_6pRNASCoBOKtIshFeQd4XMUh');

const options = {
  mode: 'payment',
  amount: 1099,
  currency: 'usd',
  // Fully customizable with appearance API.
  appearance: {
    /*...*/
  },
};

const App = () => (
  <Elements stripe={stripePromise} options={options}>
    <InjectedCheckoutForm />
  </Elements>
);

ReactDOM.render(<App />, document.body);

TypeScript support

React Stripe.js is packaged with TypeScript declarations. Some types are pulled from @stripe/stripe-js—be sure to add @stripe/stripe-js as a dependency to your project for full TypeScript support.

Typings in React Stripe.js follow the same versioning policy as @stripe/stripe-js.

Contributing

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

More Repositories

1

stripe-node

Node.js library for the Stripe API.
TypeScript
3,591
star
2

stripe-php

PHP library for the Stripe API.
PHP
3,558
star
3

stripe-ios

Stripe iOS SDK
Swift
2,023
star
4

stripe-go

Go library for the Stripe API.
Go
1,948
star
5

stripe-ruby

Ruby library for the Stripe API.
Ruby
1,866
star
6

veneur

A distributed, fault-tolerant pipeline for observability data
Go
1,690
star
7

stripe-cli

A command-line tool for Stripe
Go
1,545
star
8

stripe-python

Python library for the Stripe API.
Python
1,507
star
9

stripe-dotnet

Stripe.net is a sync/async .NET 4.6.1+ client, and a portable class library for stripe.com.
C#
1,307
star
10

stripe-mock

stripe-mock is a mock HTTP server that responds like the real Stripe API. It can be used instead of Stripe's testmode to make test suites integrating with Stripe faster and less brittle.
Go
1,278
star
11

stripe-android

Stripe Android SDK
Kotlin
1,207
star
12

stripe-react-native

React Native library for Stripe.
TypeScript
1,200
star
13

smokescreen

A simple HTTP proxy that fogs over naughty URLs
Go
988
star
14

elements-examples

Stripe Elements examples.
HTML
987
star
15

stripe-java

Java library for the Stripe API.
Java
735
star
16

skycfg

Skycfg is an extension library for the Starlark language that adds support for constructing Protocol Buffer messages.
Go
629
star
17

stripe-connect-rocketrides

Sample on-demand platform built on Stripe: Connect onboarding for pilots, iOS app for passengers to request rides.
Swift
614
star
18

stripe-js

Loading wrapper for Stripe.js
TypeScript
561
star
19

poncho

Easily create REST APIs
Ruby
518
star
20

rainier

Bayesian inference in Scala.
Scala
435
star
21

openapi

An OpenAPI specification for the Stripe API.
351
star
22

stripe-billing-typographic

⚡️Typographic is a webfont service (and demo) built with Stripe Billing.
JavaScript
216
star
23

subprocess

A port of Python's subprocess module to Ruby
Ruby
193
star
24

carbon-removal-source-materials

Source materials supporting Stripe Climate carbon removal purchases (http://stripe.com/climate)
189
star
25

dagon

Tools for rewriting and optimizing DAGs (directed-acyclic graphs) in Scala
Scala
148
star
26

bonsai

Beautiful trees, without the landscaping.
Scala
142
star
27

pg-schema-diff

Go library for diffing Postgres schemas and generating SQL migrations
Go
141
star
28

ios-dashboard-ui

[DEPRECATED] UI components from the Stripe Dashboard iOS app
Swift
136
star
29

stripe-apps

Stripe Apps lets you embed custom user experiences directly in the Stripe Dashboard and orchestrate the Stripe API.
TypeScript
134
star
30

vscode-stripe

Stripe for Visual Studio Code
TypeScript
117
star
31

example-mobile-backend

A simple, easy-to-deploy backend that you can use to demo our example mobile apps.
Ruby
105
star
32

stripe.github.io

A landing page for Stripe's GitHub organization
HTML
94
star
33

stripe-terminal-ios

Stripe Terminal iOS SDK
Objective-C
92
star
34

stripe-demo-connect-roastery-saas-platform

Roastery demo SaaS platform using Stripe Connect
JavaScript
89
star
35

stripe-terminal-react-native

React Native SDK for Stripe Terminal
TypeScript
84
star
36

example-terminal-backend

A simple, easy-to-deploy backend that you can use to run the Stripe Terminal example apps
Ruby
79
star
37

stripe-terminal-android

Stripe Terminal Android SDK
Java
77
star
38

unilog

A logger for use with daemontools.
Go
77
star
39

stripe-terminal-js-demo

Demo app for the Stripe Terminal JS SDK
JavaScript
75
star
40

stripe-postman

Postman collection for Stripe's API
73
star
41

goforit

A feature flags client library for Go
Go
68
star
42

stripe-connect-custom-rocketdeliveries

Sample on-demand platform built on Stripe Connect: Custom Accounts and Connect Onboarding for deliveries. https://rocketdeliveries.io
JavaScript
62
star
43

tracer-objc

Generic record & playback framework for Objective-C
Objective-C
51
star
44

mobile-viewport-control

Dynamically control the mobile viewport
JavaScript
47
star
45

log4j-remediation-tools

Tools for remediating the recent log4j2 RCE vulnerability (CVE-2021-44228)
Go
41
star
46

terminal-js

Loading wrapper for the Terminal JS SDK
TypeScript
30
star
47

stripe-reachability

A bash script to test access to the Stripe API
Shell
29
star
48

krl

OpenSSH Key Revocation List support for Go
Go
29
star
49

stripe-identity-react-native

React Native library for Stripe Identity
TypeScript
28
star
50

stripe-magento2-releases

22
star
51

checkout-sales-demo

Sales demo of Stripe Checkout with different locales around the world.
HTML
12
star
52

stripe-ios-spm

Swift Package Manager mirror for the Stripe iOS SDK. See http://github.com/stripe/stripe-ios for details.
12
star
53

connect-js

Loading wrapper for Connect.js
TypeScript
11
star
54

react-connect-js

React components for Connect.js and Connect embedded components
TypeScript
11
star
55

salesforce-connector-examples

Stripe Salesforce Connector examples
JavaScript
10
star
56

stripe-mirakl-connector

Official Stripe Mirakl Connector
PHP
10
star
57

homebrew-stripe-mock

Homebrew tap for stripestub
Ruby
6
star
58

homebrew-stripe-cli

Ruby
6
star
59

.github

Stripe uses the Contributor Covenant Code of Conduct for our open-source community.
6
star
60

scoop-stripe-cli

4
star
61

ssf-ruby

A Ruby client for the Sensor Sensibility Format
Ruby
4
star
62

stripe-sfcc-b2c-connector

JavaScript
2
star