/gatsby-plugin-snipcartv3

A plugin for using Snipcart v3 with Gatsby.

Primary LanguageJavaScript

gatsby-plugin-snipcartv3

Now On SnipCart v3.2.1 🚀 (release notes - https://docs.snipcart.com/v3/release-notes)

An update to the wildly popular & original gatsby-plugin-snipcart.

A plugin for using the latest Version v3.2.1 of Snipcart with Gatsby.

Install

npm i gatsby-plugin-snipcartv3

Note

The plugin no longer uses JQuery!

Usage

In your gatsby-config.js file, add:

module.exports = {
  plugins: [
    {
      resolve: 'gatsby-plugin-snipcartv3',
      options: {
        apiKey: 'YOUR_SNIPCART_KEY'
      }
    }
  ]
};

To add a snipcart product to yor site, just add a HTML element with the data types below

<button class="snipcart-add-item"
  data-item-id="starry-night"
  data-item-price="79.99"
  data-item-url="/paintings/starry-night"
  data-item-description="High-quality replica of The Starry Night by the Dutch post-impressionist painter Vincent van Gogh."
  data-item-image="/assets/images/starry-night.jpg"
  data-item-name="The Starry Night">
  Add to cart
</button>

Options

apiKey (required): Your Snipcart API key. If not set, it will try to find it in process.env.GATSBY_SNIPCART_APIKEY.

autopop: Whether or not the cart will open once a product is added. (Defaults to false)

js: A Snipcart JavaScript file. (Defaults to https://cdn.snipcart.com/themes/v3.0.27/default/snipcart.js)

styles: A stylesheet file to link to. Set to false for none. (Defaults to https://cdn.snipcart.com/themes/v3.0.27/default/snipcart.css)