Timeline
Installation
npx shadcn@latest add https://ui.timkit.cn/r/timeline.json
Usage
import { Timeline } from "@/components/ui/timeline"
Examples
Timeline · Project timeline
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Timeline with dates
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Timeline with content
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Detailed timeline
Loading preview...
Structured API
Component
timeline
Logic
none
Runtime Frameworks
ReactVueWeappHTML
Supported Platforms
WebWeChat Mini Program
Configuration
| Prop | Type | Default | Description |
|---|---|---|---|
| logic.provider* | enum (zag | native | none) | none | State and interaction provider used by this component. |
| logic.machine | string | - | Underlying state machine identifier when provider is zag. |
| platforms* | array | Web, WeChat Mini Program | Platforms officially supported by this schema. |
| frameworks* | array | React, Vue, Weapp, HTML | Framework demos/code currently available in registry files. |
| dependencies | array | @timui/core | Runtime package dependencies required by this registry item. |
| optionalPeerDependencies | array | - | Optional peer dependencies used by this registry item. |
| registryDependencies | array | - | Dependent Timkit registry components/hook entries. |
Props
| Prop | Type | Default | Description |
|---|---|---|---|
| value | number | - | The active step in the timeline. |
| defaultValue | number | 1 | The initial active step. |
| orientation | enum (horizontal | vertical) | vertical | The orientation of the timeline. |
Events
| Prop | Type | Default | Description |
|---|---|---|---|
| onValueChange | event | - | Event handler called when active step changes. |
Slots
| Prop | Type | Default | Description |
|---|---|---|---|
| default | slot | - | The timeline items |
Parts
| Prop | Type | Default | Description |
|---|---|---|---|
| root* | root | - | The timeline container |
| item | part | - | A single event item |
| indicator | part | - | The dot indicator |
| separator | part | - | The line between items |
| content | part | - | The event details |
| title | part | - | The event title |
| date | part | - | The event date |
This API reference is generated from `/packages/core` component schemas to keep React/Vue/Weapp docs consistent.
Extended notes are not available for this component yet.
On This Page
- Installation
- Usage
- Examples
- Timeline · Project timeline
- Timeline · Detailed timeline
- Timeline · Detailed timeline
- Timeline · Detailed timeline
- Timeline · Detailed timeline
- Timeline · Detailed timeline
- Timeline · Detailed timeline
- Timeline · Timeline with dates
- Timeline · Detailed timeline
- Timeline · Timeline with content
- Timeline · Detailed timeline
- Timeline · Detailed timeline
- API Reference
Timeline
Installation
npx shadcn@latest add https://ui.timkit.cn/r/timeline.json
Usage
import { Timeline } from "@/components/ui/timeline"
Examples
Timeline · Project timeline
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Timeline with dates
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Timeline with content
Loading preview...
Timeline · Detailed timeline
Loading preview...
Timeline · Detailed timeline
Loading preview...
Structured API
Component
timeline
Logic
none
Runtime Frameworks
ReactVueWeappHTML
Supported Platforms
WebWeChat Mini Program
Configuration
| Prop | Type | Default | Description |
|---|---|---|---|
| logic.provider* | enum (zag | native | none) | none | State and interaction provider used by this component. |
| logic.machine | string | - | Underlying state machine identifier when provider is zag. |
| platforms* | array | Web, WeChat Mini Program | Platforms officially supported by this schema. |
| frameworks* | array | React, Vue, Weapp, HTML | Framework demos/code currently available in registry files. |
| dependencies | array | @timui/core | Runtime package dependencies required by this registry item. |
| optionalPeerDependencies | array | - | Optional peer dependencies used by this registry item. |
| registryDependencies | array | - | Dependent Timkit registry components/hook entries. |
Props
| Prop | Type | Default | Description |
|---|---|---|---|
| value | number | - | The active step in the timeline. |
| defaultValue | number | 1 | The initial active step. |
| orientation | enum (horizontal | vertical) | vertical | The orientation of the timeline. |
Events
| Prop | Type | Default | Description |
|---|---|---|---|
| onValueChange | event | - | Event handler called when active step changes. |
Slots
| Prop | Type | Default | Description |
|---|---|---|---|
| default | slot | - | The timeline items |
Parts
| Prop | Type | Default | Description |
|---|---|---|---|
| root* | root | - | The timeline container |
| item | part | - | A single event item |
| indicator | part | - | The dot indicator |
| separator | part | - | The line between items |
| content | part | - | The event details |
| title | part | - | The event title |
| date | part | - | The event date |
This API reference is generated from `/packages/core` component schemas to keep React/Vue/Weapp docs consistent.
Extended notes are not available for this component yet.
On This Page
- Installation
- Usage
- Examples
- Timeline · Project timeline
- Timeline · Detailed timeline
- Timeline · Detailed timeline
- Timeline · Detailed timeline
- Timeline · Detailed timeline
- Timeline · Detailed timeline
- Timeline · Detailed timeline
- Timeline · Timeline with dates
- Timeline · Detailed timeline
- Timeline · Timeline with content
- Timeline · Detailed timeline
- Timeline · Detailed timeline
- API Reference