Skip to content
Cimpress UI

Nav list API

Usage guidelinesAPIResources

Import

Section titled “Import”
import { UNSTABLE_NavList, UNSTABLE_NavListGroup, UNSTABLE_NavListItem } from '@cimpress-ui/react';

API reference

Section titled “API reference”

UNSTABLE_NavList

Section titled “UNSTABLE_NavList”

Displays a vertical navigation list.

UNSTABLE_NavListProps
Section titled “ children * ”
ReactNode

UNSTABLE_NavListItem

Section titled “UNSTABLE_NavListItem”

Displays a single navigation item.

UNSTABLE_NavListItemProps
Section titled “ children * ”
StringLikeChildren
Section titled “ icon ”
ReactNode
Section titled “ href ”
string

A URL to link to.

Section titled “ isCurrent ”
boolean
Section titled “ isDisabled ”
boolean
Section titled “ routerOptions ”
undefined

Options for the configured client side router.

Section titled “ hrefLang ”
string

Hints at the human language of the linked URL. SeeMDN.

Section titled “ target ”
HTMLAttributeAnchorTarget

The target window for the link. See MDN.

Section titled “ rel ”
string

The relationship between the linked resource and the current page. See MDN.

Section titled “ download ”
string | boolean

Causes the browser to download the linked URL. A string may be provided to suggest a file name. See MDN.

Section titled “ ping ”
string

A space-separated list of URLs to ping when the link is followed. See MDN.

Section titled “ referrerPolicy ”
HTMLAttributeReferrerPolicy

How much of the referrer to send when following the link. See MDN.

UNSTABLE_NavListGroup

Section titled “UNSTABLE_NavListGroup”

Displays an expandable navigation item group.

UNSTABLE_NavListGroupProps
Section titled “ children * ”
ReactNode
Section titled “ label * ”
StringLikeChildren
Section titled “ icon ”
ReactNode
Section titled “ isExpanded ”
boolean
Section titled “ defaultExpanded ”
boolean
Section titled “ onExpandedChange ”
(isExpanded: boolean) => void
Section titled “ isDisabled ”
boolean