TopNav#

The <TopNav> component renders a list of links or items used for navigation.

Bumbag's navigation you see at the top is built with <TopNav> & it fits perfectly alongside the PageWithHeader component.

Import#

import { TopNav } from 'bumbag'

Usage#

Editable example

<TopNav>
  <TopNav.Section>
    <TopNav.Item href="https://bumbag.style" fontWeight="semibold">
      <Image src="/logo.png" height="44px" />
    </TopNav.Item>
    <TopNav.Item href="#">Get started</TopNav.Item>
    <TopNav.Item href="#">Components</TopNav.Item>
  </TopNav.Section>
  <TopNav.Section>
    <TopNav.Item>
      <Button variant="ghost" palette="primary">Sign up</Button>
    </TopNav.Item>
    <TopNav.Item>
      <Button palette="primary">Login</Button>
    </TopNav.Item>
  </TopNav.Section>
</TopNav>

<TopNav>
  <TopNav.Section>
    <TopNav.Item href="https://bumbag.style" fontWeight="semibold">
      <Image src="/logo.png" height="44px" />
    </TopNav.Item>
    <TopNav.Item href="#">Get started</TopNav.Item>
    <TopNav.Item href="#">Components</TopNav.Item>
  </TopNav.Section>
  <TopNav.Section>
    <TopNav.Item>
      <Button variant="ghost" palette="primary">Sign up</Button>
    </TopNav.Item>
    <TopNav.Item>
      <Button palette="primary">Login</Button>
    </TopNav.Item>
  </TopNav.Section>
</TopNav>

Variants#

Pill#

Editable example

<TopNav>
  <TopNav.Section>
    <TopNav.Item href="https://bumbag.style" fontWeight="semibold">
      <Image src="/logo.png" height="44px" />
    </TopNav.Item>
    <TopNav.Item href="#" variant="pill">Get started</TopNav.Item>
    <TopNav.Item href="#" variant="pill">Components</TopNav.Item>
  </TopNav.Section>
  <TopNav.Section>
    <TopNav.Item>
      <Button variant="ghost" palette="primary">Sign up</Button>
    </TopNav.Item>
    <TopNav.Item>
      <Button palette="primary">Login</Button>
    </TopNav.Item>
  </TopNav.Section>
</TopNav>

<TopNav>
  <TopNav.Section>
    <TopNav.Item href="https://bumbag.style" fontWeight="semibold">
      <Image src="/logo.png" height="44px" />
    </TopNav.Item>
    <TopNav.Item href="#" variant="pill">Get started</TopNav.Item>
    <TopNav.Item href="#" variant="pill">Components</TopNav.Item>
  </TopNav.Section>
  <TopNav.Section>
    <TopNav.Item>
      <Button variant="ghost" palette="primary">Sign up</Button>
    </TopNav.Item>
    <TopNav.Item>
      <Button palette="primary">Login</Button>
    </TopNav.Item>
  </TopNav.Section>
</TopNav>

Selected items#

Controlled#

Editable example

function Example() {
  const [selectedId, setSelectedId] = React.useState('get-started');
  return (
    <TopNav selectedId={selectedId} onChange={id => setSelectedId(id)}>
      <TopNav.Section>
        <TopNav.Item href="https://bumbag.style" fontWeight="semibold">
          <Image src="/logo.png" height="44px" />
        </TopNav.Item>
        <TopNav.Item navId="get-started" href="#">Get started</TopNav.Item>
        <TopNav.Item navId="components" href="#">Components</TopNav.Item>
      </TopNav.Section>
      <TopNav.Section>
        <TopNav.Item>
          <Button variant="ghost" palette="primary">Sign up</Button>
        </TopNav.Item>
        <TopNav.Item>
          <Button palette="primary">Login</Button>
        </TopNav.Item>
      </TopNav.Section>
    </TopNav>
  )
}

function Example() {
  const [selectedId, setSelectedId] = React.useState('get-started');
  return (
    <TopNav selectedId={selectedId} onChange={id => setSelectedId(id)}>
      <TopNav.Section>
        <TopNav.Item href="https://bumbag.style" fontWeight="semibold">
          <Image src="/logo.png" height="44px" />
        </TopNav.Item>
        <TopNav.Item navId="get-started" href="#">Get started</TopNav.Item>
        <TopNav.Item navId="components" href="#">Components</TopNav.Item>
      </TopNav.Section>
      <TopNav.Section>
        <TopNav.Item>
          <Button variant="ghost" palette="primary">Sign up</Button>
        </TopNav.Item>
        <TopNav.Item>
          <Button palette="primary">Login</Button>
        </TopNav.Item>
      </TopNav.Section>
    </TopNav>
  )
}

Uncontrolled#

Editable example

<TopNav defaultSelectedId="get-started">
  <TopNav.Section>
    <TopNav.Item href="https://bumbag.style" fontWeight="semibold">
      <Image src="/logo.png" height="44px" />
    </TopNav.Item>
    <TopNav.Item navId="get-started" href="#">Get started</TopNav.Item>
    <TopNav.Item navId="components" href="#">Components</TopNav.Item>
  </TopNav.Section>
  <TopNav.Section>
    <TopNav.Item>
      <Button variant="ghost" palette="primary">Sign up</Button>
    </TopNav.Item>
    <TopNav.Item>
      <Button palette="primary">Login</Button>
    </TopNav.Item>
  </TopNav.Section>
</TopNav>

<TopNav defaultSelectedId="get-started">
  <TopNav.Section>
    <TopNav.Item href="https://bumbag.style" fontWeight="semibold">
      <Image src="/logo.png" height="44px" />
    </TopNav.Item>
    <TopNav.Item navId="get-started" href="#">Get started</TopNav.Item>
    <TopNav.Item navId="components" href="#">Components</TopNav.Item>
  </TopNav.Section>
  <TopNav.Section>
    <TopNav.Item>
      <Button variant="ghost" palette="primary">Sign up</Button>
    </TopNav.Item>
    <TopNav.Item>
      <Button palette="primary">Login</Button>
    </TopNav.Item>
  </TopNav.Section>
</TopNav>

Props#

TopNav Props#

defaultSelectedId string

onChange any

selectedId string

Inherits Navigation props

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#

TopNav.styles.base

TopNav.Section.styles.base

TopNav.Item.styles.base

TopNav.Item.styles.active

TopNav.Item.styles.hover

TopNav.Item.styles.focus

On this page