@liquidcommerce/elements-sdk 2.7.0 → 2.7.2

package/docs/gitbook/address.md

@@ -0,0 +1,48 @@
+# Address
+
+The Address component sets the delivery location used for availability, pricing, and fulfillment options.
+
+## How it works
+- Address is embedded in the Product component by default
+- If a user adds to cart without an address, the SDK prompts automatically
+- The address is reused across product, cart, and checkout
+
+## Standalone address component
+```js
+const client = await Elements('YOUR_API_KEY', { env: 'production' });
+await client.injectAddressElement('address', {
+  onAddressSet: (address) => {
+    console.log('Address set:', address);
+  }
+});
+```
+
+## Address actions
+```js
+await window.elements.actions.address.setAddressByPlacesId('ChIJOwg_06VPwokRYv534QaPC8g');
+
+await window.elements.actions.address.setAddressManually(
+  {
+    one: '123 Main Street',
+    two: 'Apt 4',
+    city: 'New York',
+    state: 'NY',
+    zip: '10001'
+  },
+  { latitude: 40.7128, longitude: -74.0060 }
+);
+
+const address = window.elements.actions.address.getDetails();
+await window.elements.actions.address.clear();
+```
+
+## Address events (examples)
+```js
+window.addEventListener('lce:actions.address_updated', (event) => {
+  const { formattedAddress } = event.detail.data;
+});
+
+window.addEventListener('lce:actions.address_failed', (event) => {
+  const { error } = event.detail.data;
+});
+```

package/docs/gitbook/cart.md

@@ -0,0 +1,65 @@
+# Cart
+
+The Cart component is a slide-out drawer that manages items, quantities, promo codes, and checkout.
+
+## What you get
+- Drawer UI with item list and totals
+- Grouped items by retailer
+- Quantity updates and removals
+- Promo code support
+- Cart persistence across sessions and tabs
+- Checkout entry point
+
+## Show a cart button (CDN)
+```html
+<script
+  defer
+  data-liquid-commerce-elements
+  data-token="YOUR_API_KEY"
+  data-env="production"
+  data-cart-badge-button="header-cart"
+  type="text/javascript"
+  src="https://assets-elements.liquidcommerce.us/all/elements.js"
+></script>
+
+<div id="header-cart"></div>
+```
+
+## Cart UI helpers (programmatic)
+```js
+window.elements.ui.cartButton('header-cart', true);
+window.elements.ui.floatingCartButton(true);
+window.elements.ui.cartSubtotal('cart-total');
+window.elements.ui.cartItemsCount('items-count', { hideZero: true });
+```
+
+## Cart actions
+```js
+window.elements.actions.cart.openCart();
+window.elements.actions.cart.closeCart();
+window.elements.actions.cart.toggleCart();
+
+await window.elements.actions.cart.addProduct([
+  { identifier: '00619947000020', fulfillmentType: 'shipping', quantity: 1 }
+], true);
+
+await window.elements.actions.cart.applyPromoCode('SUMMER20');
+await window.elements.actions.cart.removePromoCode();
+await window.elements.actions.cart.resetCart();
+
+const cart = window.elements.actions.cart.getDetails();
+```
+
+## Address behavior
+If no address is set, add-to-cart automatically opens the address prompt, then retries the add.
+
+## Cart events (examples)
+```js
+window.addEventListener('lce:actions.cart_item_added', (event) => {
+  const { identifiers, itemsAdded } = event.detail.data;
+});
+
+window.addEventListener('lce:actions.cart_updated', (event) => {
+  const { subtotal, itemsCount } = event.detail.data;
+});
+```

package/docs/gitbook/checkout.md

@@ -0,0 +1,131 @@
+# Checkout
+
+The Checkout component provides a complete purchase flow with customer info, payment (Stripe), and confirmation.
+
+## What you get
+- Customer, billing, and shipping info
+- Gift and marketing preferences
+- Promo codes and gift cards
+- Order summary and totals
+- Hosted checkout or drawer checkout
+
+## Default: drawer checkout
+Checkout opens automatically from the cart drawer. No setup required.
+
+## Hosted checkout (inject)
+```js
+const client = await Elements('YOUR_API_KEY', { env: 'production' });
+await client.injectCheckoutElement({
+  containerId: 'checkout',
+  checkoutId: 'optional_checkout_id',
+  hideHeader: false
+});
+```
+
+## Hosted checkout (URL param)
+Hosted checkout uses two things together:
+1) `data-checkout-url` on the main script (so the cart can redirect to your hosted checkout page).
+2) `data-checkout-param` on the hosted page (so it can read the checkout ID from the URL).
+
+Hosted page example:
+```html
+<script
+  defer
+  data-liquid-commerce-elements
+  data-token="YOUR_API_KEY"
+  data-env="production"
+  data-checkout-param="lce_checkout"
+  type="text/javascript"
+  src="https://assets-elements.liquidcommerce.us/all/elements.js"
+></script>
+
+<div data-lce-checkout></div>
+```
+
+Main script example (cart redirects here):
+```html
+<script
+  defer
+  data-liquid-commerce-elements
+  data-token="YOUR_API_KEY"
+  data-env="production"
+  data-checkout-url="https://yoursite.com/checkout?lce_checkout={token}"
+  data-checkout-param="lce_checkout"
+  type="text/javascript"
+  src="https://assets-elements.liquidcommerce.us/all/elements.js"
+></script>
+```
+## Hosted checkout UI controls
+Use these attributes on the hosted checkout page to customize the UI:
+
+- `hide-header` on the checkout container  
+  Hides the SDK header so you can render your own.
+
+```html
+<div data-lce-checkout hide-header></div>
+```
+
+- `data-lce-exit-checkout` on any element  
+  Lets you build your own “Exit checkout” button or link.
+
+```html
+<button data-lce-exit-checkout>Exit checkout</button>
+```
+
+## Checkout-only build
+If a page only needs hosted checkout, use the checkout-only script. It supports the same hosted-checkout attributes but ships ~50% less JavaScript for faster load time.
+
+```html
+<script
+  defer
+  data-liquid-commerce-elements
+  data-token="YOUR_API_KEY"
+  data-env="production"
+  type="text/javascript"
+  src="https://assets-elements.liquidcommerce.us/checkout/elements.js"
+></script>
+```
+
+## Checkout actions
+```js
+window.elements.actions.checkout.openCheckout();
+window.elements.actions.checkout.closeCheckout();
+window.elements.actions.checkout.toggleCheckout();
+window.elements.actions.checkout.exitCheckout();
+
+await window.elements.actions.checkout.addProduct([
+  { identifier: '00619947000020', fulfillmentType: 'shipping', quantity: 1 }
+], true);
+
+await window.elements.actions.checkout.applyPromoCode('WELCOME10');
+await window.elements.actions.checkout.removePromoCode();
+
+await window.elements.actions.checkout.applyGiftCard('GIFT-1234-5678');
+await window.elements.actions.checkout.removeGiftCard('GIFT-1234-5678');
+
+await window.elements.actions.checkout.toggleIsGift(true);
+await window.elements.actions.checkout.toggleBillingSameAsShipping(false);
+await window.elements.actions.checkout.toggleMarketingPreferences('canEmail', true);
+
+window.elements.actions.checkout.updateCustomerInfo({
+  firstName: 'John',
+  lastName: 'Doe',
+  email: 'john@example.com'
+});
+
+window.elements.actions.checkout.updateBillingInfo({
+  firstName: 'John',
+  lastName: 'Doe',
+  addressOne: '789 Elm St',
+  city: 'Chicago',
+  state: 'IL',
+  zipCode: '60601'
+});
+```
+
+## Checkout events (examples)
+```js
+window.addEventListener('lce:actions.checkout_submit_completed', (event) => {
+  const { orderId, total } = event.detail.data;
+});
+```