Skip to content
Cimpress UI

Top nav API

Usage guidelinesAPI

Import

Section titled “Import”

The top nav component consists of two main components that work together:

import { UNSTABLE_TopNav, UNSTABLE_TopNavItem } from '@cimpress-ui/react';

API reference

Section titled “API reference”

UNSTABLE_TopNav

Section titled “UNSTABLE_TopNav”
UNSTABLE_TopNavProps
children *
Section titled “ children * ”
ReactNode

UNSTABLE_TopNavItem

Section titled “UNSTABLE_TopNavItem”
UNSTABLE_TopNavItemProps
children *
Section titled “ children * ”
StringLikeChildren
href *
Section titled “ href * ”
string

A URL to link to.

isActive
Section titled “ isActive ”
boolean
routerOptions
Section titled “ routerOptions ”
undefined

Options for the configured client side router.

hrefLang
Section titled “ hrefLang ”
string

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

target
Section titled “ target ”
HTMLAttributeAnchorTarget

The target window for the link. See MDN.

rel
Section titled “ rel ”
string

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

download
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.

ping
Section titled “ ping ”
string

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

referrerPolicy
Section titled “ referrerPolicy ”
HTMLAttributeReferrerPolicy

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