Back to Vuetify

Timelines

packages/docs/src/pages/en/components/timelines.md

4.0.62.6 KB
Original Source

Timelines

The v-timeline is useful for stylistically displaying chronological information.

<PageFeatures /> <!-- ## Usage `v-timeline`s in their simplest form display a vertical timeline that should contain at least one `v-timeline-item`. <ExamplesExample file="v-timeline/usage" /> --> <PromotedEntry />

API

ComponentDescription
v-timelinePrimary Component
v-timeline-itemSub-component used to display a single timeline item
<ApiInline hide-links /> <!-- ## Sub-components ### v-timeline-item v-timeline-item description -->

Examples

Props

Direction

Switch between a horizontal and vertical timeline in real-time using the direction prop.

<ExamplesExample file="v-timeline/prop-direction" />

Side

Use the side property to force all items to one side of the timeline.

<ExamplesExample file="v-timeline/prop-single-side" />

Alignment

By default, v-timeline-item content is vertically aligned center. The align prop also supports top alignment.

<ExamplesExample file="v-timeline/prop-align" />

Dot color

Colored dots create visual breakpoints that make your timelines easier for users to read.

<ExamplesExample file="v-timeline/prop-color" />

Icon dots

Use icons within the v-timeline-item dot to provide additional context.

<ExamplesExample file="v-timeline/prop-icon-dots" /> <!-- #### Mirror You can mirror the placement of the timeline items by using the **mirror** prop. <ExamplesExample file="v-timeline/prop-mirror" /> -->

Size

The size prop allows you to customize the size of each dot.

<ExamplesExample file="v-timeline/prop-size" />

Truncated line

Truncate the start, end or both ends of the timeline center line by using the truncate-line prop.

<ExamplesExample file="v-timeline/prop-truncate-line" />

Line inset

Modify the inset of dividing lines by specifying a custom amount using the line-inset prop.

<ExamplesExample file="v-timeline/prop-line-inset" />

Slots

Icon

Insert avatars into dots with use of the icon slot and v-avatar.

<ExamplesExample file="v-timeline/slot-icon" />

Opposite

The opposite slot provides an additional layer of customization within your timelines.

<ExamplesExample file="v-timeline/slot-opposite" /> <!-- #### Timeline item default If you place a `v-card` inside of a `v-timeline-item`, a caret will appear on the side of the card. <ExamplesExample file="v-timeline/slot-timeline-item-default" /> -->

Misc

Advanced

<ExamplesExample file="v-timeline/misc-advanced" />