Keyframery

Animated Timeline for UI SDK

Events rise in one after another, a finished step's check draws itself and the rail fills.

Part of Keyframery, the open-source animated components for UI SDK

The demo plays by itself. Point at it or press Tab to take over.

Installation

npx shadcn@latest add @keyframery/timeline

This adds components/keyframery/timeline.tsx and its primitive, components/keyframery/primitives/timeline.tsx, to your project, and installs @ui-sdk/react. The motion tokens are added to your global CSS the first time you install a component.

Usage

import {
  Timeline,
  TimelineConnector,
  TimelineDescription,
  TimelineItem,
  TimelineMarker,
  TimelineTime,
  TimelineTitle,
} from "@/components/keyframery/timeline"

The parts and props are the same as UI SDK's Timeline. For every prop, see the UI SDK timeline reference.

What moves

MoveWhat you see
CascadeEvents rise in one after another.
DrawA finished step's check draws itself.
SpringThe rail fills as steps complete.

Timing and springiness follow the motion style you set, so this component moves like the rest of your app.

Swap the import

Already using UI SDK's timeline with your own styles? Keep your markup and change one line. The primitive adds motion and nothing else.

// Before
import { … } from "@ui-sdk/react/timeline"

// After: same parts, same props, now animated
import { … } from "@/components/keyframery/primitives/timeline"

Parts

The finished component exports 7 parts:

Timeline, TimelineConnector, TimelineDescription, TimelineItem, TimelineMarker, TimelineTime, TimelineTitle

Accessibility

Keyboard, focus and screen-reader behaviour come from UI SDK and are not changed. With reduced motion turned on, nothing in the timeline moves: changes happen at once or with a short fade. More in Accessibility.

Source

The code that lands in your project. It is yours to change.

Questions

How does the animated Timeline for UI SDK move?

Cascade: Events rise in one after another. Draw: A finished step's check draws itself. Spring: The rail fills as steps complete.

Do I need Motion or Framer Motion for the animated Timeline?

No. Every move is plain CSS, so there is nothing to install besides the component and UI SDK.

Can I keep my own styling and only take the motion?

Yes. Import from @/components/keyframery/primitives/timeline instead. It has the same parts and props as @ui-sdk/react/timeline and adds motion only.

What happens to the Timeline when someone turns on reduced motion?

Nothing moves. State changes happen at once, or with a short fade.

On this page