Donut Chart
通过圆环、可选择图例和中心数值比较整体中的各部分。
适用场景
- 当界面需要以下行为时使用 Donut Chart:通过圆环、可选择图例和中心数值比较整体中的各部分。
安装
选择安装方式,用法示例将同步更新导入路径。
$ bunx --bun shadcn-vue@2.8.2 add https://orvui.efu.me/r/donut-chart.json
首次使用时,将安装的 src/components/orvui/styles.css 导入项目样式入口。
示例
预览
$115,150
Monthly revenue
Select a plan to filter
packages/vue/src/charts/donut-chart/demo.vue
<script setup lang="ts">
import { computed, ref } from "vue";
import {
DonutChart,
DonutChartCenter,
DonutChartLegend,
DonutChartPlot,
type DonutSegment,
} from "@/components/orvui/charts/donut-chart";
const plans: DonutSegment[] = [
{ id: "team", name: "Team", value: 42900, color: "#2563eb" },
{ id: "business", name: "Business", value: 31250, color: "#38bdf8" },
{ id: "enterprise", name: "Enterprise", value: 22600, color: "#0d9488" },
{ id: "starter", name: "Starter", value: 18400, color: "#fbbf24" },
];
const selected = ref<string | null>(null);
const message = computed(() =>
selected.value
? `Filtering by ${plans.find((plan) => plan.id === selected.value)?.name}`
: "Select a plan to filter",
);
const currency = new Intl.NumberFormat("en-US", {
style: "currency",
currency: "USD",
maximumFractionDigits: 0,
});
const formatValue = (value: number) => currency.format(value);
function select(id: string) {
selected.value = id === selected.value ? null : id;
}
</script>
<template>
<div class="w-full max-w-xl space-y-3">
<DonutChart
:segments="plans"
:format-value="formatValue"
:selected-id="selected"
label="Monthly revenue by plan"
@select="select"
>
<div class="grid items-center gap-6 sm:grid-cols-[minmax(0,15rem)_1fr]">
<DonutChartPlot
><DonutChartCenter total-label="Monthly revenue"
/></DonutChartPlot>
<DonutChartLegend />
</div>
</DonutChart>
<p aria-live="polite" class="px-1 text-xs text-muted-foreground">
{{ message }}
</p>
</div>
</template>
packages/vue/src/charts/donut-chart/src/DonutChart.vue
状态与事件
需要由表单、路由或父组件管理时,绑定下列状态并接收对应更新。v-model 是属性与 update 事件的简写;值的类型应与 API 一致。
| 组件 | Vue 绑定 | 更新事件 |
|---|---|---|
DonutChart | v-model:activeIdnull | string | update:activeId |
可选受控属性未传入时,按组件文档的默认行为工作;不要用固定的 false 或空值代替未传入。异步请求和持久化在应用中处理,再把结果传回组件。
API 参考
DonutChart
segmentsreadonly DonutSegment[]—thickness?number22gap?number3activeId?null | string—defaultActiveId?null | stringnullselectedId?null | stringnullformatValue?(value: number) => stringformatNumberlabel?string"Donut chart"className?string—事件
update:activeId—@update:activeIdactiveChange—@activeChangeselect—@select插槽
default() => VNodeChild#defaultDonutChartCenter
totalLabel?string"Total"插槽
default—作用域参数: segment, total
#defaultDonutChartLegend
插槽
value—作用域参数: segment
#valuedetail—作用域参数: segment
#detailDonutChartPlot
插槽
default() => VNodeChild#default无障碍
为交互控件提供明确的无障碍名称。保留文档中的键盘路径、可见焦点与减少动态效果状态;自定义插槽应继续保留所替代部件的语义。
常见问题
- 如何配置 Donut Chart?
- 通过 segments、thickness、gap、activeId、defaultActiveId、selectedId、formatValue、label、className 配置 Donut Chart;API 表列出其类型与默认值。
- 如何连接到应用状态?
- 监听 update:activeId、activeChange、select,将组件连接到应用状态。
- 可以在服务端渲染吗?
- 可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。
更新于
来源与许可 ↗MIT · 0.1.1