@sit-onyx/chartjs-plugin 0.0.0

package/LICENSE.txt

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2023 Schwarz IT KG
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,17 @@
+<div align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/SchwarzIT/onyx/main/.github/onyx-logo-light.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/SchwarzIT/onyx/main/.github/onyx-logo-dark.svg">
+    <img alt="onyx logo" src="https://raw.githubusercontent.com/SchwarzIT/onyx/main/.github/onyx-logo-dark.svg" width="160px">
+  </picture>
+</div>
+
+<br>
+
+# @sit-onyx/chartjs-plugin
+
+A Chart.js plugin for the onyx design system created by [Schwarz IT](https://it.schwarz).
+
+## Documentation
+
+You can find our documentation [here](https://onyx.schwarz/development/packages/chartjs-plugin.html).

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@sit-onyx/chartjs-plugin",
+  "description": "A Chart.js plugin for the onyx design system created by Schwarz IT",
+  "version": "0.0.0",
+  "type": "module",
+  "author": "Schwarz IT KG",
+  "license": "Apache-2.0",
+  "files": [
+    "src"
+  ],
+  "types": "./src/index.ts",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "homepage": "https://onyx.schwarz/development/packages/chartjs-plugin.html",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SchwarzIT/onyx",
+    "directory": "packages/chartjs-plugin"
+  },
+  "bugs": {
+    "url": "https://github.com/SchwarzIT/onyx/issues"
+  },
+  "peerDependencies": {
+    "chart.js": ">= 4.0.0",
+    "sit-onyx": "^1.0.0-alpha.46"
+  },
+  "devDependencies": {
+    "vue-chartjs": "^5.3.0"
+  },
+  "scripts": {
+    "dev": "storybook dev -p 6006 --no-open",
+    "build": "vue-tsc --noEmit",
+    "test": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:components": "playwright install && playwright test"
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./plugin";
+export * from "./utils";

package/src/plugin.ts

@@ -0,0 +1,208 @@
+import {
+  Chart,
+  DoughnutController,
+  PieController,
+  PolarAreaController,
+  type ChartDataset,
+  type ChartType,
+  type Color,
+  type Plugin,
+  type ScaleOptionsByType,
+  type ScaleTypeRegistry,
+} from "chart.js";
+import { getCSSVariableValue, hexToRgb } from "./utils";
+
+/**
+ * Registers the onyx Chart.js plugin and updates the default styles (colors, fonts etc.) to match
+ * the onyx design system. Will disable Chart.js default "color" plugin to avoid conflicts.
+ *
+ * Styles will be updated accordingly if the application is switched between light/dark mode.
+ *
+ * @example
+ * ```ts
+ * import { registerOnyxPlugin } from "@sit-onyx/chartjs-plugin";
+ * import { Chart, registerables } from "chart.js";
+ *
+ * Chart.register(...registerables);
+ * registerOnyxPlugin(Chart);
+ * ```
+ */
+export const registerOnyxPlugin = (chart: typeof Chart) => {
+  chart.register(plugin);
+  chart.defaults.plugins.colors.enabled = false;
+
+  //
+  // General default styles for all chart types
+  //
+  chart.defaults.font.family = getCSSVariableValue("--onyx-font-family");
+  chart.defaults.font.size = 13;
+
+  chart.defaults.borderColor = () => getCSSVariableValue("--onyx-color-base-neutral-300");
+  chart.defaults.color = () => getCSSVariableValue("--onyx-color-text-icons-neutral-medium");
+
+  chart.defaults.plugins.tooltip.backgroundColor = () => {
+    return getCSSVariableValue("--onyx-color-base-neutral-900");
+  };
+  chart.defaults.plugins.tooltip.titleColor = () => {
+    return getCSSVariableValue("--onyx-color-text-icons-neutral-inverted");
+  };
+  chart.defaults.plugins.tooltip.bodyColor = () => {
+    return getCSSVariableValue("--onyx-color-text-icons-neutral-inverted");
+  };
+
+  chart.defaults.plugins.title.color = createColorGetter("--onyx-color-text-icons-neutral-intense");
+  chart.defaults.plugins.title.font = {
+    weight: "bold",
+    size: 16,
+  };
+
+  chart.defaults.scales.radialLinear.ticks.backdropColor = () => {
+    return getCSSVariableValue("--onyx-color-base-background-tinted");
+  };
+
+  Object.entries(chart.defaults.scales).forEach(([key, scale]) => {
+    // exclude radialLinear scale because it does not support a title
+    if (key === "radialLinear") return;
+    const typedScale = scale as ScaleOptionsByType<
+      Exclude<keyof ScaleTypeRegistry, "radialLinear">
+    >;
+
+    typedScale.title = {
+      ...typedScale.title,
+      color: createColorGetter("--onyx-color-text-icons-neutral-soft"),
+      font: {
+        size: 16,
+      },
+    };
+  });
+};
+
+const plugin: Plugin<ChartType, undefined> = {
+  id: "onyx",
+  /**
+   * We use the "beforeUpdate" hook to apply styles to the individual datasets
+   * of the chart.
+   */
+  beforeLayout: (chart) => {
+    /** Color offset / index so every dataset gets a unique color. */
+    let colorOffset = 0;
+
+    chart.config.data.datasets.forEach((dataset, index) => {
+      const controller = chart.getDatasetMeta(index).controller;
+
+      if (controller instanceof DoughnutController || controller instanceof PolarAreaController) {
+        colorizeDataset(dataset, colorOffset, true);
+        colorOffset += dataset.data.length;
+      } else if (controller) {
+        colorizeDataset(dataset, colorOffset);
+        colorOffset++;
+      }
+    });
+
+    // due to some reason the doughnut and pie charts do not use the default font size
+    // for the scale titles so we need to manually set them here
+    const controller = chart.getDatasetMeta(0).controller;
+    if (controller instanceof DoughnutController || controller instanceof PieController) {
+      Object.values(chart.config.options?.scales ?? {}).forEach((scale) => {
+        if (!scale) return;
+        const typedScale = scale as ScaleOptionsByType<
+          Exclude<keyof ScaleTypeRegistry, "radialLinear">
+        >;
+
+        typedScale.title.font = {
+          ...typedScale.title.font,
+          size: 16,
+        };
+      });
+    }
+  },
+  /**
+   * Update chart whenever the light/dark mode changes so that the colors are updated
+   */
+  afterInit: (chart) => {
+    const darkModeObserver = new MutationObserver((mutations) => {
+      const oldClasses = mutations[0].oldValue ?? "";
+      const newClasses = (mutations[0].target as HTMLElement).className;
+
+      const oldTheme = oldClasses.includes("dark") ? "dark" : "light";
+      const newTheme = newClasses.includes("dark") ? "dark" : "light";
+
+      // update chart so the colors are updated to light/dark mode
+      if (oldTheme !== newTheme) chart.update();
+    });
+
+    const observerOptions: MutationObserverInit = {
+      attributeFilter: ["class"],
+      attributeOldValue: true,
+    };
+
+    // TODO: see https://github.com/SchwarzIT/onyx/issues/618
+    // change to media query once the above ticket is implemented
+    // for example implementation see: https://css-tricks.com/working-with-javascript-media-queries/#aa-listen-for-changes
+    darkModeObserver.observe(document.body, observerOptions);
+    darkModeObserver.observe(document.documentElement, observerOptions);
+  },
+};
+
+/**
+ * Some Chart.js color properties are actually typed incorrect
+ * because they support getters but are typed as static colors.
+ * This function will create a color getter which is type casted as static "Color".
+ */
+const createColorGetter = (color: string) => {
+  const getter = () => getCSSVariableValue(color);
+  return getter as unknown as Color;
+};
+
+/**
+ * Colorizes the given dataset with colors from the onyx design system.
+ *
+ * @param dataset Dataset to colorize
+ * @param offset Offset for the colors. Useful if multiple datasets are used inside a chart which
+ * should have different colors.
+ * @param allData Set this to true for doughnut, pie and polar area chart type so every data has a separate color.
+ */
+const colorizeDataset = (dataset: ChartDataset, offset = 0, allData = false) => {
+  const borderColorizer = () => {
+    if (dataset.borderColor) return dataset.borderColor;
+    if (allData) return dataset.data.map((_, index) => getBorderColor(offset + index));
+    return getBorderColor(offset);
+  };
+
+  const backgroundColorizer = () => {
+    if (dataset.backgroundColor) return dataset.backgroundColor;
+    if (allData) return dataset.data.map((_, index) => getBackgroundColor(offset + index));
+    return getBackgroundColor(offset);
+  };
+
+  dataset.borderColor = borderColorizer();
+  dataset.backgroundColor = backgroundColorizer();
+};
+
+/**
+ * Available colors to choose from for default dataset styles.
+ */
+const COLORS = [
+  "--onyx-color-base-quantitatives-100",
+  "--onyx-color-base-quantitatives-200",
+  "--onyx-color-base-quantitatives-300",
+  "--onyx-color-base-quantitatives-400",
+  "--onyx-color-base-quantitatives-500",
+  "--onyx-color-base-quantitatives-600",
+  "--onyx-color-base-quantitatives-700",
+  "--onyx-color-base-quantitatives-800",
+  "--onyx-color-base-quantitatives-900",
+] as const;
+
+/**
+ * Gets a border color.
+ */
+const getBorderColor = (i: number) => getCSSVariableValue(COLORS[i % COLORS.length]);
+
+/**
+ * Gets a background color (same as border color + 30% transparency).
+ */
+const getBackgroundColor = (i: number) => {
+  const color = getBorderColor(i);
+  return `rgba(${hexToRgb(color)}, 0.3)`;
+};

package/src/stories/BarChart/BarChart.ct.tsx

@@ -0,0 +1,8 @@
+import { test } from "@playwright/experimental-ct-vue";
+import { executeChartScreenshotTest } from "../playwright-utils";
+import BarChart from "./BarChart.vue";
+
+test("should render bar chart", async ({ mount, page }) => {
+  const component = await mount(BarChart);
+  await executeChartScreenshotTest(page, component, "bar");
+});

package/src/stories/BarChart/BarChart.stories.ts

@@ -0,0 +1,12 @@
+import type { Meta, StoryObj } from "@storybook/vue3";
+import BarChart from "./BarChart.vue";
+
+const meta: Meta<typeof BarChart> = {
+  title: "examples/BarChart",
+  component: BarChart,
+};
+
+export default meta;
+type Story = StoryObj<typeof BarChart>;
+
+export const Default = { args: {} } satisfies Story;

package/src/stories/BarChart/BarChart.vue

@@ -0,0 +1,33 @@
+<script lang="ts" setup>
+import type { ChartData } from "chart.js";
+import { Bar } from "vue-chartjs";
+import { chartOptions } from "../data";
+
+const labels = ["01.01.2024", "01.02.2024", "01.03.2024", "01.04.2024", "01.05.2024"];
+
+const chartData: ChartData<"bar"> = {
+  labels,
+  datasets: [
+    {
+      label: "Dataset A",
+      data: [1, 8, 4, 6, 2],
+      borderWidth: 2,
+    },
+    {
+      label: "Dataset B",
+      data: [4, 2, 3, 1, 7],
+      borderWidth: 2,
+    },
+  ],
+};
+</script>
+
+<template>
+  <Bar :data="chartData" :options="chartOptions" class="chart" />
+</template>
+
+<style lang="scss" scoped>
+.chart {
+  height: 32rem;
+}
+</style>

package/src/stories/BubbleChart/BubbleChart.ct.tsx

@@ -0,0 +1,8 @@
+import { test } from "@playwright/experimental-ct-vue";
+import { executeChartScreenshotTest } from "../playwright-utils";
+import BubbleChart from "./BubbleChart.vue";
+
+test("should render bubble chart", async ({ mount, page }) => {
+  const component = await mount(BubbleChart);
+  await executeChartScreenshotTest(page, component, "bubble");
+});

package/src/stories/BubbleChart/BubbleChart.stories.ts

@@ -0,0 +1,12 @@
+import type { Meta, StoryObj } from "@storybook/vue3";
+import BubbleChart from "./BubbleChart.vue";
+
+const meta: Meta<typeof BubbleChart> = {
+  title: "examples/BubbleChart",
+  component: BubbleChart,
+};
+
+export default meta;
+type Story = StoryObj<typeof BubbleChart>;
+
+export const Default = { args: {} } satisfies Story;

package/src/stories/BubbleChart/BubbleChart.vue

@@ -0,0 +1,36 @@
+<script lang="ts" setup>
+import type { ChartData } from "chart.js";
+import { Bubble } from "vue-chartjs";
+import { chartOptions } from "../data";
+
+const chartData: ChartData<"bubble"> = {
+  datasets: [
+    {
+      label: "Dataset A",
+      data: [
+        { x: 20, y: 25, r: 5 },
+        { x: 40, y: 10, r: 10 },
+        { x: 30, y: 22, r: 30 },
+      ],
+    },
+    {
+      label: "Dataset B",
+      data: [
+        { x: 10, y: 30, r: 15 },
+        { x: 20, y: 20, r: 10 },
+        { x: 15, y: 8, r: 30 },
+      ],
+    },
+  ],
+};
+</script>
+
+<template>
+  <Bubble :data="chartData" :options="chartOptions" class="chart" />
+</template>
+
+<style lang="scss" scoped>
+.chart {
+  height: 32rem;
+}
+</style>

package/src/stories/DoughnutChart/DoughnutChart.ct.tsx

@@ -0,0 +1,8 @@
+import { test } from "@playwright/experimental-ct-vue";
+import { executeChartScreenshotTest } from "../playwright-utils";
+import DoughnutChart from "./DoughnutChart.vue";
+
+test("should render doughnut chart", async ({ mount, page }) => {
+  const component = await mount(DoughnutChart);
+  await executeChartScreenshotTest(page, component, "doughnut");
+});

package/src/stories/DoughnutChart/DoughnutChart.stories.ts

@@ -0,0 +1,12 @@
+import type { Meta, StoryObj } from "@storybook/vue3";
+import DoughnutChart from "./DoughnutChart.vue";
+
+const meta: Meta<typeof DoughnutChart> = {
+  title: "examples/DoughnutChart",
+  component: DoughnutChart,
+};
+
+export default meta;
+type Story = StoryObj<typeof DoughnutChart>;
+
+export const Default = { args: {} } satisfies Story;

package/src/stories/DoughnutChart/DoughnutChart.vue

@@ -0,0 +1,24 @@
+<script lang="ts" setup>
+import type { ChartData } from "chart.js";
+import { Doughnut } from "vue-chartjs";
+import { chartOptions } from "../data";
+
+const chartData: ChartData<"doughnut"> = {
+  labels: ["VueJs", "EmberJs", "ReactJs", "AngularJs"],
+  datasets: [
+    {
+      data: [40, 20, 80, 10],
+    },
+  ],
+};
+</script>
+
+<template>
+  <Doughnut :data="chartData" :options="chartOptions" class="chart" />
+</template>
+
+<style lang="scss" scoped>
+.chart {
+  height: 32rem;
+}
+</style>

package/src/stories/LineChart/LineChart.ct.tsx

@@ -0,0 +1,8 @@
+import { test } from "@playwright/experimental-ct-vue";
+import { executeChartScreenshotTest } from "../playwright-utils";
+import LineChart from "./LineChart.vue";
+
+test("should render line chart", async ({ mount, page }) => {
+  const component = await mount(LineChart);
+  await executeChartScreenshotTest(page, component, "line");
+});

package/src/stories/LineChart/LineChart.stories.ts

@@ -0,0 +1,12 @@
+import type { Meta, StoryObj } from "@storybook/vue3";
+import LineChart from "./LineChart.vue";
+
+const meta: Meta<typeof LineChart> = {
+  title: "examples/LineChart",
+  component: LineChart,
+};
+
+export default meta;
+type Story = StoryObj<typeof LineChart>;
+
+export const Default = { args: {} } satisfies Story;

package/src/stories/LineChart/LineChart.vue

@@ -0,0 +1,33 @@
+<script lang="ts" setup>
+import type { ChartData } from "chart.js";
+import { Line } from "vue-chartjs";
+import { chartOptions } from "../data";
+
+const labels = ["01.01.2024", "01.02.2024", "01.03.2024", "01.04.2024", "01.05.2024"];
+
+const chartData: ChartData<"line"> = {
+  labels,
+  datasets: [
+    {
+      label: "Dataset A",
+      fill: true,
+      data: [1, 8, 4, 6, 2],
+    },
+    {
+      label: "Dataset B",
+      fill: true,
+      data: [4, 2, 3, 1, 7],
+    },
+  ],
+};
+</script>
+
+<template>
+  <Line :data="chartData" :options="chartOptions" class="chart" />
+</template>
+
+<style lang="scss" scoped>
+.chart {
+  height: 32rem;
+}
+</style>

package/src/stories/PieChart/PieChart.ct.tsx

@@ -0,0 +1,8 @@
+import { test } from "@playwright/experimental-ct-vue";
+import { executeChartScreenshotTest } from "../playwright-utils";
+import PieChart from "./PieChart.vue";
+
+test("should render pie chart", async ({ mount, page }) => {
+  const component = await mount(PieChart);
+  await executeChartScreenshotTest(page, component, "pie");
+});

package/src/stories/PieChart/PieChart.stories.ts

@@ -0,0 +1,12 @@
+import type { Meta, StoryObj } from "@storybook/vue3";
+import PieChart from "./PieChart.vue";
+
+const meta: Meta<typeof PieChart> = {
+  title: "examples/PieChart",
+  component: PieChart,
+};
+
+export default meta;
+type Story = StoryObj<typeof PieChart>;
+
+export const Default = { args: {} } satisfies Story;

package/src/stories/PieChart/PieChart.vue

@@ -0,0 +1,24 @@
+<script lang="ts" setup>
+import type { ChartData } from "chart.js";
+import { Pie } from "vue-chartjs";
+import { chartOptions } from "../data";
+
+const chartData: ChartData<"pie"> = {
+  labels: ["VueJs", "EmberJs", "ReactJs", "AngularJs"],
+  datasets: [
+    {
+      data: [40, 20, 80, 10],
+    },
+  ],
+};
+</script>
+
+<template>
+  <Pie :data="chartData" :options="chartOptions" class="chart" />
+</template>
+
+<style lang="scss" scoped>
+.chart {
+  height: 32rem;
+}
+</style>

package/src/stories/PolarAreaChart/PolarAreaChart.ct.tsx

@@ -0,0 +1,8 @@
+import { test } from "@playwright/experimental-ct-vue";
+import { executeChartScreenshotTest } from "../playwright-utils";
+import PolarAreaChart from "./PolarAreaChart.vue";
+
+test("should render polar area chart", async ({ mount, page }) => {
+  const component = await mount(PolarAreaChart);
+  await executeChartScreenshotTest(page, component, "polar-area");
+});

package/src/stories/PolarAreaChart/PolarAreaChart.stories.ts

@@ -0,0 +1,12 @@
+import type { Meta, StoryObj } from "@storybook/vue3";
+import PolarAreaChart from "./PolarAreaChart.vue";
+
+const meta: Meta<typeof PolarAreaChart> = {
+  title: "examples/PolarAreaChart",
+  component: PolarAreaChart,
+};
+
+export default meta;
+type Story = StoryObj<typeof PolarAreaChart>;
+
+export const Default = { args: {} } satisfies Story;

package/src/stories/PolarAreaChart/PolarAreaChart.vue

@@ -0,0 +1,29 @@
+<script lang="ts" setup>
+import type { ChartData } from "chart.js";
+import { PolarArea } from "vue-chartjs";
+import { chartOptionsWithoutScales } from "../data";
+
+const chartData: ChartData<"polarArea"> = {
+  labels: ["Eating", "Drinking", "Sleeping", "Designing", "Coding", "Cycling", "Running"],
+  datasets: [
+    {
+      label: "My First dataset",
+      data: [65, 59, 90, 81, 56, 55, 40],
+    },
+    {
+      label: "My Second dataset",
+      data: [28, 48, 40, 19, 96, 27, 100],
+    },
+  ],
+};
+</script>
+
+<template>
+  <PolarArea :data="chartData" :options="chartOptionsWithoutScales" class="chart" />
+</template>
+
+<style lang="scss" scoped>
+.chart {
+  height: 32rem;
+}
+</style>

package/src/stories/RadarChart/RadarChart.ct.tsx

@@ -0,0 +1,8 @@
+import { test } from "@playwright/experimental-ct-vue";
+import { executeChartScreenshotTest } from "../playwright-utils";
+import RadarChart from "./RadarChart.vue";
+
+test("should render radar chart", async ({ mount, page }) => {
+  const component = await mount(RadarChart);
+  await executeChartScreenshotTest(page, component, "radar");
+});

package/src/stories/RadarChart/RadarChart.stories.ts

@@ -0,0 +1,12 @@
+import type { Meta, StoryObj } from "@storybook/vue3";
+import RadarChart from "./RadarChart.vue";
+
+const meta: Meta<typeof RadarChart> = {
+  title: "examples/RadarChart",
+  component: RadarChart,
+};
+
+export default meta;
+type Story = StoryObj<typeof RadarChart>;
+
+export const Default = { args: {} } satisfies Story;

package/src/stories/RadarChart/RadarChart.vue

@@ -0,0 +1,29 @@
+<script lang="ts" setup>
+import type { ChartData } from "chart.js";
+import { Radar } from "vue-chartjs";
+import { chartOptionsWithoutScales } from "../data";
+
+const chartData: ChartData<"radar"> = {
+  labels: ["Eating", "Drinking", "Sleeping", "Designing", "Coding", "Cycling", "Running"],
+  datasets: [
+    {
+      label: "Dataset A",
+      data: [65, 59, 90, 81, 56, 55, 40],
+    },
+    {
+      label: "Dataset B",
+      data: [28, 48, 40, 19, 96, 27, 100],
+    },
+  ],
+};
+</script>
+
+<template>
+  <Radar :data="chartData" :options="chartOptionsWithoutScales" class="chart" />
+</template>
+
+<style lang="scss" scoped>
+.chart {
+  height: 32rem;
+}
+</style>

package/src/stories/ScatterChart/ScatterChart.ct.tsx

@@ -0,0 +1,8 @@
+import { test } from "@playwright/experimental-ct-vue";
+import { executeChartScreenshotTest } from "../playwright-utils";
+import ScatterChart from "./ScatterChart.vue";
+
+test("should render scatter chart", async ({ mount, page }) => {
+  const component = await mount(ScatterChart);
+  await executeChartScreenshotTest(page, component, "scatter");
+});

package/src/stories/ScatterChart/ScatterChart.stories.ts

@@ -0,0 +1,12 @@
+import type { Meta, StoryObj } from "@storybook/vue3";
+import ScatterChart from "./ScatterChart.vue";
+
+const meta: Meta<typeof ScatterChart> = {
+  title: "examples/ScatterChart",
+  component: ScatterChart,
+};
+
+export default meta;
+type Story = StoryObj<typeof ScatterChart>;
+
+export const Default = { args: {} } satisfies Story;

package/src/stories/ScatterChart/ScatterChart.vue

@@ -0,0 +1,42 @@
+<script lang="ts" setup>
+import type { ChartData } from "chart.js";
+import { Scatter } from "vue-chartjs";
+import { chartOptions } from "../data";
+
+const chartData: ChartData<"scatter"> = {
+  datasets: [
+    {
+      label: "Dataset A",
+      fill: false,
+      data: [
+        { x: -2, y: 4 },
+        { x: -1, y: 1 },
+        { x: 0, y: 0 },
+        { x: 1, y: 1 },
+        { x: 2, y: 4 },
+      ],
+    },
+    {
+      label: "Dataset B",
+      fill: false,
+      data: [
+        { x: -2, y: -4 },
+        { x: -1, y: -1 },
+        { x: 0, y: 1 },
+        { x: 1, y: -1 },
+        { x: 2, y: -4 },
+      ],
+    },
+  ],
+};
+</script>
+
+<template>
+  <Scatter :data="chartData" :options="chartOptions" class="chart" />
+</template>
+
+<style lang="scss" scoped>
+.chart {
+  height: 32rem;
+}
+</style>

package/src/stories/data.ts

@@ -0,0 +1,42 @@
+import type { ChartOptions } from "chart.js";
+
+/**
+ * Shared chart options for all example charts (without scales for polar area and radar chart).
+ */
+export const chartOptionsWithoutScales = {
+  responsive: true,
+  maintainAspectRatio: false,
+  hover: {
+    intersect: false,
+  },
+  plugins: {
+    title: {
+      display: true,
+      text: "Example title",
+    },
+    tooltip: {
+      intersect: false,
+    },
+  },
+} satisfies ChartOptions;
+
+/**
+ * Shared chart options for all example charts.
+ */
+export const chartOptions = {
+  ...chartOptionsWithoutScales,
+  scales: {
+    x: {
+      title: {
+        display: true,
+        text: "x scale label",
+      },
+    },
+    y: {
+      title: {
+        display: true,
+        text: "y scale label",
+      },
+    },
+  },
+} satisfies ChartOptions;

package/src/stories/playwright-utils.tsx

@@ -0,0 +1,23 @@
+import { expect, type MountResult } from "@playwright/experimental-ct-vue";
+import type { Page } from "@playwright/test";
+
+export const switchTheme = (page: Page, theme: string) =>
+  page.evaluate((theme) => document.documentElement.classList.add(theme), theme);
+
+export const executeChartScreenshotTest = async (
+  page: Page,
+  component: MountResult<unknown>,
+  screenshotName: string,
+) => {
+  // hover so that the tooltip is shown for the screenshot
+  await component.hover();
+
+  // ASSERT
+  await expect(component).toHaveScreenshot(`${screenshotName}-light.png`);
+
+  // ACT
+  await switchTheme(page, "dark");
+
+  // ASSERT
+  await expect(component).toHaveScreenshot(`${screenshotName}-dark.png`);
+};

package/src/utils.spec.ts

@@ -0,0 +1,9 @@
+import { describe, expect, test } from "vitest";
+import { hexToRgb } from "./utils";
+
+describe("utils.ts", () => {
+  test("should convert hex to rgb", () => {
+    const rgb = hexToRgb("#0c2238");
+    expect(rgb).toBe("12, 34, 56");
+  });
+});

package/src/utils.ts

@@ -0,0 +1,49 @@
+import type { OnyxColor } from "sit-onyx/types";
+
+/**
+ * Utility for easily styling a Chart.js dataset with a specific onyx color.
+ *
+ * @example
+ * ```ts
+ * const chartData: ChartData<"line"> = {
+ *   labels: ["A", "B", "C"],
+ *   datasets: [
+ *     {
+ *       label: "Dataset A",
+ *       data: [1, 2, 3],
+ *       ...getDatasetColors("primary"),
+ *     },
+ *   ],
+ * };
+ * ```
+ */
+export const getDatasetColors = (
+  color: OnyxColor | `quantitatives-${100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900}`,
+) => {
+  const cssVariable = `--onyx-color-base-${color.startsWith("quantitatives-") ? color : `${color}-500`}`;
+  const baseColor = getCSSVariableValue(cssVariable);
+
+  return {
+    borderColor: baseColor,
+    backgroundColor: `rgba(${hexToRgb(baseColor)}, 0.3)`,
+  };
+};
+
+/**
+ * Gets the current value of the given CSS variable.
+ * @param CSS variable name, e.g. `--onyx-color-base-primary-500`
+ */
+export const getCSSVariableValue = (variableName: string) => {
+  return getComputedStyle(document.body).getPropertyValue(variableName);
+};
+
+/**
+ * Converts the given HEX color to rgb.
+ */
+export const hexToRgb = (hex: string) => {
+  const number = parseInt(hex.replace("#", ""), 16);
+  const r = (number >> 16) & 255;
+  const g = (number >> 8) & 255;
+  const b = number & 255;
+  return `${r}, ${g}, ${b}`;
+};