@composy/timeline-core
v0.0.1
Published
Timeline core - Canvas/SVG rendering, layout, animation, interaction
Maintainers
Readme
@composy/timeline-core
@composy/timeline-core 是时间轴的框架无关核心包,负责事件模型、布局计算、Canvas/SVG 渲染、缩放平移、选择、主题、导出和插件能力。
安装
pnpm add @composy/timeline-core基础用法
import { createTimeline, type TimelineEvent } from '@composy/timeline-core'
const events: TimelineEvent[] = [
{
id: 'plan',
title: '计划',
date: '2026-01-01',
description: '项目计划完成',
color: 'var(--ld-primary-600)',
},
{
id: 'release',
title: '发布',
timestamp: 1773532800000,
color: 'var(--ld-success-600)',
},
]
const timeline = createTimeline({
container: document.querySelector('#timeline') as HTMLElement,
events,
renderType: 'canvas',
orientation: 'horizontal',
width: 900,
height: 420,
})
timeline.zoomIn()
timeline.centerOn('release')
timeline.download('timeline.png', 'png')事件数据
TimelineEvent 支持面向用户的日期别名,也兼容时间戳字段:
import type { TimelineEvent } from '@composy/timeline-core'
const event: TimelineEvent = {
id: 'range',
title: '范围事件',
date: '2026-01-01',
endDate: '2026-01-10',
group: 'milestone',
data: {
owner: 'team-a',
},
}常用字段:
date/timestamp:事件开始时间,支持Date | string | number。endDate/endTime:范围事件结束时间。group/groupId:事件分组。color:推荐使用var(--ld-*)或var(--color-*)。data:业务扩展数据,类型为Record<string, unknown>。
核心 API
createTimeline(config):创建时间轴实例。generateTimeline(container, config):在指定容器中创建时间轴实例。addEvent(event)/removeEvent(id)/updateEvent(id, event):事件增删改。getEvents()/getEvent(id)/searchEvents(query):事件查询。zoomIn()/zoomOut()/setZoom(level)/fit():视图缩放。panTo(x, y)/centerOn(eventId):平移与定位。setSelection(ids)/getSelection()/clearSelection():选择管理。setTheme(name)/registerTheme(theme):主题管理。toDataURL()/toSVGString()/export()/download():导出能力。on(event, handler):订阅事件,返回取消订阅函数。
主题与 token
内置主题为 light、dark、minimal、colorful。默认主题值全部使用 LDesign CSS 变量:
- 颜色使用
--ld-*,并兼容--color-*。 - 尺寸应由消费方容器或 Vue 适配层通过
--size-*控制。 - Canvas/SVG 渲染前会把 CSS 变量解析为实际颜色,避免
var(...)直接写入 Canvas 导致绘制失败。
DOM class
core 内置 SVG 和 Canvas tooltip 只输出 ldesign-timeline 命名空间 class:
.ldesign-timeline__tooltip.ldesign-timeline__main.ldesign-timeline__grid.ldesign-timeline__grid-line.ldesign-timeline__scale.ldesign-timeline__scale-label.ldesign-timeline__today.ldesign-timeline__event.ldesign-timeline__event--highlighted
构建产物
pnpm -C libraries/timeline/packages/core run type-check
pnpm -C libraries/timeline/packages/core run build构建完成后会生成:
dist/index.js
dist/index.min.js
es/index.js
esm/index.js
lib/index.cjsLicense
MIT
