A simple GatsbyJS plugin that adds Stripe's checkout.js to site
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.babelrc
.gitignore
CHANGELOG.md
README.md
gatsby-ssr.js
index.js
package-lock.json
package.json

README.md

gatsby-plugin-stripe-checkout

A simple plugin that adds the Stripe Checkout JavaScript file to every page of your Gatsby site.

Use cases include:

  • Create an e-commerce store where you bring in your products and skus via gatsby-source-stripe and then use Stripe Checkout to handle user purchases. Note that currently when using Stripe Checkout you will need to also have a backend process for handling payments (AWS Lambda or clay.run are good options here).

If you want more control over the checkout experience, it's recommended that you use Stripe Elements instead of Stripe Checkout. For integrating Stripe Elements into your Gatsby site, use gatsby-plugin-stripe.

An example project using this plugin is Unicorn Mart.

How to use

  1. Install using either npm or yarn:
yarn add gatsby-plugin-stripe-checkout

or

npm install gatsby-plugin-stripe-checkout
  1. Add to gatsby-config.js
module.exports = {
  plugins: [
    `gatsby-plugin-stripe-checkout`,
  ]
}

To load the <script> tag asyncronously, pass an 'async' option in gatsby-config.js.

module.exports = {
  plugins: [
    {
      resolve: `gatsby-plugin-stripe-checkout`,
      options: {
        async: true,
      },
    },
  ],
}