vue3-timeline

前言

DEMO

翻遍github没有找到 vue3 可以使用的 timeline 组件，只找到了一个vue2的

但是看原作者(luyilin)没有升级vue3的计划，我就自己升级了一下，感谢luyilin大佬

vue2版

Env

vue >= @v3

Install

pnpm i vue3-timeline or npm i vue3-timeline or yarn add vue3-timeline

Usage

局部引入

main.ts

import 'vue3-timeline/dist/style.css'

<script lang="ts" setup>
import { Timeline, TimelineTitle, TimelineItem } from 'vue3-timeline'
</script>

全局引入

main.ts

import { plugin } from 'vue3-timeline'
import 'vue3-timeline/dist/style.css'
const app = createApp(App)
app.use(plugin)

API

<timeline> props

使用连字符的属性比使用驼峰大小写的属性更好。The discussion 解释了原因。

• theme

  时间轴组件的主题颜色，设置线和圆的颜色

  Type: string
  Default: #dbdde0
  

• background

  设置空圆和其他时间轴符号的默认背景颜色

  Type: string
  Default: #dbdde0
  

<timeline-item> / <timeline-title> props

• bg-color

  设置圆和圆的边框颜色

  Type: string
  Default: #dbdde0
  

• line-color

  只设置圆的边框颜色

  Type: string
  Default: #dbdde0
  

• hollow

  控制圆是否是空心的。

  注意：不能与bg-color一起使用，除非您希望更改空背景色

  Type: boolean
  Default: false
  

• font-color

  设置时间轴文字或者标题文字颜色。

  或者可以用className自行设置，因为内部本身是插槽

  Type: string
  Default: #37414a
  

• icon-size

  设置圆形图标大小

  slots="others".

  Type: string ('small'| 'medium'|'large')
  Default: ''
  

Slots

• others

  Don't like the circle? You can set it to a image, iconfont or anything you want.

  <timeline-item>
    <template #others>
      <img
        src="https://user-images.githubusercontent.com/12069729/36057805-80cfc3d2-0e4e-11e8-8851-6fda091ff389.png"
        class="icon-heart"
    />
    </template>
  </timeline-item>
  

License

MIT © xiaojieajie

漆黑之牙 · GitHub @xiaojieajie