Marquee
motionFreeMITItems scroll sideways in an endless loop and pause on hover or focus. Static under reduced motion.
npx shadcn@latest add https://mikkelmanniche.dk/lab/r/marquee.jsonPreview
Live demo in the dark theme.
Code
Install
npx shadcn@latest add https://mikkelmanniche.dk/lab/r/marquee.jsonWith the registry added (components.json)
npx shadcn@latest add @manniche/marqueeUsage
import { Marquee } from '@/components/marquee'
export default function MarqueeDemo() {
return (
<Marquee label="Product categories">
{['Kitchen', 'Garden', 'Lighting', 'Textiles', 'Storage', 'Tools'].map((c) => (
<span key={c} className="rounded-full border bg-card px-4 py-2 whitespace-nowrap">
{c}
</span>
))}
</Marquee>
)
}Source
import { Pause, Play } from 'lucide-react'
import { useState, type CSSProperties, type ReactNode } from 'react'
import { cn } from '@/lib/utils'
export type MarqueeProps = {
/** The items that scroll. Rendered twice for a seamless loop. */
children: ReactNode
/** Seconds for one full loop. */
duration?: number
/** Gap between items in pixels. */
gap?: number
/** Scrolls the other way. */
reverse?: boolean
/** Accessible name for the region, e.g. "Customers". */
label: string
/** Accessible name and tooltip of the pause button, with English defaults: `pause` while the strip moves, `play` while it is paused. */
labels?: { pause?: string; play?: string }
/** Classes for the outer region, which holds the strip and the pause button. */
className?: string
}
/**
* Items scroll sideways in an endless loop with soft edges. A button next to the strip pauses and resumes it,
* and it also pauses while hovered or focused.
* The items are rendered twice for a seamless loop; the copy is hidden from screen readers and the keyboard.
* Under reduced motion the items wrap onto lines and stand still, and the button is gone.
*/
export function Marquee({ children, duration = 30, gap = 14, reverse = false, label, labels = {}, className }: MarqueeProps) {
const { pause = 'Pause', play = 'Play' } = labels
const [paused, setPaused] = useState(false)
const vars = { '--mq-duration': `${duration}s`, '--mq-gap': `${gap}px` } as CSSProperties
return (
<div role="region" aria-label={label} style={vars} className={cn('flex items-center gap-2', className)}>
<div
className={cn(
'group/mq min-w-0 flex-1 overflow-hidden mask-[linear-gradient(90deg,transparent,#000_8%,#000_92%,transparent)]',
'motion-reduce:mask-none',
)}
>
<style href="manniche-marquee" precedence="default">
{'@keyframes manniche-marquee { to { transform: translateX(calc(-50% - var(--mq-gap) / 2)) } }'}
</style>
<div
className={cn(
'flex w-max gap-(--mq-gap) animate-[manniche-marquee_var(--mq-duration)_linear_infinite]',
reverse && '[animation-direction:reverse]',
'group-hover/mq:[animation-play-state:paused] group-focus-within/mq:[animation-play-state:paused]',
paused && '[animation-play-state:paused]',
'motion-reduce:w-auto motion-reduce:flex-wrap motion-reduce:animate-none',
)}
>
<div className="flex shrink-0 gap-(--mq-gap) motion-reduce:shrink motion-reduce:flex-wrap">{children}</div>
<div className="flex shrink-0 gap-(--mq-gap) motion-reduce:hidden" aria-hidden inert>
{children}
</div>
</div>
</div>
<button
type="button"
onClick={() => setPaused((p) => !p)}
aria-label={paused ? play : pause}
title={paused ? play : pause}
className="grid size-11 shrink-0 place-items-center rounded-full border bg-card text-foreground transition-colors duration-150 hover:bg-muted motion-reduce:hidden motion-reduce:transition-none"
>
{paused ? <Play className="size-4" aria-hidden /> : <Pause className="size-4" aria-hidden />}
</button>
</div>
)
}Props
MarqueeProps
| Prop | Type | Default | What it does |
|---|---|---|---|
children required | ReactNode | – | The items that scroll. Rendered twice for a seamless loop. |
duration | number | 30 | Seconds for one full loop. |
gap | number | 14 | Gap between items in pixels. |
reverse | boolean | false | Scrolls the other way. |
label required | string | – | Accessible name for the region, e.g. "Customers". |
labels | { pause?: string; play?: string } | {} | Accessible name and tooltip of the pause button, with English defaults: pause while the strip moves, play while it is paused. |
className | string | – | Classes for the outer region, which holds the strip and the pause button. |
A11y
Keyboard
A visible 44 pixel Pause and Play button, placed after the loop in tab order, stops and starts the scrolling. The loop also pauses while the pointer is over it or focus is inside it. The second copy of the items is inert and aria-hidden, so Tab never visits it twice.
Screen reader
The container is a region named by label, which is required (for example Customers). The pause button is named by labels (Pause, Play) and its name changes with the state. Only the first copy of the items is exposed to screen readers.
Reduced motion
Under reduced motion the loop stops, the second copy is hidden, the edge fade is removed, the items wrap onto lines and the pause button is hidden because nothing moves.