Skip to content
Kitenzo Headless is currently invite-only. To enable it on your store, email support@kitenzo.com.

@kitenzo/react

v0.2.6 · published

React bindings. Re-exports everything in @kitenzo/core and adds a provider, hooks and the BundleEmbed component.

Terminal window
npm install @kitenzo/react
  • Depends on: @kitenzo/core.
  • Peer deps: react >= 18, react-dom >= 18. Optional @shopify/hydrogen-react >= 2024.0.0.
ExportKindDoc
KitenzoProvidercomponentProvider & client
useKitenzohookReturns the KitenzoClient.
useSettingshookReturns ShopSettings | null.
ExportReturnsDoc
useBundles{ bundles, isLoading, error, refetch }Hooks
useBundle{ bundle, isLoading, error, refetch }Hooks
useBundleBuilderbuilder state + methodsHooks
useBundlePriceprice fields (raw + formatted)Hooks
useBundleCart{ addBundleToCart, isLoading, error, lastResult }Hooks
ExportKindDoc
BundleEmbedcomponentReact — BundleEmbed

All of @kitenzo/core is available from @kitenzo/react, so a React app installs one package:

import {
KitenzoProvider, useBundle, useBundleBuilder, useBundlePrice, useBundleCart, BundleEmbed,
KitenzoClient, createBundleBuilder, addBundleToCart, buildCartPayload, calculatePrice, formatMoney,
} from '@kitenzo/react';

Plus every TypeScript type.