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

Slide Over

This component represents an aditional session that complements the screen's information.


Import the component from @faststore/ui

import { SlideOver, SlideOverHeader } 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/organisms/SlideOver/styles.scss';

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



Slide Over

testIdstringID to find this component in testing tools (e.g.: cypress, testing library, and jest).fs-slide-over
isOpen*false | trueA boolean value that represents the state of the SlideOver
direction"leftSide" | "rightSide"Represents the side that the SlideOver comes from.leftSide
size"full" | "partial"Represents the size of the SlideOver.full
fade"in" | "out"Represents the fade effect of the SlideOver.out
children*string | number | false | true | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortalChildren or function as a children
overlayPropsPropsProps forwarded to the `Overlay` component.
onDismiss() => voidThis function is called whenever the user clicks outside. the modal content
aria-labelledbystringIdentifies the element (or elements) that labels the current element. @see aria-labelledby https://www.w3.org/TR/wai-aria-1.1/#aria-labelledby

Slide Over Header

children*string | number | false | true | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortalA react component to be used as the title in the header.
closeBtnPropsPartial<Omit<IconButtonProps, "onClick">>Props for the Close Button component.{}
onClose*() => voidFunction called when Close Button is clicked.

Design Tokens

Local tokenDefault value/Global token linked

Nested Elements


Local tokenDefault value/Global token linked
--fs-slide-over-header-paddingvar(--fs-spacing-2) var(--fs-spacing-3) var(--fs-spacing-2)



Local tokenDefault value/Global token linked
--fs-slide-over-partial-gapcalc(2 * var(--fs-grid-padding))
--fs-slide-over-partial-width-mobilecalc(100vw - var(--fs-slide-over-partial-gap))
--fs-slide-over-partial-width-notebookcalc(100% / 3)
--fs-slide-over-partial-max-width-notebookcalc(var(--fs-grid-breakpoint-notebook) / 3)



data-fs-slide-over-size="full" | "partial"

data-fs-slide-over-state="in" | "out"



Related components

  • Cart Sidebar

    The CartSidebar displays the summary of items added to the cart along with detailed information, and checkout option.

    See more
  • Filter Slider

    The mobile Filter view that is rendered inside a SlideOver component.

    See more