Shimmer Button

A button with a soft band of light that crosses its surface now and then, for one standout action. Builds on Button, so focus, disabled and loading work the same.

Motionv0.1.0experimentalWCAG 2.2 AAView spec

Optional, and kept apart.

Nothing here is included in a project unless you add it, and the plain component it builds on is unchanged. This effect is decoration: it is hidden from screen readers, stands still for visitors who prefer reduced motion, and can be paused. Use Still on a preview to see that version.

import { ShimmerButton } from "@rdloom/react";

export default function ShimmerButtonBasicExample() {
  return (
    <ShimmerButton>Start free trial</ShimmerButton>
  );
}

Installation

CLI

Manual

npm

pnpm

yarn

bun

npx rdloom add shimmer-button

Copies the source into src/components/rdloom. Edit it freely: rdloom upgrade merges later versions into your changes.

It also adds rdloom-motion.css next to your tokens and imports it from the tokens file, once: no setup, and no inline styles. The plain components you already use are untouched.

Use another registry client

npx shadcn@latest add https://rdloom.vimalbhatt.com/r/shimmer-button.json

Works, but without upgrade tracking, and you import the motion CSS yourself.

Usage

import { ShimmerButton } from "@rdloom/react";

<ShimmerButton>Start free trial</ShimmerButton>

Variants

import { ShimmerButton } from "@rdloom/react";

export default function ShimmerButtonVariantsExample() {
  return (
    <div className="flex flex-wrap items-center gap-3">
      <ShimmerButton>Primary</ShimmerButton>
      <ShimmerButton variant="secondary">Secondary</ShimmerButton>
      <ShimmerButton variant="danger">Danger</ShimmerButton>
      <ShimmerButton size="lg">Large</ShimmerButton>
    </div>
  );
}

Paused

import { useState } from "react";
import { Button, ShimmerButton } from "@rdloom/react";

// Anything that keeps moving should be stoppable: isPaused freezes the shimmer.
export default function ShimmerButtonPausedExample() {
  const [paused, setPaused] = useState(false);
  return (
    <div className="flex items-center gap-3">
      <ShimmerButton isPaused={paused}>Upgrade</ShimmerButton>
      <Button variant="ghost" size="sm" onPress={() => setPaused((p) => !p)} aria-pressed={paused}>
        {paused ? "Resume motion" : "Pause motion"}
      </Button>
    </div>
  );
}

API Reference

Defined by the spec. Components also accept the props of the React Aria component they wrap.

Prop	Type	Default
`children`required Button label. Icon-only buttons must pass aria-label instead.	`node`	none
`variant` Visual emphasis, as on Button.	`"primary" \| "secondary" \| "ghost" \| "danger"`	`"primary"`
`size` Height, padding and font size, as on Button.	`"sm" \| "md" \| "lg"`	`"md"`
`duration` Seconds for one sweep, including the pause before the next.	`number`	`2.6`
`isPaused` Stops the animation. Moving content that lasts more than five seconds should be stoppable.	`boolean`	`false`
`isDisabled` Prevents interaction and dims the button.	`boolean`	`false`
`isLoading` Shows a spinner and blocks presses; the pending state is announced.	`boolean`	`false`
`onPress` Called when the button is pressed by mouse, touch or keyboard.	`() => void`	none

Accessibility

Role button, WCAG 2.2 AA. Tested with axe and keyboard tests; screen reader checks are in the audit checklist.

Keyboard

Tab focuses it
Enter or Space presses it

Screen readers announce

Announced exactly as a Button: its label, as a button; the effect adds nothing to what is read

What your code must do

Decoration only: the animated layers are hidden from assistive technology and never take focus
Stands still for visitors who ask for less motion (prefers-reduced-motion), and the effect can also be shown still with the rdm-still class
The label keeps the Button's contrast: the sweep is a translucent overlay behind the text
Does not flash: nothing changes more than three times in a second (WCAG 2.3.1)
Optional: it is a separate component, so projects that do not add it carry none of its code

Guidelines

Use it when

The single primary call to action on a page, like Start free trial

Avoid it when

More than one per screen: it stops standing out
Dense toolbars and forms

Don't

Using it for every button
A very short duration, which reads as flicker

Design tokens

The semantic tokens this component uses. Change them once and every component follows; see Design tokens.

--rd-color-action-primary
--rd-color-action-on-primary
--rd-color-action-danger
--rd-color-surface-default
--rd-color-text-default
--rd-color-border-default
--rd-color-focus-ring
--rd-radius-control