Skip to content
Cimpress UI

Side navigation API

Usage guidelinesAPIResources

Import

Section titled “Import”
import {
  UNSTABLE_SideNav,
  UNSTABLE_SideNavList,
  UNSTABLE_SideNavListItem,
  UNSTABLE_SideNavListSection,
} from '@cimpress-ui/react';

API reference

Section titled “API reference”

UNSTABLE_SideNav

Section titled “UNSTABLE_SideNav”
UNSTABLE_SideNavProps
children *
Section titled “ children * ”
ReactNode
UNSTABLE_isCollapsible
Section titled “ UNSTABLE_isCollapsible ”
boolean | ({ defaultCollapsed?: true; isCollapsed?: boolean; onCollapseChange?: (isCollapsed: boolean) => void })

Determines if the side navigation can be collapsed down to an icon-only rail, allowing for more screen space when needed.

Setting to true will enable collapsibility. Passing an object allows for more advanced configuration, including fully controlled usage outside app shell context.

UNSTABLE_SideNavList

Section titled “UNSTABLE_SideNavList”
UNSTABLE_SideNavListProps
children *
Section titled “ children * ”
ReactNode

UNSTABLE_SideNavListItem

Section titled “UNSTABLE_SideNavListItem”
UNSTABLE_SideNavListItemProps
children *
Section titled “ children * ”
StringLikeChildren
href *
Section titled “ href * ”
string
isActive
Section titled “ isActive ”
boolean
icon
Section titled “ icon ”
ReactNode

UNSTABLE_SideNavListSection

Section titled “UNSTABLE_SideNavListSection”
UNSTABLE_SideNavListSectionProps
children *
Section titled “ children * ”
ReactNode
label
Section titled “ label ”
string