@woody-willis/nuxt-snipcart

If you are looking for the Nuxt v2 or v3 version please use the original package

Features

• Full typescript support base on snipcart interface documentation
• Full support of snipcart documentation out of the box
• Highly customization with power of Nuxt 4

Quick Setup

1. Add @woody-willis/nuxt-snipcart dependency to your project

npx nuxi@latest module add snipcart

2. Add @woody-willis/nuxt-snipcart to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: ["@woody-willis/nuxt-snipcart"],
  snipcart: {
    publicApiKey: "youkey",
  },
});

That's it! You can now use Snipcart in your Nuxt app ✨

At any time please have a look at our beautiful playground example.

useSnipcart

We tried to not create too much wrapper around the Snipcart api so we don't have to maintain so much if Snipcart change. But you may found some of them useful as:

• exposing snipcart instance
• isReady will define the basic settings are ready to be used but snipcart not loaded yet
• use watch on snipcart to make sure its ready
• realtime store subscription
• utils functions As bindProductItem or bindProductItemCustom
• wrapper utils function to change language or currency using respectively setLanguage or setCurrency

As we have a full typescript support play with it and read the description of what is exposed.

Loading

We are following Snipcart different loadings. You can control the load of the js using loadStrategy configuration property. You can tell snipcart to not load css using loadCSS config property.

If you load async take in consideration you will not have access to window.Snipcart or snipcart exposed by useSnipcart until its loaded. So adapt your logic. Check on playground we have added few comments

Customization

With nuxt it is super easy to customize snipart components. Use your own class css in addition of custom html to override snipcart component.

To do that create for example public/snipcart-custom.html as inside the playground. And make sure you add the path in the nuxt config using templatesUrl property

 snipcart: {
    templatesUrl: '/snipcart-custom.html',

this will after be passed to snipcart to understand what file to retrieve to have access to all templates it will use to build snipcart components

Snipcart SDK

As we told before we expose the snipcart SDK as by default with window.Snipcart or form the composable useSnipcart. So you will have the exact same full access to snipcart SDK

Development

# Install dependencies
npm install

# Develop with the playground
npm dev

# Build the playground
npm dev:build

# Run ESLint
npm lint

# Run Vitest
npm test
npm test:watch

# Release new version
npm release