NavHorizontal

A light, responsive navigation bar for product destinations.

Interactive playground

LIVE PREVIEW

Loading preview…

Generated code

import { NavHorizontal } from '@vrum/ui';
import { NavHorizontalBrand, Logo, NavHorizontalContent, NavHorizontalItem, NavHorizontalEnd, Avatar } from '@vrum/ui';

<NavHorizontal
  menuLabel={"Open navigation"}
  moreLabel={"More destinations"}
>
  <NavHorizontalBrand><Logo size="sm" /></NavHorizontalBrand><NavHorizontalContent><NavHorizontalItem href="#overview" isActive>Overview</NavHorizontalItem><NavHorizontalItem href="#projects">Projects</NavHorizontalItem><NavHorizontalItem href="#team">Team</NavHorizontalItem></NavHorizontalContent><NavHorizontalEnd><Avatar initials="AM" size="sm" /></NavHorizontalEnd>
</NavHorizontal>

NavHorizontal props

Prop	Type	Default	Description
`menuLabel`	`string`	`"Open navigation"`	menu label configuration.
`moreLabel`	`string`	`"More destinations"`	more label configuration.
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLElement>`	none	on select configuration.

NavHorizontalBrand props

Prop	Type	Default	Description
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLDivElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLDivElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLDivElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLDivElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLDivElement>`	none	on select configuration.

NavHorizontalContent props

Prop	Type	Default	Description
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLDivElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLDivElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLDivElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLDivElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLDivElement>`	none	on select configuration.

NavHorizontalItem props

Prop	Type	Default	Description
`icon`	`React.ReactNode`	none	icon configuration.
`isActive`	`boolean`	`false`	is active configuration.
`href`	`string`	none	href configuration.
`type`	`string`	none	type configuration.
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLAnchorElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLAnchorElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLAnchorElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLAnchorElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLAnchorElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLAnchorElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLAnchorElement>`	none	on select configuration.

NavHorizontalEnd props

Prop	Type	Default	Description
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLDivElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLDivElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLDivElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLDivElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLDivElement>`	none	on select configuration.

NavHorizontal

A light, responsive navigation bar for product destinations.

Interactive playground

LIVE PREVIEW

Loading preview…

Generated code

import { NavHorizontal } from '@vrum/ui';
import { NavHorizontalBrand, Logo, NavHorizontalContent, NavHorizontalItem, NavHorizontalEnd, Avatar } from '@vrum/ui';

<NavHorizontal
  menuLabel={"Open navigation"}
  moreLabel={"More destinations"}
>
  <NavHorizontalBrand><Logo size="sm" /></NavHorizontalBrand><NavHorizontalContent><NavHorizontalItem href="#overview" isActive>Overview</NavHorizontalItem><NavHorizontalItem href="#projects">Projects</NavHorizontalItem><NavHorizontalItem href="#team">Team</NavHorizontalItem></NavHorizontalContent><NavHorizontalEnd><Avatar initials="AM" size="sm" /></NavHorizontalEnd>
</NavHorizontal>

NavHorizontal props

Prop	Type	Default	Description
`menuLabel`	`string`	`"Open navigation"`	menu label configuration.
`moreLabel`	`string`	`"More destinations"`	more label configuration.
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLElement>`	none	on select configuration.

NavHorizontalBrand props

Prop	Type	Default	Description
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLDivElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLDivElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLDivElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLDivElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLDivElement>`	none	on select configuration.

NavHorizontalContent props

Prop	Type	Default	Description
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLDivElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLDivElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLDivElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLDivElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLDivElement>`	none	on select configuration.

NavHorizontalItem props

Prop	Type	Default	Description
`icon`	`React.ReactNode`	none	icon configuration.
`isActive`	`boolean`	`false`	is active configuration.
`href`	`string`	none	href configuration.
`type`	`string`	none	type configuration.
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLAnchorElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLAnchorElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLAnchorElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLAnchorElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLAnchorElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLAnchorElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLAnchorElement>`	none	on select configuration.

NavHorizontalEnd props

Prop	Type	Default	Description
`defaultChecked`	`boolean`	none	default checked configuration.
`defaultValue`	`string \| number \| readonly string[]`	none	Initial value for an uncontrolled component.
`autoFocus`	`boolean`	none	auto focus configuration.
`className`	`string`	none	Additional CSS classes.
`id`	`string`	none	id configuration.
`style`	`CSSProperties`	none	Inline style overrides.
`aria-invalid`	`boolean \| "false" \| "true" \| "grammar" \| "spelling"`	none	Indicates the entered value does not conform to the format expected by the application.
`aria-label`	`string`	none	Defines a string value that labels the current element.
`children`	`ReactNode`	none	Content rendered inside the component.
`onFocus`	`FocusEventHandler<HTMLDivElement>`	none	on focus configuration.
`onBlur`	`FocusEventHandler<HTMLDivElement>`	none	on blur configuration.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	none	Called when the input value changes.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	none	Called when the form is submitted.
`onKeyDown`	`KeyboardEventHandler<HTMLDivElement>`	none	on key down configuration.
`onClick`	`MouseEventHandler<HTMLDivElement>`	none	Called when the control is activated.
`onSelect`	`ReactEventHandler<HTMLDivElement>`	none	on select configuration.

NavHorizontal

Interactive playground

Props

NavHorizontal props

NavHorizontalBrand props

NavHorizontalContent props

NavHorizontalItem props

NavHorizontalEnd props

NavHorizontal

Interactive playground

Props

NavHorizontal props

NavHorizontalBrand props

NavHorizontalContent props

NavHorizontalItem props

NavHorizontalEnd props