Skip to main content

NavigationMenu

Horizontal navigation menu with dropdown submenus

Example

navigation-menu
Loading preview…

Horizontal navigation menu with dropdown submenus

Source: packages/appkit-ui/src/react/ui/navigation-menu.tsx

Props

PropTypeRequiredDefaultDescription
valuestring--
defaultValuestring--
onValueChange((value: string) => void)--
direnum--
orientationenum--
delayDurationnumber-The duration from when the pointer enters the trigger until the tooltip gets opened. @defaultValue 200
skipDelayDurationnumber-How much time a user has to enter another trigger without incurring a delay again. @defaultValue 300
asChildboolean--
viewportbooleantrue-

Usage

import { NavigationMenu } from '@databricks/appkit-ui';

<NavigationMenu /* props */ />

Dropdown content area for navigation submenu

Source: packages/appkit-ui/src/react/ui/navigation-menu.tsx

Props

PropTypeRequiredDefaultDescription
forceMounttrue-Used to force mounting when more control is needed. Useful when controlling animation with React animation libraries.
asChildboolean--
onEscapeKeyDown((event: KeyboardEvent) => void)-Event handler called when the escape key is down. Can be prevented.
onPointerDownOutside((event: PointerDownOutsideEvent) => void)-Event handler called when the a pointerdown event happens outside of the DismissableLayer. Can be prevented.
onFocusOutside((event: FocusOutsideEvent) => void)-Event handler called when the focus moves outside of the DismissableLayer. Can be prevented.
onInteractOutside((event: FocusOutsideEvent | PointerDownOutsideEvent) => void)-Event handler called when an interaction happens outside the DismissableLayer. Specifically, when a pointerdown event happens outside or focus moves outside of it. Can be prevented.

Usage

import { NavigationMenuContent } from '@databricks/appkit-ui';

<NavigationMenuContent /* props */ />

Visual indicator for active navigation menu item

Source: packages/appkit-ui/src/react/ui/navigation-menu.tsx

Props

PropTypeRequiredDefaultDescription
forceMounttrue-Used to force mounting when more control is needed. Useful when controlling animation with React animation libraries.
asChildboolean--

Usage

import { NavigationMenuIndicator } from '@databricks/appkit-ui';

<NavigationMenuIndicator /* props */ />

Individual navigation menu item

Source: packages/appkit-ui/src/react/ui/navigation-menu.tsx

Props

PropTypeRequiredDefaultDescription
valuestring--
asChildboolean--

Usage

import { NavigationMenuItem } from '@databricks/appkit-ui';

<NavigationMenuItem /* props */ />

Clickable link within navigation menu

Source: packages/appkit-ui/src/react/ui/navigation-menu.tsx

Props

PropTypeRequiredDefaultDescription
activeboolean--
onSelect((event: Event) => void)--
asChildboolean--

Usage

import { NavigationMenuLink } from '@databricks/appkit-ui';

<NavigationMenuLink /* props */ />

Container list for navigation menu items

Source: packages/appkit-ui/src/react/ui/navigation-menu.tsx

Props

PropTypeRequiredDefaultDescription
asChildboolean--

Usage

import { NavigationMenuList } from '@databricks/appkit-ui';

<NavigationMenuList /* props */ />

Button that opens a navigation submenu

Source: packages/appkit-ui/src/react/ui/navigation-menu.tsx

Props

PropTypeRequiredDefaultDescription
asChildboolean--

Usage

import { NavigationMenuTrigger } from '@databricks/appkit-ui';

<NavigationMenuTrigger /* props */ />

Viewport container for navigation menu content

Source: packages/appkit-ui/src/react/ui/navigation-menu.tsx

Props

PropTypeRequiredDefaultDescription
forceMounttrue-Used to force mounting when more control is needed. Useful when controlling animation with React animation libraries.
asChildboolean--

Usage

import { NavigationMenuViewport } from '@databricks/appkit-ui';

<NavigationMenuViewport /* props */ />