Components

TipserElementsProvider

The entry point to Tipser Elements (providing a context for other elements living inside it). Every other element documented here needs to be located below TipserElementsProvider in the React elements hierarchy.

ProductTile

Displays a tile for the product specified by the productId prop. When the user clicks anywhere on the product tile (not necessarily on the button), the product details are presented.

Example:

<ProductTile productId="5c751cf82d3f3b0001bcec8c" />

Properties:

Product Detail Page

A larger, more detailed and better exposed product view, typically occupying the full width of the article. Allows the user to add the product to cart without opening the product dialog (which means less steps needed by the user to purchase the product). For products with variants, a variant selector is displayed, letting the user pick the variant before adding to cart.

Example:

<ProductListing productId="5c751cf82d3f3b0001bcec8c" />

Properties:

Collection

Renders a collection of product tiles based on collectionId prop.

For large collections you may want to display them as carousels, by adding a carousel prop. You can also use imgSize prop to control the size of displayed product tiles.

example:

<Collection
  collectionId={"5b2788909d25801adcb23f4f"}
  carousel
  imgSize={"small"}
/>

Properties:

CartIcon

A cart icon element that displays the number of items in your cart and brings the user to the checkout when clicked (either by opening the checkout dialog or by redirecting to the checkout embedded page).

Store

A component displaying of all your store collections with the store menu and the active collection. We recommend using it on a dedicated subpage on your site.

import { Store } from '@tipser/tipser-elements';
 
<Store />

Store menu display

You can choose between two ways of displaying the store menu on the mobile screens. The default one is a native dropdown. If you prefer to use the inline menu instead (the same one as is displayed on other screen sizes), set the inlineMobileMenu prop to true.

Updating the browser's URL

By default, the Store component saves the active collection in the browser's URL hash part (everything after the # symbol in the URL). It allows the users to bookmark the store page or share the URL with others (the same collection will be active in the store when opening the link). To opt-out of this behaviour (e.g. because it interferes with the routing system of your site), set the disableDeepLinking prop to true.

❗️

When the active store category is changed, the Store component is updating the top-level page URL (unless disableDeepLinking prop is set to true). For this reason, please make sure that it doesn't interfere with the routing system of your your web framework. For the same reason, it's not recommended to include more than one Store on a single page.

Supported props

ProductPage

A full-sized product component to be used on a dedicated page.

<ProductPage productId="5c751cf82d3f3b0001bcec8c">

Example:

📘

This component renders the same product view that is displayed inside the product modal.

Properties:

CheckoutPage

Our standard checkout component with all necessary elements (product list, user address form, payment widget, etc) to make the purchase possible.

import { CheckoutPage } from '@tipser/tipser-elements';
// ...
<CheckoutPage />

The visual appearance of our standard checkout varies by locale—we've researched how to optimise checkout for your shoppers and have proven data that informs these user interface differences.

Properties:

If you need more flexibility, use the ModularCheckout component instead.

CartPage

A default implementation of the "review your cart" page.

import { CartPage } from '@tipser/tipser-elements';

<CartPage />

Example:

The typical use case for the CartPage component is to use it on an embedded cart page which is a step that precedes the checkout page in the user checkout funnel. This component provides a reasonable default implementation for this step (the same implementation is used in the default cart view that is displayed in a dialog for publishers who don't use the embedded pages). If this implementation is too limiting, you can use the ModularCart component instead.

ProductList

A list of products, looking the same as Collection component, but instead of the collectionId, you need to pass the array of productIds. and optional carousel and imgSize attributes.

example:

<ProductList
  productIds={[
    "5911c26c8aa0ce3d70cd607b",
    "5c878cc5a6e96d00012e1771",
    "5c878cc5a6e96d00012e1775",
  ]}
/>

ModularProduct

ModularProduct component allows you to mix and match the elements that are included in your product view.
In other words, you can build you own version of product view from the existing components like from Lego pieces. And you can even mix in your own components in between.

To be used if more flexibility is needed than what is provided by ProductTile, ProductListing and ProductPage components.

A minimal working example:

<ModularProduct>
    <ProductTitle />
    <ProductPrice />
    <ProductImage />
    <ProductVariantSelector />
    <ProductBuyButton />
</ModularProduct>

And a more sophisticated one:

<ModularProduct productId="5c751cf82d3f3b0001bcec8c">
  <div className="top-container">
    <div className="left-column">
      <ProductThumbnails direction="vertical" />
      <ProductImage />
    </div>
    <div className="right-column">
      <ProductTitle />
      <ProductPrice />
      <ProductColorRelations />
      <ProductVariantSelector />
      <ProductAvailabilityInfo />
      <ProductBuyButton />
    </div>
  </div>
  <div className="bottom-container">
    <ProductDescription />
    <ProductSimilarProducts />
    <ProductStyleWithProducts />
  </div>
</ModularProduct>

Properties:

📘

All the product modules must be located under ModularProduct in the elements hierarchy.

ProductContainer

The default implementation of the main part of the product view, consisting of ProductImage, ProductTitle, ProductColorRelations, ProductVariantSelector, ProductAvailabilityInfo and ProductBuyButton.
It may come handy if you don't want to mess with the main part of the product view and just need to customize the remaining sections.

<ModularProduct productId="5c751cf82d3f3b0001bcec8c">
  <ProductContainer />
  <ProductStyleWithProducts />
  <ProductDescription />
  <ProductSimilarProducts />
</ModularProduct>

ProductTitle

Displays the name and the brand of the product.

<ModularProduct productId="5c751cf82d3f3b0001bcec8c">
  <ProductTitle />
</ModularProduct>

ProductPrice

Displays the price, discount price and unit price ( eg. 2$/100ml, if applicable ) for the product.

<ModularProduct productId="5c751cf82d3f3b0001bcec8c">
  <ProductPrice />
</ModularProduct>

ProductImage

Displays the full-size version of the active product image. With some configuration options it can be also used to change the active product image.

📘

ProductImage component must be placed in a container with fixed width and height and it will grow to fill that container.

<ModularProduct productId="5c751cf82d3f3b0001bcec8c">
  <div>
    <ProductImage enableDots enableArrows />
  </div>
</ModularProduct>

ProductThumbnails

Displays the product thumbnails.

📘

ProductThumbnails component must be placed in a container with fixed width and height and it will grow to fill that container.

<ModularProduct productId="5c751cf82d3f3b0001bcec8c">
  <div>
    <ProductThumbnails />
  </div>
</ModularProduct>

📘

In the horizontal mode thumbnails will always expand to 100% of the width and height to its parent container and automatically adjust the number of displaying thumbnails depending on the width, height and ratio of its parent container.

📘

In the vertical mode a single thumbnail will always have a fixed width of 100px, so to change the number of the thumbnails you should change only the height of its parent container.

ProductVariantSelector

A dropdown listing all variants of the product. When a variant is selected from the list, all the displayed product information will be updated accordingly (only available variants are selectable).

<ModularProduct productId="5c751cf82d3f3b0001bcec8c">
  <ProductVariantSelector />
</ModularProduct>

ProductAvailabilityInfo

Displays information related to product availability and delivery, such as:

• product availability
• delivery cost
• delivery time

<ModularProduct productId="5c751cf82d3f3b0001bcec8c">
  <ProductAvailabilityInfo />
</ModularProduct>

ProductDescription

Displays the product text description.

<ModularProduct productId="5c751cf82d3f3b0001bcec8c">
  <ProductDescription />
</ModularProduct>

ProductBuyButton

A button adding the product to the shopping cart.

<ModularProduct productId="5c751cf82d3f3b0001bcec8c">
  <ProductBuyButton />
</ModularProduct>

📘

In case the variant has not been yet selected, clicking the button will expand the variant selector instead.

ProductSimilarProducts

An automatically generated list of similar products (basing on text similarity, image similarity, more from the same brand, etc).

<ModularProduct productId="5c751cf82d3f3b0001bcec8c">
  <ProductSimilarProducts />
</ModularProduct>

ProductColorRelations

Displays the list of color variants of the product and switches the product view to any of them, when clicked.

<ModularProduct productId="5c751cf82d3f3b0001bcec8c">
  <ProductColorRelations />
</ModularProduct>

ProductStyleWithProducts

A hand-picked list of other products that go well together with the current product.

<ModularProduct productId="5c751cf82d3f3b0001bcec8c">
  <ProductStyleWithProducts />
</ModularProduct>

Modular Checkout

The main element providing the checkout context for all of the checkout modules nested under it.

🚧

Modular Checkout is not yet implemented in v4

import {
  ModularCheckout,
  CheckoutCartProducts,
  CheckoutCustomerAddressDelivery,
  CheckoutPayment,
  CheckoutOrderProcessing,
  CheckoutOrderConfirmation,
} from "@tipser/tipser-elements";

//...

<ModularCheckout>
  <ModularCheckout.New>
    <CheckoutCartProducts />
    <CheckoutCustomerAddressDelivery />
    <CheckoutPayment />
  </ModularCheckout.New>

  <ModularCheckout.Processing>
    <CheckoutOrderProcessing />
  </ModularCheckout.Processing>

  <ModularCheckout.Empty>
    <div>Your cart is empty!</div>
  </ModularCheckout.Empty>

  <ModularCheckout.Confirmed>
    <CheckoutOrderConfirmation />
  </ModularCheckout.Confirmed>
</ModularCheckout>

This checkout option is highly customizable.

The following sections are supported modules that can be nested under ModularCheckout:

CheckoutProductList

A list of items in the current checkout.

Properties:

CheckoutCustomerAddressDelivery

A form accepting user’s delivery address

📘

This component is only available for integrations using Stripe as the payment provider. In case of Klarna, CheckoutPayment contains its own fields for entering delivery and billing address.

Properties:

CSS class overrides:

CheckoutCustomerAddressBilling

A form accepting user’s billing address

📘

This component is only available for integrations using Stripe as the payment provider. In case of Klarna, CheckoutPayment contains its own fields for entering delivery and billing address.

Properties:

CSS class overrides:

CheckoutSummary

A summary of the total costs and taxes resulting from the checkout

Properties:

📘

On the US market the taxes will be calculated only after delivery address is filled.

A payment section, accepting user's payment input (e.g. credit card number). In case of Klarna integrations, this component will additionally contain delivery and billing address forms.

Properties:

CheckoutCartPromoCode

A widget for entering promotion codes

Properties:

CheckoutLegal

A text explaining legal terms of the purchase

Properties:

CheckoutOrderProcessing

A loading animation for checkout processing

Properties:

CheckoutOrderConfirmation

A confirmation page displaying a summary of the completed order

Properties:

CheckoutPaymentRequestButton

Displays a contextual "express payment" button, giving the user a chance to pay with favourite payment method (e.g Apple Pay or Google Pay).

This component should be used in addition to our standard <CheckoutPayment /> component as a faster and more convenient alternative to pay for the order.

Example of checkout page with Apple Pay button:

Depending on the user's environment, the component will render as either Apple Pay, Google Pay or "pay via browser" button:

• For Safari users with Apple Wallet configured, Apple Pay button will be displayed
• For Chrome users logged on a user account connected to Google Pay, Google Pay button will be displayed
• For users of supported browsers (notably: Chrome, Safari and Edge) with a credit card saved in the browser settings, a browser-specific pay button will be displayed

🚧

For environments that are not supporting any express payment options, this component will not be rendered. For this reason, this component is not a full replacement to the CheckoutPayment component, just a supplement to it.

📘

This component uses the the Payment Request API to open the dialog window for a given payment method.

Properties:

CheckoutPaymentMethodSelector

Displays a fully-featured payment method selector that presents all the payment methods supported by the user's environment (browser, connected wallets, etc).

ModularCheckout.Empty, ModularCheckout.New, ModularCheckout.Processing and ModularCheckout.Confirmed

The elements ModularCheckout.Empty, ModularCheckout.New, ModularCheckout.Processing and ModularCheckout.Confirmed are helper elements that are used
to conditionally render their children only for a given checkout status. If none of these elements, will be used, all the elements passed to ModularCheckout
will be rendered for every checkout status.

For example:

<ModularCheckout.Confirmed>
  <CheckoutOrderConfirmation />
</ModularCheckout.Confirmed>

This will guarantee that the CheckoutOrderConfirmation module is only displayed if the current checkout status is confirmed,
that is, that the payment has been successfully processed.

Properties:

No properties supported.

Multi-step ModularCheckout

It is possible to spread the modular checkout over several pages. The only requirement is to keep the Checkout element as a parent for all of the routes
that are using any of the checkout modules described before.

The example below illustrates how to do it with the react-router library.

import React from "react";
import { Checkout, CheckoutProductList, ChekoutCustomerAddressDelivery, CheckoutSummary, CheckoutPromoCode, CheckoutPayment } from "@tipser/tipser-elements";
import { Route, Switch, withRouter } from "react-router";

export const CheckoutMultipage = withRouter(({ match }) => (
  <div>
    <div className="te-multipage-label">Checkout multipage</div>
    <ModularCheckout>
      <Switch>
        <Route path={`${match.url}/step-1`}>
          <CheckoutPage1 />
        </Route>
        <Route path={`${match.url}/step-2`}>
          <CheckoutPage2 />
        </Route>
      </Switch>
    </ModularCheckout>
  </div>
));

const CheckoutPage1 = () => (
  <>
    <h2>Step 1</h2>
    <CheckoutProductList />
    <ChekoutCustomerAddressDelivery />
    <CheckoutSummary />
  </>
);

const CheckoutPage2 = ({ checkout }) => (
  <>
    <h2>Step 2</h2>
    <CheckoutPromoCode />
    <CheckoutPayment />
  </>
);

ModularCart

The main element providing the shopping cart context for all of the shopping cart modules nested under it.

import {
  ModularCart,
  CartProductList,
  CartSummary,
} from "@tipser/tipser-elements";

<ModularCart>
    <CartProductList />
    <CartSummary />
</ModularCart>

A list of supported modules that can be nested under ModularCart:

CartProductList

A list of items in the shopping cart. By default, (unless readOnly prop is set to true) comes together with controls allowing the user to remove products and change their quantities in the shopping cart.

<ModularCart>
  <CartProductList />
</ModularCart>

Properties:

CartSummary

A summary of the total costs and taxes for the products in the shopping cart.

<ModularCart>
  <CartSummary />
</ModularCart>

📘

On the US market the tax value will not be displayed as the tax value can only be calculated at the checkout phase, after the customer fills the delivery address.

Properties:

CartPromoCode

A widget for entering promotion codes

Properties:

CartExpressPayment

Displays a list of supported express payment buttons. Express payment is a way to complete the payment directly from the cart page, skipping the checkout page altogether.

Possible payment buttons: Apple Pay, Google Pay, Pay Pal, Browser Pay.

The exact set of pay buttons displayed to the user will depend on the user's environment (browser, connected wallets, etc).

ModularCart.Empty and ModularCart.NonEmpty

ModularCart.Empty and ModularCart.NonEmpty are helper elements that are used to conditionally render their children only for a given shopping cart status. If none of these elements is be used, all the elements passed to ModularCart will be rendered for every shopping cart status.

For example, to provide a custom empty cart information:

<ModularCart>
    <ModularCart.Empty>The shopping cart is empty, please add some products first!</ModularCart.Empty>
    <ModularCart.NonEmpty>
        <CartProductList />
        <CartSummary />
    </ModularCart.NonEmpty>
</ModularCart>

Accessing the cart context

In case you need even more access to the internal functionality of ModularCart, for example in order to build your own shopping cart view implementation, you can use useCartContext hook to access the internal data and functions.

const CustomCartModule = () => {
  const { shoppingCart } = useCartContext();
  useEffect(() => {
    console.log('shoppingCart = ', shoppingCart);
  }, [shoppingCart]);

  return null;
};

Returned members:

Note that the component using the useCartContext hook needs to be located under the ModularCart component:

const CartWithCustomModule = () => (
<ModularCart>
      <CustomCartModule />
</ModularCart>
)

Internal functions

In case you need to open Tipser dialogs from the code or perform operations like adding a Tipser product to cart, we provide a set of JavaScript functions that serve that purpose.

📘

Typical use case for calling the actions described here is when you want to build your own implementation of some of the components, e.g. the product tile component or the cart icon component.

All the below functions are accessible from useInternalFunctions hook to every component living in the context of TipserElementsProvider.

const { goToProduct, goToCheckout, addToCart, removeFromCart, addToCartAndGoToCheckout } = useInternalFunctions();

goToProduct() function

const { goToProduct } = useInternalFunctions();
goToProduct(productId);

Opens the product modal dialog for a product with a given Tipser product id. Alternatively, redirects to the URL defined in customUrls.baseProductUrl configuration option if specified.

goToCheckout() function

const { goToCheckout } = useInternalFunctions();
goToCheckout();

Opens the checkout modal dialog. Alternatively, redirects to the URL defined in customUrls.checkoutUrl configuration option if specified.

addToCart(productId) function

const { addToCart } = useInternalFunctions();
addToCart(productId).then(() => {
  console.log("adding to cart successful");
}).catch((e) => {
  console.log("adding to cart failed", e)
});

Adds to cart a product with a given Tipser product id. Return a promise

removeFromCart(productId) function

const { removeFromCart } = useInternalFunctions();
removeFromCart(productId).then(() => {
    console.log("removing from cart successful");
}).catch((e) => {
    console.log("removing from cart failed", e)
});

Adds to cart a product with a given Tipser product id. Returns a promise that will succeed or reject depending on the status of that operation.

getCartItems() function

const { getCartItems } = useInternalFunctions();
getCartItems().then((cartItems) => {
    console.log("cart items: ", cartItems)
}).catch((e) => {
    console.log("failed to get cart items", e)
});

Returns a Promise that will eventually return a list of all Tipser products currently in the shopping cart.

addToCartAndGoToCheckout(productId) function

const { addToCartAndGoToCheckout } = useInternalFunctions();
addToCartAndGoToCheckout(productId).then(() => {
   console.log("add to cart and go to checkout successful");
}).catch((e) => {
   console.log("add to cart and go to checkout  failed", e)
});

Adds to cart a product with a given Tipser product id and then opens the checkout modal dialog. Alternatively, redirects to the URL defined in customUrls.checkoutUrl configuration option if specified. Returns a promise that will succeed or reject depending on the status of that operation.