ui.shipaid.com 0.2.7 → 0.2.10

package/README.md

@@ -1,80 +1,90 @@
-# ShipAid Shopify Widget
-
-This is the repository for the ShipAid Shopify (and possibly others in future) widget. It uses the [Lit](https://lit.dev/) web components library, so it is recommended to become familiar with it before contributing to this repository.
-
-Using Lit provides a framework that allows us to build a reactive UI, using JSX-like syntax - no need to use JQuery etc. And it can easily be installed in a page by using the custom web component name:
-```html
-<shipaid-widget>Fallback Content</shipaid-widget>
-```
-
-## Overview
-
-This widget provides an interface where a user can choose to add or remove ShipAid protection - this is actually a product in their store that can be added to cart. When the component is loaded, we immediately run a request to fetch the ShipAid protection product details from our API, as well as the customers current cart from the [Shopify AJAX API](https://shopify.dev/api/ajax/reference/cart).
-Once we have this data, we can check whether the customer currently has the ShipAid product in their cart, and show either the add or remove product buttons based on this.
-
-We also emit various [custom events](https://developer.mozilla.org/en-US/docs/Web/Events/Creating_and_triggering_events#adding_custom_data_%E2%80%93_customevent) when we add or remove the ShipAid product from the cart, so other developers can listen to these events, and update AJAX carts.
-
-### Events
-
-This is a list of the events emitted by the widget:
-
-| Event | Description | Payload |
-|-------|-------------|---------|
-| `shipaid-loaded` | Dispatched when the widget has finished fetching data from the API, and has successfully rendered. | Contains the data from the ShipAid API: [`ShipAidStore`](/types/shipaid.ts) |
-| `shipaid-protection-status` | Dispatched when a user either adds or removes the protection product from their cart. | `{ protection: boolean, cart: ShopifyCart, lineItem: ShopifyCartItem }` |
-
-### Methods
-
-This is a list of public methods that can be used to change protection settings:
-
-| Method | Description | Payload |
-|--------|-------------|---------|
-| `hasProtection` | Returns a boolean which indicates whether the protection item is currently in the cart. | |
-| `updateCart` | Updates the internal cart, and triggers any protection product updates - use this method with with ajax carts, to update protection state without needing to reload the page. | Optional - the cart object from the ajax API. |
-| `addProtection` | Adds the relevant protection item to cart. | |
-| `removeProtection` | Removes the protection item from the cart. | |
-
-## Contributing
-
-### Requirements
-
-- Node v16+
-- PNPM
-- Development Shopify store (with the ShipAid app installed)
-- ShipAid API development/staging instance
-
-### Development
-
-You will need to make sure your development store has the ShipAid app installed, so the store and its protection product is added to the DB. You will also need to ensure the Shopify app you are testing this with has an app proxy added, and pointed towards an API instance.
-
-```sh
-pnpm install
-pnpm run develop
-```
-
-Once the project is running, add the below to your development Shopify store `theme.liquid`:
-
-```html
-<!-- Dev -->
-<script src="http://localhost:3000/src/shipaid-widget.ts"type="module" ></script>
-<!-- Prod -->
-<script src="https://unpkg.com/ui.shipaid.com?module" type="module"></script>
-```
-And add the widget element in your cart (likely `/sections/main-cart-items.liquid`):
-
-```html
-<shipaid-widget>
-  <p>Loading ShipAid Protection</p>
-</shipaid-widget>
-```
-
-### Build
-
-Once the project has been built, you can publish the project to NPM, and users can add the script to their store using a package CDN (I.e. [Unpkg](https://unpkg.com/)).
-
-```sh
-pnpm install
-pnpm run lint
-pnpm run build
-pnpm publish
-```
+# ShipAid Shopify Widget
+
+This is the repository for the ShipAid Shopify (and possibly others in future) widget. It uses the [Lit](https://lit.dev/) web components library, so it is recommended to become familiar with it before contributing to this repository.
+
+Using Lit provides a framework that allows us to build a reactive UI, using JSX-like syntax - no need to use JQuery etc. And it can easily be installed in a page by using the custom web component name:
+```html
+<shipaid-widget>Fallback Content</shipaid-widget>
+```
+
+## Overview
+
+This widget provides an interface where a user can choose to add or remove ShipAid protection - this is actually a product in their store that can be added to cart. When the component is loaded, we immediately run a request to fetch the ShipAid protection product details from our API, as well as the customers current cart from the [Shopify AJAX API](https://shopify.dev/api/ajax/reference/cart).
+Once we have this data, we can check whether the customer currently has the ShipAid product in their cart, and show either the add or remove product buttons based on this.
+
+We also emit various [custom events](https://developer.mozilla.org/en-US/docs/Web/Events/Creating_and_triggering_events#adding_custom_data_%E2%80%93_customevent) when we add or remove the ShipAid product from the cart, so other developers can listen to these events, and update AJAX carts.
+
+### Events
+
+This is a list of the events emitted by the widget:
+
+| Event | Description | Payload |
+|-------|-------------|---------|
+| `shipaid-loaded` | Dispatched when the widget has finished fetching data from the API, and has successfully rendered. | Contains the data from the ShipAid API: [`ShipAidStore`](/types/shipaid.ts) |
+| `shipaid-protection-status` | Dispatched when a user either adds or removes the protection product from their cart. | `{ protection: boolean, cart: ShopifyCart, lineItem: ShopifyCartItem }` |
+
+### Methods
+
+This is a list of public methods that can be used to change protection settings:
+
+| Method | Description | Payload |
+|--------|-------------|---------|
+| `hasProtection` | Returns a boolean which indicates whether the protection item is currently in the cart. | |
+| `updateCart` | Updates the internal cart, and triggers any protection product updates - use this method with with ajax carts, to update protection state without needing to reload the page. | Optional - the cart object from the ajax API. |
+| `addProtection` | Adds the relevant protection item to cart. | |
+| `removeProtection` | Removes the protection item from the cart. | |
+
+### Props
+
+This is a list of props that can be used to configure the widget:
+
+| Prop | Description | Value/Type |
+|--------|-------------|---------|
+| `disablePolling` | Sets whether the cart should disable polling (enabled by default) - should be disabled if integrating manually with an ajax cart. | `boolean` |
+| `pollingInterval` | If polling is enabled, it sets the interval (in ms) between API updates. | `number` in milliseconds |
+| `disableRefresh ` | Sets whether the store cart should be updated when the protection item is added/removed. Set to `true` if you want to initially hide the protection product from the cart, even if it has just been added. | `boolean` |
+
+## Contributing
+
+### Requirements
+
+- Node v16+
+- PNPM
+- Development Shopify store (with the ShipAid app installed)
+- ShipAid API development/staging instance
+
+### Development
+
+You will need to make sure your development store has the ShipAid app installed, so the store and its protection product is added to the DB. You will also need to ensure the Shopify app you are testing this with has an app proxy added, and pointed towards an API instance.
+
+```sh
+pnpm install
+pnpm run develop
+```
+
+Once the project is running, add the below to your development Shopify store `theme.liquid`:
+
+```html
+<!-- Dev -->
+<script src="http://localhost:3000/src/shipaid-widget.ts"type="module" ></script>
+<!-- Prod -->
+<script src="https://unpkg.com/ui.shipaid.com/dist/widget.es.js" type="module"></script>
+```
+And add the widget element in your cart (likely `/sections/main-cart-items.liquid`):
+
+```html
+<shipaid-widget>
+  <p>Loading ShipAid Protection</p>
+</shipaid-widget>
+```
+
+### Build
+
+Once the project has been built, you can publish the project to NPM, and users can add the script to their store using a package CDN (I.e. [Unpkg](https://unpkg.com/)).
+
+```sh
+pnpm install
+pnpm run lint
+pnpm run build
+pnpm publish
+```