组件/VersionCapsule 版本胶囊

VersionCapsule 版本胶囊

左半下载构建、右半打开历史的分段版本胶囊

Verified自 0.3.9

用法

下载与历史

download 与 history 插槽分别放入两个面板;插槽参数 close 关闭面板并交还焦点。

Loading demo...

通道色调

tone 决定状态点与通道颜色。

Loading demo...

最佳实践

  • 始终标注通道(BETA、STABLE、NIGHTLY),不要写「LATEST」;胶囊配合页面的稳定版下载按钮,而不是取代它。
  • 预发布注意事项放进下载面板的 notice(warning);已认证构建用 success。
  • 给构建设置 href,直接以 <a download> 下载;只有需要在 select 时解析地址才省略。
  • 只把访客平台的构建标为 recommended。
  • 让每个历史条目的 tone 与其通道一致;note 只用于 latest。

API 参考

TxVersionCapsule

属性

属性名类型默认值说明
versionstring— (必填)标题位置的版本号,如 v2.4.13-beta.19。
channelstring-状态点旁的通道标签,如 BETA;不设置则不显示。
toneTxVersionChannelTone'preview'状态点与通道标签的颜色。
historyLabelstring'History'右侧分段的文案。
downloadLabelstring'Download this build'左侧分段的无障碍名称。
panelTxVersionCapsulePanel-受控的打开面板,配合 v-model:panel;省略即非受控。
disabledbooleanfalse禁用两个分段,并关闭已打开的面板。
closeOnClickOutsidebooleantrue外部 pointerdown 时关闭面板。
closeOnEscbooleantrue按 Escape 关闭面板。

事件

事件名参数说明
update:panel(value: TxVersionCapsulePanel)打开的面板变化时触发。
download-激活左侧分段时触发。
history-激活右侧分段时触发。

插槽

插槽参数说明
download{ close: () => void }下载面板内容,锚定在左侧分段下方。
history{ close: () => void }历史面板内容,锚定在右侧分段下方。

暴露方法

成员类型说明
close() => void关闭面板并把焦点交还给对应分段;也传给两个插槽。
downloadRefRef<HTMLButtonElement | null>左侧分段的按钮元素。
historyRefRef<HTMLButtonElement | null>右侧分段的按钮元素。

TxVersionDownloadPanel

属性

属性名类型默认值说明
noticeTxVersionNotice-构建列表上方的信任提示;省略则只显示列表。
buildsTxVersionBuild[][]各平台的构建。
buildsLabelstring'Choose a build'构建列表上方的小标题。
downloadLabelstring'Download'推荐构建按钮上的文案。
emptyTextstring'No builds published yet.'builds 为空时显示。

事件

事件名参数说明
select(id: string)选择构建时触发,参数为其 id。

插槽

插槽参数说明
footer-构建列表下方的页脚。

TxVersionHistoryPanel

属性

属性名类型默认值说明
titlestring'Version history'面板标题。
latestTxVersionHistoryEntry-列表上方的精选卡片。
entriesTxVersionHistoryEntry[][]精选卡片下方的历史行。
latestLabelstring'LATEST'精选卡片上的徽标。
countLabelstring-头部右侧文案,如 6 releases。
notesLabelstring"What's new"精选卡片上的行动文案。
emptyTextstring'No releases published yet.'既无 latest 也无 entries 时显示。

事件

事件名参数说明
select(entry: TxVersionHistoryEntry)选择历史行或精选卡片时触发。

插槽

插槽参数说明
footer-历史列表下方的页脚。

类型

TxVersionChannelTone 为 'stable' \| 'preview' \| 'nightly' \| 'neutral',分别对应 success / primary(默认) / warning / secondary 颜色。

TxVersionBuild

字段类型说明
idstring列表 key。
namestring标题,如 macOS · Apple 芯片。
metastring?次要行,如 .dmg · 126 MB。
hrefstring?直链;存在时渲染为 <a download>,否则为 <button>。
recommendedboolean?访客平台的构建;只有第一个高亮并获得带文案的按钮。
iconstring?名称前的图标 class,图标集由使用方提供。

TxVersionNotice

字段类型说明
tone'warning' | 'success'warning(默认)用于预发布,success 用于已认证构建。
titlestring提示标题。
descriptionstring?补充说明。
pointsstring[]?要点列表。

TxVersionHistoryEntry

字段类型说明
idstring列表 key。
tagstring版本号。
channelstring?通道标签,如 BETA。
toneTxVersionChannelTone?该条目的色调,默认 preview。
datestring?发布日期文案。
notestring?单行更新摘要,只在 latest 上渲染。
hrefstring?存在时行或卡片渲染为链接。

概述

  • 两个分段是独立的点击目标:左半下载构建,右半打开历史。不要把整个胶囊包成一个动作。
  • 同一时刻只打开一个面板;点另一分段切换面板,再点当前分段关闭。
  • 面板锚定在各自分段下方(下载左对齐、历史右对齐),不是模态。
  • panel 为 undefined 时非受控;null 是受控的「全部关闭」。
  • 不提供某个插槽时,对应分段只派发事件、不弹出面板,适合宿主自带弹窗。

技术实现

  • 源码:packages/tuffex/packages/components/src/version-capsule/。
查看源码
packages/tuffex/packages/components/src/version-capsule/index.ts