BetaPublic beta — Read the release notes
Solidiom
Get Started
Documentation

Navigation Menu

A top-level navigation component with accessible dropdown sub-menus.

Package
@solidiom/navigation-menu
Version
0.0.1-next.0
Status
stable

Generated from the package's public source.

API

Contentcomponent

                        Content(props: NavigationMenuContentProps): Element

Props

class?
string
style?
string | CSSProperties

children: Element

View source

Itemcomponent

                        Item(props: NavigationMenuItemProps): Element

Props

class?
string
style?
string | CSSProperties
value
string — Unique value for this navigation item.

children: Element

View source

Linkcomponent

                        Link(props: NavigationMenuLinkProps): Element

Props

active?
boolean — Whether this link represents the current page.
class?
string
href?
string — Link href.
onClick?
(e: MouseEvent) => void — Called on click.
style?
string | CSSProperties

children: Element

View source

Listcomponent

                        List(props: NavigationMenuListProps): Element

Props

class?
string
style?
string | CSSProperties

children: Element

View source

NavigationMenuContentPropsinterface

Props

class?
string
style?
string | CSSProperties

children: Element

View source

NavigationMenuItemPropsinterface

Props

class?
string
style?
string | CSSProperties
value
string — Unique value for this navigation item.

children: Element

View source

NavigationMenuLinkPropsinterface

Props

active?
boolean — Whether this link represents the current page.
class?
string
href?
string — Link href.
onClick?
(e: MouseEvent) => void — Called on click.
style?
string | CSSProperties

children: Element

View source

NavigationMenuListPropsinterface

Props

class?
string
style?
string | CSSProperties

children: Element

View source

NavigationMenuRootPropsinterface

Props

aria-label?
string — Accessible label for the nav element.
class?
string
defaultValue?
string — Default active item value (uncontrolled).
delayDuration?
number — Delay for pointer intent (ms). Default 200.
onValueChange?
(value: string) => void — Called when active value changes.
orientation?
"horizontal" | "vertical" — Orientation of the navigation bar. Default "horizontal".
positioning?
PositioningPort — Optional positioning adapter for dropdown panels.
style?
string | CSSProperties
value?
Accessor<string | undefined> — Controlled active value.

children: Element

View source

NavigationMenuTriggerPropsinterface

Props

class?
string
style?
string | CSSProperties

children: Element

View source

PositioningPortinterface

Positioning adapter port injected by the consumer.

Props

update
(reference: HTMLElement, floating: HTMLElement) => void | () => void — Compute and apply position styles to the content element.

View source

Rootcomponent

                        Root(props: NavigationMenuRootProps): Element

Props

aria-label?
string — Accessible label for the nav element.
class?
string
defaultValue?
string — Default active item value (uncontrolled).
delayDuration?
number — Delay for pointer intent (ms). Default 200.
onValueChange?
(value: string) => void — Called when active value changes.
orientation?
"horizontal" | "vertical" — Orientation of the navigation bar. Default "horizontal".
positioning?
PositioningPort — Optional positioning adapter for dropdown panels.
style?
string | CSSProperties
value?
Accessor<string | undefined> — Controlled active value.

children: Element

View source

Triggercomponent

                        Trigger(props: NavigationMenuTriggerProps): Element

Props

class?
string
style?
string | CSSProperties

children: Element

View source