Bumbag

The <Navigation> component renders <nav> under the hood.

#Import

import { Navigation } from 'bumbag'

#Usage

Editable example

<Navigation aria-label="External links">
  <List>
    <List.Item>
      <Link href="https://google.com">Google</Link>
    </List.Item>
    <List.Item>
      <Link href="https://github.com">GitHub</Link>
    </List.Item>
  </List>
</Navigation>

<Navigation aria-label="External links">
  <List>
    <List.Item>
      <Link href="https://google.com">Google</Link>
    </List.Item>
    <List.Item>
      <Link href="https://github.com">GitHub</Link>
    </List.Item>
  </List>
</Navigation>

#Accessibility

The <Navigation> component follows the WAI ARIA Navigation Pattern.

#Patterns

The nav element is used.
If the use prop is set to anything other than nav, then a role of navigation will be set as an attribute.

#References

WAI ARIA Navigation Pattern

Inherits Box props

use

string
  | (ComponentClass<any, any> & { useProps: any; })
  | (FunctionComponent<any> & { useProps: any; })

className string

children

string
  | number
  | boolean
  | {}
  | ReactElement<any, string
  | ((props: any) => ReactElement<any, string
  | ...
  | (new (props: any) => Component<any, any, any>)>)
  | (new (props: any) => Component<...>)>
  | ReactNodeArray
  | ReactPortal
  | ((props: BoxProps) => ReactNode)

alignX "right" | "left" | "center"

alignY "top" | "bottom" | "center"

variant string

colorMode string

disabled boolean

overrides

{
  useCSSVariables?: boolean;
  altitudes?: AltitudesThemeConfig;
  borders?: BordersThemeConfig;
  borderRadii?: BorderRadiiThemeConfig;
  ... 95 more ...;
  Template?: TemplateThemeConfig;
}

elementRef ((instance: any) => void) | RefObject<any>

themeKey string

#Theming

Navigation.styles.base

On this page

#Navigation