Default theme reference
This entry contains documentation for all of our default theme's components.
Quick Links
- address-fields
- authentication-view
- billing
- billing-completed
- card-icon
- cart
- cart-button
- cart-header
- cart-summary
- cart-summary-expanded-item
- cart-summary-fees
- cart-summary-item
- cart-summary-items-list
- change-password-form
- checkout
- checkout-step
- close-cart-action
- close-side-cart-action
- customer-account-link
- customer-details
- dashboard
- dashboard-home
- decrement-quantity-action
- disabled-checkout-step
- discount-box
- edit-customer-address-form
- edit-shipping-address-button
- empty-cart
- fancy-select
- featured-payment-methods
- flash-message
- forgot-password-form
- guest-checkout
- icon
- increment-quantity-action
- item-custom-fields
- item-description
- item-image
- item-line
- item-list
- item-quantity
- layout
- loading-overlay
- loading-screen
- media
- open-side-cart-action
- order
- order-payment-details
- orders-list
- payment
- payment-completed
- payment-form
- payment-info
- payment-methods-list
- payment-methods-list-item
- rectify-cart-action
- register-form
- remove-item-action
- reset-password-form
- shipping
- shipping-address
- shipping-completed
- shipping-method
- shipping-rates-list
- shipping-rates-list-item
- show-cart-action
- sign-in-action
- sign-out-action
- signin-form
- snipcart-address-autocomplete
- snipcart-checkbox
- snipcart-error-message
- snipcart-form
- snipcart-hidden-autofill
- snipcart-input
- snipcart-label
- snipcart-password
- snipcart-radio
- snipcart-select
- snipcart-submit
- snipcart-textarea
- snipcart-typeahead
- subscription
- subscriptions-list
- tab
- tabs
- textbox
- tool-tip
address-fields
Displays a form to edit an address.
Usage of address-fields
<address-fields type="<>" initialAddress="<Address>"> </address-fields>
type:
initialAddress: Address
Default Template
authentication-view
Usage of authentication-view
<authentication-view> </authentication-view>
Default Template
billing
Component that gathers billing address and customer information
Usage of billing
<billing> </billing>
Default Template
billing-completed
Usage of billing-completed
<billing-completed context="<string>"> </billing-completed>
context: string – Context in which this component is rendered
Default Template
card-icon
Usage of card-icon
<card-icon> </card-icon>
cart
Usage of cart
<cart isSideCart="<boolean>" editingCart="<boolean>"> </cart>
isSideCart: boolean
editingCart: boolean – Indicates if the cart is currently opened as a side-panel over the checkout screen.
Default Template
cart-button
Component that renders a button
Usage of cart-button
<cart-button type="<string>"> </cart-button>
type: string – Button type
cart-header
Component that shows the number of items in the cart and a way to close the cart.
Usage of cart-header
<cart-header title="<string>" showItemsCount="<boolean>" showAccountMenu="<boolean>" showSummary="<boolean>" showAccountLink="<boolean>" backButtonTitle="<string>"> </cart-header>
title: string
showItemsCount: boolean
showAccountMenu: boolean
showSummary: boolean
showAccountLink: boolean
backButtonTitle: string
Default Template
cart-summary
Usage of cart-summary
<cart-summary isSideCart="<boolean>"> </cart-summary>
isSideCart: boolean
Default Template
cart-summary-expanded-item
Usage of cart-summary-expanded-item
<cart-summary-expanded-item item="<CartItem>"> </cart-summary-expanded-item>
item: CartItem
Default Template
cart-summary-fees
Components that shows the cart fees such as taxes, shipping, grand total, etc.
Usage of cart-summary-fees
<cart-summary-fees> </cart-summary-fees>
Default Template
cart-summary-item
Component that renders an item from `CartSummaryItemsList` component.
Usage of cart-summary-item
<cart-summary-item item="<CartItem>"> </cart-summary-item>
item: CartItem – The item associated to the component instance.
Default Template
cart-summary-items-list
This component renders the list of items in the cart for the summary visible during checkout process.
Usage of cart-summary-items-list
<cart-summary-items-list tag="<string>" itemTemplate="<string>"> </cart-summary-items-list>
change-password-form
Usage of change-password-form
<change-password-form> </change-password-form>
Default Template
checkout
Usage of checkout
<checkout> </checkout>
Default Template
checkout-step
Usage of checkout-step
<checkout-step number="<string>" name="<string>" title="<string>"> </checkout-step>
close-cart-action
Usage of close-cart-action
<close-cart-action> </close-cart-action>
close-side-cart-action
Usage of close-side-cart-action
<close-side-cart-action> </close-side-cart-action>
customer-account-link
Usage of customer-account-link
<customer-account-link> </customer-account-link>
customer-details
Usage of customer-details
<customer-details> </customer-details>
Default Template
dashboard
Usage of dashboard
<dashboard> </dashboard>
Default Template
dashboard-home
Usage of dashboard-home
<dashboard-home> </dashboard-home>
Default Template
decrement-quantity-action
Usage of decrement-quantity-action
<decrement-quantity-action> </decrement-quantity-action>
disabled-checkout-step
Usage of disabled-checkout-step
<disabled-checkout-step errors="<>"> </disabled-checkout-step>
errors:
discount-box
Usage of discount-box
<discount-box> </discount-box>
edit-customer-address-form
Usage of edit-customer-address-form
<edit-customer-address-form addressType="<>"> </edit-customer-address-form>
addressType:
Default Template
edit-shipping-address-button
Usage of edit-shipping-address-button
<edit-shipping-address-button> </edit-shipping-address-button>
empty-cart
Usage of empty-cart
<empty-cart> </empty-cart>
Default Template
fancy-select
Usage of fancy-select
<fancy-select searchProvider="<>" options="<>" name="<string>" value="<>" styleAutofilled="<{}>" persistSearchResults="<boolean>" label="<string>" isValid="<boolean>"> </fancy-select>
featured-payment-methods
Component that shows the list of accepted payment methods. You must override this component if you want to change this list.
Usage of featured-payment-methods
<featured-payment-methods> </featured-payment-methods>
Default Template
flash-message
Component that displays error messages
Usage of flash-message
<flash-message title="<string>" type="<string>" description="<string>" icon="<string>"> </flash-message>
title: string – Title of the error
type: string – One of 'success', 'error', 'info'
description: string – Description of the error
icon: string – Icon of the error
Default Template
forgot-password-form
Usage of forgot-password-form
<forgot-password-form> </forgot-password-form>
Default Template
guest-checkout
Usage of guest-checkout
<guest-checkout> </guest-checkout>
Default Template
icon
Display one of the built-in icons
Usage of icon
<icon name="<string>" custom="<boolean>" tooltip="<string>" width="<number>" height="<number>" alt="<string>"> </icon>
name: string – Name of the icon to show
Can be one of:
back-arrow
,box
,cart
,checkmark
,chevron-down
,chevron-up
,continue-arrow
,green-check
,location
,lock
,mastercard
,minus
,password
,pin
,plus
,trash
,user
,visa
,spinner
,spinner-white
,question-mark
,front
,console
,sign-out
,discount
,card-amex
,card-dinersclub
,card-discover
,card-elo
,card-hipercard
,card-jcb
,card-maestro
,card-mastercard
,card-mir
,card-unionpay
,card-unknown
,card-visa
,card-alipay
,card-verve
,card-paypal
,card-dankort
,card-uatp
,method-apple_pay
,method-bancontact
,method-belfius
,method-card
,method-eps
,method-giropay
,method-ideal
,method-ing_home_pay
,method-kbc
,method-klarna_pay_later
,method-klarna_slice_it
,method-p24
,method-paypal
,method-bank_transfer
,method-sofort
,method-paypal_express_checkout
,method-bank_transfer
,back-arrow
,box
,cart
,checkmark
,chevron-down
,chevron-up
,continue-arrow
,green-check
,location
,lock
,mastercard
,minus
,password
,pin
,plus
,trash
,user
,visa
,spinner
,spinner-white
,question-mark
,front
,console
,sign-out
,discount
,card-amex
,card-dinersclub
,card-discover
,card-elo
,card-hipercard
,card-jcb
,card-maestro
,card-mastercard
,card-mir
,card-unionpay
,card-unknown
,card-visa
,card-alipay
,card-verve
,card-paypal
,card-dankort
,card-uatp
,method-apple_pay
,method-bancontact
,method-belfius
,method-card
,method-eps
,method-giropay
,method-ideal
,method-ing_home_pay
,method-kbc
,method-klarna_pay_later
,method-klarna_slice_it
,method-p24
,method-paypal
,method-bank_transfer
,method-sofort
,method-paypal_express_checkout
ormethod-bank_transfer
custom: boolean
tooltip: string – the title
width: number – Width of the icon in number of pixels
height: number – Height of the icon in number of pixels
alt: string – Alt text to use for accessibility
increment-quantity-action
Usage of increment-quantity-action
<increment-quantity-action> </increment-quantity-action>
item-custom-fields
Usage of item-custom-fields
<item-custom-fields> </item-custom-fields>
item-description
Usage of item-description
<item-description> </item-description>
item-image
Usage of item-image
<item-image alt="<string>"> </item-image>
alt: string
item-line
Component that shows the details of an item in the cart. Child of `item-list`.
Usage of item-line
<item-line tag="<string>" item="<CartItem>" showDescription="<boolean>"> </item-line>
Default Template
item-list
Component that shows the cart items list.
Usage of item-list
<item-list tag="<string>" itemTemplate="<string>" showDescription="<boolean>"> </item-list>
item-quantity
Usage of item-quantity
<item-quantity disabled="<boolean>"> </item-quantity>
disabled: boolean
layout
Usage of layout
<layout headerTitle="<string>" contentCssClass="<any>" headerCssClass="<any>"> </layout>
headerTitle: string
contentCssClass: any
headerCssClass: any
loading-overlay
An overlay to show on top of content that is being loaded / updated.
Usage of loading-overlay
<loading-overlay icon="<string>" message="<string>" showIcon="<boolean>" opaque="<boolean>"> </loading-overlay>
loading-screen
Component that renders a loading screen while an async operation is in progress.
Usage of loading-screen
<loading-screen message="<string>" tag="<string>"> </loading-screen>
Default Template
media
Usage of media
<media> </media>
open-side-cart-action
Usage of open-side-cart-action
<open-side-cart-action> </open-side-cart-action>
order
Usage of order
<order order="<CustomerOrderResponse>"> </order>
order: CustomerOrderResponse
Default Template
order-payment-details
Usage of order-payment-details
<order-payment-details> </order-payment-details>
Default Template
orders-list
Usage of orders-list
<orders-list> </orders-list>
Default Template
payment
Usage of payment
<payment> </payment>
Default Template
payment-completed
Component that renders when the payment is completed.
Usage of payment-completed
<payment-completed> </payment-completed>
payment-form
Component that renders a credit card form.
Usage of payment-form
<payment-form disabled="<boolean>" paymentMethod="<PaymentMethodIds>" paymentCurrentlyProccessing="<boolean>"> </payment-form>
disabled: boolean
paymentMethod: PaymentMethodIds
paymentCurrentlyProccessing: boolean
payment-info
Usage of payment-info
<payment-info customerDetails="<>"> </payment-info>
customerDetails:
Default Template
payment-methods-list
Component that shows the list of available payment methods on the current payment session
Usage of payment-methods-list
<payment-methods-list disabled="<boolean>"> </payment-methods-list>
disabled: boolean
Default Template
payment-methods-list-item
Component that shows a clickable payment method selection element
Usage of payment-methods-list-item
<payment-methods-list-item paymentMethod="<PaymentMethod>"> </payment-methods-list-item>
paymentMethod: PaymentMethod
Default Template
rectify-cart-action
Usage of rectify-cart-action
<rectify-cart-action> </rectify-cart-action>
register-form
Usage of register-form
<register-form> </register-form>
Default Template
remove-item-action
Usage of remove-item-action
<remove-item-action> </remove-item-action>
reset-password-form
Usage of reset-password-form
<reset-password-form> </reset-password-form>
Default Template
shipping
Component that renders the shipping box, it shows the shipping address form or shipping method picker depending on its state.
Usage of shipping
<shipping> </shipping>
shipping-address
Component that allows a customer to change / define its shipping address.
Usage of shipping-address
<shipping-address> </shipping-address>
Default Template
shipping-completed
Usage of shipping-completed
<shipping-completed context="<string>"> </shipping-completed>
context: string – Context in which this component is rendered
Default Template
shipping-method
This component renders the shipping method picker.
Usage of shipping-method
<shipping-method> </shipping-method>
Default Template
shipping-rates-list
Component that renders the list of available shipping methods.
Usage of shipping-rates-list
<shipping-rates-list tag="<string>"> </shipping-rates-list>
tag: string – Sets the root element tag, default is `ul`.
shipping-rates-list-item
Usage of shipping-rates-list-item
<shipping-rates-list-item rate="<ShippingRate>"> </shipping-rates-list-item>
rate: ShippingRate – The shipping rate associated to the component instance.
Default Template
show-cart-action
Usage of show-cart-action
<show-cart-action> </show-cart-action>
sign-in-action
Usage of sign-in-action
<sign-in-action> </sign-in-action>
sign-out-action
Usage of sign-out-action
<sign-out-action> </sign-out-action>
signin-form
Usage of signin-form
<signin-form> </signin-form>
Default Template
snipcart-address-autocomplete
Dropdown with autocomplete for addresses.
Usage of snipcart-address-autocomplete
<snipcart-address-autocomplete name="<string>" label="<string>"> </snipcart-address-autocomplete>
snipcart-checkbox
Checkbox form element.
Usage of snipcart-checkbox
<snipcart-checkbox name="<string>" id="<string>"> </snipcart-checkbox>
snipcart-error-message
Displays the error message associated with the form field.
Usage of snipcart-error-message
<snipcart-error-message name="<string>" small="<boolean>" fallbackMessage="<string>" showFieldsErrors="<boolean>" icon="<string>"> </snipcart-error-message>
Default Template
snipcart-form
Wrap form fields inside a form element and provide support for doing HTML5 validation even when we don't "submit" the form using a submit button.
Usage of snipcart-form
<snipcart-form> </snipcart-form>
snipcart-hidden-autofill
Usage of snipcart-hidden-autofill
<snipcart-hidden-autofill> </snipcart-hidden-autofill>
snipcart-input
Standard input (textbox) form element.
Usage of snipcart-input
<snipcart-input type="<string>" name="<string>" placeholder="<string>" icon="<string>"> </snipcart-input>
snipcart-label
Label for a form field.
Usage of snipcart-label
<snipcart-label for="<string>" forTargetId="<string>"> </snipcart-label>
snipcart-password
Usage of snipcart-password
<snipcart-password name="<string>" placeholder="<string>" icon="<string>"> </snipcart-password>
snipcart-radio
Radio button form element.
Usage of snipcart-radio
<snipcart-radio name="<string>" value="<string>" id="<string>"> </snipcart-radio>
snipcart-select
Usage of snipcart-select
<snipcart-select name="<string>"> </snipcart-select>
name: string
snipcart-submit
Usage of snipcart-submit
<snipcart-submit> </snipcart-submit>
snipcart-textarea
Usage of snipcart-textarea
<snipcart-textarea name="<string>"> </snipcart-textarea>
name: string
snipcart-typeahead
Typeahead (autocomplete) form element.
Usage of snipcart-typeahead
<snipcart-typeahead type="<string>" name="<string>" autocomplete="<string>"> </snipcart-typeahead>
subscription
Usage of subscription
<subscription subscription="<CustomerSubscriptionsResponse>"> </subscription>
subscription: CustomerSubscriptionsResponse
Default Template
subscriptions-list
Usage of subscriptions-list
<subscriptions-list> </subscriptions-list>
Default Template
tabs
Usage of tabs
<tabs> </tabs>
textbox
Usage of textbox
<textbox value="<string>" id="<string>" icon="<string>" inputCssClasses="<any>"> </textbox>
tool-tip
Usage of tool-tip
<tool-tip> </tool-tip>