Skip to content

Hooks — Consumer Reference

Public hooks exported from @nike/whisker-component-library. Import from the package root only.

Hook Provider Purpose
useNikeStore NikeStoreProvider Store info, config, athletes; null outside provider
useInventory InventoryProvider Inventory burst load, getProduct, readiness flags
useInventoryOptional InventoryProvider Same as useInventory but returns null when absent
useSlideOut SlideOutProvider Open/close centralised slide-out panel
useTranslation TranslationProvider t() lookup, locale, RTL flag
useModuleAnalytics ModuleAnalyticsProvider Emit New Relic module events
useNikeTheme TranslationProvider MUI theme synced with locale direction

Backed by useStoreSelectionStore (Zustand). Used with StoreCountrySelector.

Hook Returns
useStoreIds Selected store UUIDs
useStoreNumbers Selected store numbers
useSelectedStore Primary selected store object
useUserStore User’s home store
useIsStoreSelected (storeId) => boolean
useStoreSelectionStore Raw Zustand store (advanced)

Backed by useStoreInfoStore inside NikeStoreProvider.

Hook Returns
useStoreInfoStore Raw store info Zustand store
useStoresCache Cached store list helpers

Backed by usePicklistCartStore. Wire to DataTable picklistCart config.

Hook Returns
usePicklistCartEntries Cart line items
usePicklistCartName Active cart name
usePicklistCartCount Item count
usePicklistCartActions Add/remove/clear/submit actions
usePicklistCartStore Raw Zustand store
Hook Purpose
useInventoryWithBurstLoading Internal burst loader — prefer useInventory in components
useReactiveProductLookup Reactive product map subscription
useNikeFonts Load Nike CDN fonts for active locale
Hook Purpose
useDevTools Panel state, tabs, registered Zustand stores
useDevToolsLauncher Imperative open/close for custom launcher buttons

See DevTools.

useCopyToClipboard, useFilterOptionsWithCounts, useIsMobile, useHasTranslations, useCurrentTranslations — library-internal only.