VerticalTransitioncomponent

VerticalTransition(props: VerticalTransitionProps): ReactElement
ParamType
propsVerticalTransitionProps
Props for the VerticalTransition component — the shared transition variant props. required
Return
ReactElement
A <Transition> element configured with the vertical slide classes.

Transition that slides its children vertically — down when moving forward, up when moving back.

A direction-aware <Transition> preset that slides its children vertically — down when moving forward, up when moving back. It reads the active transition type so the slide direction matches the navigation direction.

Things to know:

  • Defaults to slideDown; with the type set to "forward" it slides down (slideDown), and to "back" it slides up (slideUp).
  • Set the direction with setTransitionType("forward" | "back") inside a startTransition() callback before navigating — see <Transition>.
  • Pass overlay to raise the transition group above surrounding content during the animation (z-index: 100).

Usage

tsx
import { VerticalTransition } from "shelving/ui";

<VerticalTransition>
  <Router routes={ROUTES}/>
</VerticalTransition>

Styling

VariableStylesDefault
--vertical-transition-sizeSlide distance for the enter/leave keyframes25vh
--vertical-transition-durationDuration of the slide keyframesvar(--duration-normal)

Global tokens it reads--duration-normal.

Examples

<VerticalTransition>{currentStep}</VerticalTransition>