🎉 We are thrilled to introduce FastStore v2. If you are looking for documentation of the previous version of FastStore, please refer to FastStore v1.

Navbar Links

A wrapper used to display a set of navigation links that self adapts on mobile or desktop screens.

This component is part of the Navigation feature and must be used in the Navbar context.

Import

Import the component from @faststore/ui

import {
  NavbarLinks,
  NavbarLinksList,
  NavbarLinksListItem,
} from '@faststore/ui'

Import Styles

import '@faststore/ui/src/components/molecules/NavbarLinks/styles.scss'

Usage

⚠️

The mobile version can be achieved with NavbarSlider as wrapper.


Props

Navbar Links

NameTypeDescriptionDefault
testIdstringID to find this component in testing tools (e.g.: Cypress, Testing Library, and Jest).fs-navbar-links

Navbar Links List

NameTypeDescriptionDefault
testIdstringID to find this component in testing tools (e.g.: Cypress, Testing Library, and Jest).fs-navbar-links-list
markerfalse | trueSpecify whether or not this component should display the list's markers (bullets or numbers).

Design Tokens

Local tokenDefault value/Global token linked
--fs-navbar-links-bkg-color
--fs-color-body-bkg
--fs-navbar-links-transition-propertyvar(--fs-transition-property)
--fs-navbar-links-transition-timingvar(--fs-transition-timing)
--fs-navbar-links-transition-functionvar(--fs-transition-function)
--fs-navbar-links-border-top-width-mobilevar(--fs-border-width)
--fs-navbar-links-border-top-color-mobile
var(--fs-border-color-light)
--fs-navbar-links-border-bottom-width-mobilevar(--fs-navbar-links-border-top-width-mobile)
--fs-navbar-links-border-bottom-color-mobile
var(--fs-navbar-links-border-top-color-mobile)

Nested Elements

Link

Local tokenDefault value/Global token linked
--fs-navbar-links-link-width-notebookauto
--fs-navbar-links-link-padding-notebook0 var(--fs-spacing-0)

List

Local tokenDefault value/Global token linked
--fs-navbar-links-list-padding-left-notebookvar(--fs-spacing-3)
--fs-navbar-links-list-margin-left-notebookvar(--fs-spacing-2)
--fs-navbar-links-list-border-left-width-notebookvar(--fs-border-width)
--fs-navbar-links-list-border-left-color-notebook
var(--fs-border-color-light)

Customization

For further customization, you can use the following data attributes:

data-fs-navbar-links

data-fs-navbar-links-list

data-fs-navbar-links-list-item


Related components