ui/docs/content/3.components/timeline.md

title, description, category, links, navigation.badge

title	description	category	links	navigation.badge
Timeline	A component that displays a sequence of events with dates, titles, icons or avatars.	data	label icon to GitHub i-simple-icons-github https://github.com/nuxt/ui/tree/v3/src/runtime/components/Timeline.vue	Soon

Usage

Items

Use the items prop as an array of objects with the following properties:

• date?: string{lang="ts-type"}
• title?: string{lang="ts-type"}
• description?: AvatarProps{lang="ts-type"}
• icon?: string{lang="ts-type"}
• avatar?: AvatarProps{lang="ts-type"}
• value?: string | number{lang="ts-type"}
• slot?: string{lang="ts-type"}
• class?: any{lang="ts-type"}
• ui?: { item?: ClassNameValue, container?: ClassNameValue, indicator?: ClassNameValue, separator?: ClassNameValue, wrapper?: ClassNameValue, separator?: ClassNameValue, date?: ClassNameValue, title?: ClassNameValue, description?: ClassNameValue }{lang="ts-type"}

::component-code

ignore:

• items
• class
• defaultValue external:
• items externalTypes:
• TimelineItem[] props: defaultValue: 2 items:
  • date: 'Mar 15, 2025' title: 'Project Kickoff' description: 'Kicked off the project with team alignment. Set up project milestones and allocated resources.' icon: 'i-lucide-rocket'
  • date: 'Mar 22 2025' title: 'Design Phase' description: 'User research and design workshops. Created wireframes and prototypes for user testing.' icon: 'i-lucide-palette'
  • date: 'Mar 29 2025' title: 'Development Sprint' description: 'Frontend and backend development. Implemented core features and integrated with APIs.' icon: 'i-lucide-code'
  • date: 'Apr 5 2025' title: 'Testing & Deployment' description: 'QA testing and performance optimization. Deployed the application to production.' icon: 'i-lucide-check-circle' class: 'w-96'

---

::

Color

Use the color prop to change the color of the active items in a Timeline.

::component-code

ignore:

• items
• class
• defaultValue external:
• items externalTypes:
• TimelineItem[] props: color: neutral defaultValue: 2 items:
  • date: 'Mar 15, 2025' title: 'Project Kickoff' description: 'Kicked off the project with team alignment. Set up project milestones and allocated resources.' icon: 'i-lucide-rocket'
  • date: 'Mar 22 2025' title: 'Design Phase' description: 'User research and design workshops. Created wireframes and prototypes for user testing.' icon: 'i-lucide-palette'
  • date: 'Mar 29 2025' title: 'Development Sprint' description: 'Frontend and backend development. Implemented core features and integrated with APIs.' icon: 'i-lucide-code'
  • date: 'Apr 5 2025' title: 'Testing & Deployment' description: 'QA testing and performance optimization. Deployed the application to production.' icon: 'i-lucide-check-circle' class: 'w-96'

---

::

Size

Use the size prop to change the size of the Timeline.

::component-code

ignore:

• items
• class
• defaultValue external:
• items externalTypes:
• TimelineItem[] props: size: xs defaultValue: 2 items:
  • date: 'Mar 15, 2025' title: 'Project Kickoff' description: 'Kicked off the project with team alignment. Set up project milestones and allocated resources.' icon: 'i-lucide-rocket'
  • date: 'Mar 22 2025' title: 'Design Phase' description: 'User research and design workshops. Created wireframes and prototypes for user testing.' icon: 'i-lucide-palette'
  • date: 'Mar 29 2025' title: 'Development Sprint' description: 'Frontend and backend development. Implemented core features and integrated with APIs.' icon: 'i-lucide-code'
  • date: 'Apr 5 2025' title: 'Testing & Deployment' description: 'QA testing and performance optimization. Deployed the application to production.' icon: 'i-lucide-check-circle' class: 'w-96'

---

::

Orientation

Use the orientation prop to change the orientation of the Timeline. Defaults to vertical.

::component-code

ignore:

• items
• class
• defaultValue external:
• items externalTypes:
• TimelineItem[] props: orientation: 'horizontal' defaultValue: 2 items:
  • date: 'Mar 15, 2025' title: 'Project Kickoff' description: 'Kicked off the project with team alignment.' icon: 'i-lucide-rocket'
  • date: 'Mar 22 2025' title: 'Design Phase' description: 'User research and design workshops.' icon: 'i-lucide-palette'
  • date: 'Mar 29 2025' title: 'Development Sprint' description: 'Frontend and backend development.' icon: 'i-lucide-code'
  • date: 'Apr 5 2025' title: 'Testing & Deployment' description: 'QA testing and performance optimization.' icon: 'i-lucide-check-circle' class: 'w-full'

---

::

Examples

Control active item

You can control the active item by using the default-value prop or the v-model directive with the index of the item.

:component-example{name="timeline-model-value-example" prettier}

::tip You can also pass the value of one of the items if provided. ::

With alternating layout

Use the ui prop to create a Timeline with alternating layout.

:component-example{name="timeline-alternating-layout-example" prettier}

With custom slot

Use the slot property to customize a specific item.

You will have access to the following slots:

• #{{ item.slot }}-indicator{lang="ts-type"}
• #{{ item.slot }}-date{lang="ts-type"}
• #{{ item.slot }}-title{lang="ts-type"}
• #{{ item.slot }}-description{lang="ts-type"}

:component-example{name="timeline-custom-slot-example" prettier}

With slots

Use the available slots to create a more complex Timeline.

:component-example{name="timeline-slots-example" prettier}

API

Props

:component-props

Slots

:component-slots

Emits

:component-emits

Theme

:component-theme