SlideOutProvider

When to use

Any module using useSlideOut, ProductSlideOut, or product columns in DataTable.

When NOT to use

Push-aside persistent drawers — use PushAsideWithDrawer.

Podium primitives composed

• Podium Drawer

Related stores

• useSlideOut

Common pitfalls

• Mount once near the app root — multiple instances break the single-panel enforcement.
• Must wrap any component that calls useSlideOut() or uses ProductSlideOut.

Props

Auto-generated from src/providers/SlideOutProvider/SlideOutProvider.types.ts. Do not edit by hand. Run pnpm docs:props after changing source JSDoc.

SlideOutProviderProps

Props for the SlideOutProvider component.

Prop	Type	Required	Description
children	ReactNode	Yes	—
drawerShadow	boolean	No	Whether the Podium Drawer renders a box-shadow on the panel edge. Default: true
drawerWidth	number	No	Default panel width in px (individual openSlideOut calls can override). Default: 400
side	'left' | 'right'	No	Default side of the viewport. Default: 'right'
topOffset	number	No	Top offset in px (e.g. below a fixed app header). Defaults to SHELL_HEADER_HEIGHT (64). Pass 0 when rendering without the header.
zIndex	number	No	z-index for the drawer panel. Default: 1200

Examples

Module slide-out host

import { SlideOutProvider } from '@nike/whisker-component-library';

<SlideOutProvider>
  <ModuleRoutes />
</SlideOutProvider>;