https://github.com/adammatthiesen/astro-snipcart
Astro Snipcart integration
https://github.com/adammatthiesen/astro-snipcart
astro astro-component astrojs snipcart
Last synced: 4 months ago
JSON representation
Astro Snipcart integration
- Host: GitHub
- URL: https://github.com/adammatthiesen/astro-snipcart
- Owner: Adammatthiesen
- License: mit
- Archived: true
- Created: 2024-01-06T02:15:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-24T10:21:04.000Z (11 months ago)
- Last Synced: 2025-01-13T01:13:48.850Z (4 months ago)
- Topics: astro, astro-component, astrojs, snipcart
- Language: Astro
- Homepage: https://matthiesen.xyz/blog/getting-started-with-my-astro-snipcart-addon
- Size: 199 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Welcome to Astro Snipcart for Astro V4+
*This project is based on another project with the same name... [lloyedjatkinson/astro-snipcart](https://github.com/lloydjatkinson/astro-snipcart) that hasnt been updated to properly support Astro v4s new Type imports. This project is super simple and just gives you support for Snipcart within astro using very simple components...
The Following are the available imports availble to you for building your page... i have layed them out in a typical layout of how to import them into your Astro project for use.
```
import * as SC from '@adammatthiesen/astro-snipcart';
// Available usage; , , , , ,
import * as SCVue from '@adammatthiesen/astro-snipcart/vue';
// Available usage; , ,
```
The Following are the Standard Astro Components Available to import:
- ```SC.Cart``` creates a button for opening the cart
- ```SC.CartItemCount``` Shows the ammount of items as ( 2 )
- ```SC.CartTotal``` Shows the current cart total ( $2.00 )
- ```SC.Login``` Shows the Sign-in/Customer Dashboard if you've enabled the feature within snipcart
- ```SC.MakeProduct``` is the script used for product creation
- ```SC.HeaderAstro``` Put this in your `` tag to activate snipcart on your website (**DOSE NOT WORK WITH VIEW TRANSITIONS**)
The Following are the Vue Astro Components, They are inteded to fix the ViewTransition bug with Snipcart's Interactive components(**REQUIRES `@astrojs/vue`** Replaces `SC.*` with `SCVue.*` if you use ``):
- ```SCVue.HeaderVue```
- ```SCVue.CartItemCount```
- ```SCVue.CartTotal```
## Install Astro Snipcart
```
npm i @adammatthiesen/astro-snipcart
```
Make sure to add ```PUBLIC_SNIPCART_API_KEY``` to your environment variables
Add one of the following inside your ``:
Astro **Without ViewTransitions**
```html
---
import { HeaderAstro } from '@adammatthiesen/astro-snipcart';
---
/** Other Head Data */
```
Astro **WITH ViewTransitions** *(Requires `@astrojs/vue`)*
```html
import { HeaderVUE } from '@adammatthiesen/astro-snipcart/vue';
---
/** Other Head Data */
```
For a Full tutorial of this addon, check out the [blog post here](https://matthiesen.xyz/blog/getting-started-with-my-astro-snipcart-addon)