Hooks — Consumer Reference
Public hooks exported from @nike/whisker-component-library. Import from the
package root only.
Provider hooks
Section titled “Provider hooks”| 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 |
Store selection hooks
Section titled “Store selection hooks”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) |
Store info hooks
Section titled “Store info hooks”Backed by useStoreInfoStore inside NikeStoreProvider.
| Hook | Returns |
|---|---|
useStoreInfoStore |
Raw store info Zustand store |
useStoresCache |
Cached store list helpers |
Picklist cart hooks
Section titled “Picklist cart hooks”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 |
Utility hooks
Section titled “Utility hooks”| Hook | Purpose |
|---|---|
useInventoryWithBurstLoading |
Internal burst loader — prefer useInventory in components |
useReactiveProductLookup |
Reactive product map subscription |
useNikeFonts |
Load Nike CDN fonts for active locale |
DevTools hooks
Section titled “DevTools hooks”| Hook | Purpose |
|---|---|
useDevTools |
Panel state, tabs, registered Zustand stores |
useDevToolsLauncher |
Imperative open/close for custom launcher buttons |
See DevTools.
Internal hooks (not exported)
Section titled “Internal hooks (not exported)”useCopyToClipboard, useFilterOptionsWithCounts, useIsMobile,
useHasTranslations, useCurrentTranslations — library-internal only.
