注意: 我们正在升级到 Recharts v3。在此期间,如果你想开始测试 v3,请查看此处评论中的代码。我们很快会正式发布。
介绍一下图表。这是一组图表组件,你可以将其复制并粘贴到你的应用中。
图表开箱即用,外观精美。它们与其他组件配合良好,并且可以完全自定义,以适应你的项目。
组件#
我们在底层使用 Recharts。
我们在设计 chart 组件时考虑了组合性。你可以使用 Recharts 组件构建图表,并且仅在需要时、需要的位置引入自定义组件,例如 ChartTooltip。
import { Bar, BarChart } from "recharts"
import { ChartContainer, ChartTooltipContent } from "@/components/ui/chart"
export function MyChart() {
return (
<ChartContainer>
<BarChart data={data}>
<Bar dataKey="value" />
<ChartTooltip content={<ChartTooltipContent />} />
</BarChart>
</ChartContainer>
)
}我们不会对 Recharts 进行封装。这意味着你不会被锁定在某种抽象之中。当 Recharts 发布新版本时,你可以遵循官方的升级路径来升级你的图表。
这些组件属于你。
安装#
pnpm dlx shadcn@latest add chart
你的第一个图表#
让我们构建你的第一个图表。我们将构建一个柱状图,并添加网格、坐标轴、工具提示和图例。
首先定义你的数据
以下数据表示每个月的桌面端和移动端用户数量。
注意: 你的数据可以是任意形状。你不受限于以下数据的形状。使用 dataKey 属性将你的数据映射到图表。
const chartData = [
{ month: "January", desktop: 186, mobile: 80 },
{ month: "February", desktop: 305, mobile: 200 },
{ month: "March", desktop: 237, mobile: 120 },
{ month: "April", desktop: 73, mobile: 190 },
{ month: "May", desktop: 209, mobile: 130 },
{ month: "June", desktop: 214, mobile: 140 },
]定义你的图表配置
图表配置包含图表的配置项。你可以在这里放置人类可读的字符串,例如用于主题设置的标签、图标和颜色令牌。
import { type ChartConfig } from "@/components/ui/chart"
const chartConfig = {
desktop: {
label: "Desktop",
color: "#2563eb",
},
mobile: {
label: "Mobile",
color: "#60a5fa",
},
} satisfies ChartConfig构建你的图表
现在你可以使用 Recharts 组件来构建图表。
重要: 记得在 ChartContainer 组件上设置 min-h-[VALUE]。这是使图表具有响应式的必要条件。
"use client"
import { Bar, BarChart } from "recharts"添加网格#
让我们为图表添加网格。
导入 CartesianGrid 组件。
import { Bar, BarChart, CartesianGrid } from "recharts"将 CartesianGrid 组件添加到图表中。
<ChartContainer config={chartConfig} className="min-h-[200px] w-full">
<BarChart accessibilityLayer data={chartData}>
<CartesianGrid vertical={false} />
<Bar dataKey="desktop" fill="var(--color-desktop)" radius={4} />
<Bar dataKey="mobile" fill="var(--color-mobile)" radius={4} />
</BarChart>
</ChartContainer>"use client"
import { Bar, BarChart, CartesianGrid } from "recharts"添加坐标轴#
要为图表添加 x 轴,我们将使用 XAxis 组件。
导入 XAxis 组件。
import { Bar, BarChart, CartesianGrid, XAxis } from "recharts"将 XAxis 组件添加到图表中。
<ChartContainer config={chartConfig} className="h-[200px] w-full">
<BarChart accessibilityLayer data={chartData}>
<CartesianGrid vertical={false} />
<XAxis
dataKey="month"
tickLine={false}
tickMargin={10}
axisLine={false}
tickFormatter={(value) => value.slice(0, 3)}
/>
<Bar dataKey="desktop" fill="var(--color-desktop)" radius={4} />
<Bar dataKey="mobile" fill="var(--color-mobile)" radius={4} />
</BarChart>
</ChartContainer>"use client"
import { Bar, BarChart, CartesianGrid, XAxis } from "recharts"添加工具提示#
到目前为止,我们只使用了 Recharts 中的组件。由于 chart 组件中进行了一些自定义,它们开箱即用就非常美观。
要添加工具提示,我们将使用 chart 中的自定义 ChartTooltip 和 ChartTooltipContent 组件。
导入 ChartTooltip 和 ChartTooltipContent 组件。
import { ChartTooltip, ChartTooltipContent } from "@/components/ui/chart"将这些组件添加到图表中。
<ChartContainer config={chartConfig} className="h-[200px] w-full">
<BarChart accessibilityLayer data={chartData}>
<CartesianGrid vertical={false} />
<XAxis
dataKey="month"
tickLine={false}
tickMargin={10}
axisLine={false}
tickFormatter={(value) => value.slice(0, 3)}
/>
<ChartTooltip content={<ChartTooltipContent />} />
<Bar dataKey="desktop" fill="var(--color-desktop)" radius={4} />
<Bar dataKey="mobile" fill="var(--color-mobile)" radius={4} />
</BarChart>
</ChartContainer>"use client"
import { Bar, BarChart, CartesianGrid, XAxis } from "recharts"将鼠标悬停即可查看工具提示。很简单,对吧?只需两个组件,我们就得到了一个漂亮的工具提示。
添加图例#
图例也采用同样的方式。我们将使用 chart 中的 ChartLegend 和 ChartLegendContent 组件。
导入 ChartLegend 和 ChartLegendContent 组件。
import { ChartLegend, ChartLegendContent } from "@/components/ui/chart"将这些组件添加到图表中。
<ChartContainer config={chartConfig} className="h-[200px] w-full">
<BarChart accessibilityLayer data={chartData}>
<CartesianGrid vertical={false} />
<XAxis
dataKey="month"
tickLine={false}
tickMargin={10}
axisLine={false}
tickFormatter={(value) => value.slice(0, 3)}
/>
<ChartTooltip content={<ChartTooltipContent />} />
<ChartLegend content={<ChartLegendContent />} />
<Bar dataKey="desktop" fill="var(--color-desktop)" radius={4} />
<Bar dataKey="mobile" fill="var(--color-mobile)" radius={4} />
</BarChart>
</ChartContainer>"use client"
import { Bar, BarChart, CartesianGrid, XAxis } from "recharts"完成。你已经构建了自己的第一个图表!接下来是什么?
图表配置#
图表配置用于定义图表的标签、图标和颜色。
它与图表数据刻意解耦。
这样可以在多个图表之间共享配置和颜色令牌。对于数据或颜色令牌存储在远程位置或采用不同格式的情况,它也可以独立工作。
import { Monitor } from "lucide-react"
import { type ChartConfig } from "@/components/ui/chart"
const chartConfig = {
desktop: {
label: "Desktop",
icon: Monitor,
// 类似 'hsl(220, 98%, 61%)' 或 'var(--color-name)' 的颜色
color: "#2563eb",
// 或者使用包含 'light' 和 'dark' 键的主题对象
theme: {
light: "#2563eb",
dark: "#dc2626",
},
},
} satisfies ChartConfig主题#
图表内置了主题支持。你可以使用 CSS 变量(推荐),也可以使用任意颜色格式的颜色值,例如 hex、hsl 或 oklch。
CSS 变量#
在 CSS 文件中定义颜色
@layer base {
:root {
--chart-1: oklch(0.646 0.222 41.116);
--chart-2: oklch(0.6 0.118 184.704);
}
.dark: {
--chart-1: oklch(0.488 0.243 264.376);
--chart-2: oklch(0.696 0.17 162.48);
}
}将颜色添加到你的 chartConfig 中
const chartConfig = {
desktop: {
label: "Desktop",
color: "var(--chart-1)",
},
mobile: {
label: "Mobile",
color: "var(--chart-2)",
},
} satisfies ChartConfighex、hsl 或 oklch#
你也可以直接在图表配置中定义颜色。使用你偏好的颜色格式。
const chartConfig = {
desktop: {
label: "Desktop",
color: "#2563eb",
},
mobile: {
label: "Mobile",
color: "hsl(220, 98%, 61%)",
},
tablet: {
label: "Tablet",
color: "oklch(0.5 0.2 240)",
},
laptop: {
label: "Laptop",
color: "var(--chart-2)",
},
} satisfies ChartConfig使用颜色#
要在图表中使用主题颜色,请使用 var(--color-KEY) 格式引用颜色。
组件#
<Bar dataKey="desktop" fill="var(--color-desktop)" />图表数据#
const chartData = [
{ browser: "chrome", visitors: 275, fill: "var(--color-chrome)" },
{ browser: "safari", visitors: 200, fill: "var(--color-safari)" },
]Tailwind#
<LabelList className="fill-[--color-desktop]" />工具提示#
图表工具提示包含标签、名称、指示器和值。你可以组合使用这些内容来自定义工具提示。
你可以使用 hideLabel、hideIndicator 属性开启或关闭其中任意内容,并使用 indicator 属性自定义指示器样式。
使用 labelKey 和 nameKey 为工具提示标签和名称使用自定义键。
图表提供了 <ChartTooltip> 和 <ChartTooltipContent> 组件。你可以使用这两个组件为图表添加自定义工具提示。
import { ChartTooltip, ChartTooltipContent } from "@/components/ui/chart"<ChartTooltip content={<ChartTooltipContent />} />属性#
使用以下属性自定义工具提示。
| 属性 | 类型 | 描述 |
|---|---|---|
labelKey | string | 用于标签的配置键或数据键。 |
nameKey | string | 用于名称的配置键或数据键。 |
indicator | dot line 或 dashed | 工具提示的指示器样式。 |
hideLabel | boolean | 是否隐藏标签。 |
hideIndicator | boolean | 是否隐藏指示器。 |
颜色#
颜色会自动从图表配置中引用。
自定义#
要为工具提示标签和名称使用自定义键,请使用 labelKey 和 nameKey 属性。
const chartData = [
{ browser: "chrome", visitors: 187, fill: "var(--color-chrome)" },
{ browser: "safari", visitors: 200, fill: "var(--color-safari)" },
]
const chartConfig = {
visitors: {
label: "Total Visitors",
},
chrome: {
label: "Chrome",
color: "var(--chart-1)",
},
safari: {
label: "Safari",
color: "var(--chart-2)",
},
} satisfies ChartConfig<ChartTooltip
content={<ChartTooltipContent labelKey="visitors" nameKey="browser" />}
/>这将使用 Total Visitors 作为标签,并使用 Chrome 和 Safari 作为工具提示名称。
图例#
你可以使用自定义的 <ChartLegend> 和 <ChartLegendContent> 组件为图表添加图例。
import { ChartLegend, ChartLegendContent } from "@/components/ui/chart"<ChartLegend content={<ChartLegendContent />} />颜色#
颜色会自动从图表配置中引用。
自定义#
要为图例名称使用自定义键,请使用 nameKey 属性。
const chartData = [
{ browser: "chrome", visitors: 187, fill: "var(--color-chrome)" },
{ browser: "safari", visitors: 200, fill: "var(--color-safari)" },
]
const chartConfig = {
chrome: {
label: "Chrome",
color: "var(--chart-1)",
},
safari: {
label: "Safari",
color: "var(--chart-2)",
},
} satisfies ChartConfig<ChartLegend content={<ChartLegendContent nameKey="browser" />} />这将使用 Chrome 和 Safari 作为图例名称。
无障碍访问#
你可以启用 accessibilityLayer 属性,为图表添加无障碍访问层。
此属性为图表添加键盘访问和屏幕阅读器支持。
<LineChart accessibilityLayer />RTL#
要在 shadcn/ui 中启用 RTL 支持,请参阅 RTL 配置指南。
"use client"
import { Bar, BarChart, CartesianGrid, XAxis } from "recharts"