⚠️ After March 18, 2024, the FastStore documentation will be migrated to the Developer Portal. For more information, access the official release note.

Search Top

This section displays the most searched terms by customers. This component is part of the Search feature.

Import

Import the component from @faststore/ui

import { SearchTop, SearchTopTerm } from '@faststore/ui'

Import Styles into your FastStore project

To apply the styles of this component in your FastStore project, import the following into your stylesheet:

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

Follow the instructions in the Importing FastStore UI component styles tutorial.


Usage

<SearchTop title="Top Search">
  <SearchTopTerm value="Notebooks" linkProps={{ href: '#' }} index={0} />
  <SearchTopTerm value="Laser Printer" linkProps={{ href: '#' }} index={1} />
  <SearchTopTerm
    value="Bluetooth Keyboard"
    linkProps={{ href: '#' }}
    index={2}
  />
</SearchTop>

Props

Search Top

NameTypeDescriptionDefault
testIdstringID to find this component in testing tools (e.g.: cypress, testing library, and jest).fs-top-search
titlestringTitle attribute for the <section> tag rendered by this component.Top Search

Search Top Term

NameTypeDescriptionDefault
testIdstringID to find this component in testing tools (e.g.: cypress, testing library, and jest).fs-top-search-term
value*stringSearch term to be shown.
linkPropsPartial<LinkProps<LinkElementType>>Props for the `<Link>` rendered by this component.
index*numberCurrent term's position in a list of search terms.

Design Tokens

Local tokenDefault value/Global token linked
--fs-search-top-padding-topvar(--fs-spacing-2)
--fs-search-top-padding-rightvar(--fs-spacing-3)
--fs-search-top-padding-bottomvar(--fs-search-top-padding-top)
--fs-search-top-padding-leftvar(--fs-search-top-padding-right)
--fs-search-top-transition-propertyvar(--fs-transition-property)
--fs-search-top-transition-functionvar(--fs-transition-function)
--fs-search-top-transition-timingvar(--fs-transition-timing)

Nested Elements

Header

Local tokenDefault value/Global token linked
--fs-search-top-header-padding-topvar(--fs-spacing-1)
--fs-search-top-header-padding-bottomvar(--fs-search-top-header-padding-top)

Title

Local tokenDefault value/Global token linked
--fs-search-top-title-sizevar(--fs-text-size-lead)
--fs-search-top-title-line-height1.5

Item

Local tokenDefault value/Global token linked
--fs-search-top-item-column-gapvar(--fs-spacing-1)
--fs-search-top-item-text-sizevar(--fs-text-size-2)
--fs-search-top-item-line-height1.25
--fs-search-top-item-bkg-color-hover
var(--fs-color-tertiary-bkg-hover)

Customization

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

data-fs-search-top

data-fs-search-top-header

data-fs-search-top-title

data-fs-search-top-item

data-fs-search-top-item-link

data-fs-search-top-item-badge