Nav

Clay Nav provides a clear and semantic navigation for your site

installyarn add @clayui/nav
versionNPM Version
useimport Nav from '@clayui/nav';

Table of Contents

Basic Usage

API Reference

IForwardRef<HTMLUListElement, IProps>
Parameters
Properties

nested

boolean | undefined

Flag to indicate if nav-nested class should be applied. Adds padding to indent each nested navigation.

nestMargins

boolean | undefined

Flag to indicate if nav-nested-margins class should be applied. Adds margin to indent each nested navigation.

stacked

boolean | undefined

Flag to indicate if nav-stacked class should be applied.

Returns
ReactElement<any, string | JSXElementConstructor<any>> | null
React.ForwardRefExoticComponent<IProps & React.RefAttributes<HTMLAnchorElement | HTMLButtonElement | HTMLDivElement>>
Parameters
Properties

active

boolean | undefined

Flag to indicate if active class should be applied.

collapsed

boolean | undefined

Flag to indicate if collapsed class should be applied.

disabled

boolean | undefined

Flag to indicate if disabled class should be applied.

showIcon

boolean | undefined

Flag to indicate if icon should be shown.

spritemap

string | undefined

Path to the spritemap that Icon should use when referencing symbols.

Returns
ReactElement<any, string | JSXElementConstructor<any>> | null

Item

({ children, className, ...otherProps }: React.HTMLAttributes<HTMLLIElement>) => JSX.Element
Returns
Element
Edit this page on GitHub

Contributors

Matuzalém Teles, Bryce Osterhaus, Krešimir Čoko, Diego Nascimento

Last edited May 11, 2025 at 5:57:01 PM

Table of Contents