@input-kit/timeline
v0.1.1
Published
Accessible React timelines for milestones, launches, and journey storytelling
Maintainers
Readme
@input-kit/timeline
Accessible React timelines for launches, customer journeys, hiring loops, and milestone storytelling.
Installation
npm install @input-kit/timelineFeatures
- Vertical and horizontal timelines
- Left, right, centered, and alternating layouts
- Status-aware markers for completed, current, pending, and error states
- Grouped sections and labeled separators
- Clickable items with active-state tracking
- Utilities for formatting, sorting, and grouping events
Usage
import { Timeline, type TimelineEvent } from '@input-kit/timeline';
const events: TimelineEvent[] = [
{
id: 'beta',
title: 'Private beta',
description: 'Invite pilot customers and capture feedback.',
date: '2026-04-08',
status: 'current',
},
{
id: 'launch',
title: 'Public launch',
description: 'Ship docs, onboarding, and support.',
date: '2026-04-22',
status: 'pending',
},
];
export function Example() {
return <Timeline events={events} position="alternate" />;
}Also Available
TimelineItemfor custom item compositionTimelineGroupfor collapsible grouped sectionsTimelineSeparatorfor labeled dividersuseTimelinefor event list state managementformatTimelineDate,sortEventsByDate,groupEventsByDate
Notes
- Use
position="alternate"for portfolio or launch storytelling layouts. - Use
orientation="horizontal"when the narrative should scan left-to-right. - Current items expose
aria-current="step"for assistive technology.
License
MIT © Input Kit
