Merge pull request #64 from sgratzl/release/v4.2.1

Release v4.2.1

.gitattributes

@@ -20,7 +20,9 @@
 *.less text
 *.styl text
 *.js text
+*.jsx text
 *.ts text
+*.tsx text
 *.coffee text
 *.json text
 *.htm text

.github/workflows/ci.yml

@@ -25,9 +25,9 @@ jobs:
       - run: yarn build
       - run: yarn lint
       - run: yarn test
-      - run: yarn samples
       - uses: actions/upload-artifact@v2
         if: failure()
         with:
           name: diff outputs
           path: src/**/__diff_output__/*.png
+      - run: yarn docs:build

.github/workflows/deploy_website.yml

@@ -0,0 +1,43 @@
+name: Deploy Website
+on:
+  workflow_dispatch: {}
+  push:
+    branches:
+      - main
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: npm
+      - run: npm i -g yarn
+      - run: yarn config set checksumBehavior ignore
+      - name: Cache Node.js modules
+        uses: actions/cache@v3
+        with:
+          path: |
+            ./.yarn/cache
+            ./.yarn/unplugged
+          key: ${{ runner.os }}-yarn2-v5-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn2-v5
+      - run: yarn install
+      - run: yarn docs:build
+      - uses: actions/configure-pages@v2
+      - uses: actions/upload-pages-artifact@v1
+        with:
+          path: docs/.vitepress/dist
+      - name: Deploy
+        id: deployment
+        uses: actions/deploy-pages@v1

.gitignore

@@ -19,9 +19,11 @@ npm-debug.log*
 
 *.tgz
 /.vscode/extensions.json
-/docs
 *.tsbuildinfo
 .eslintcache
 __diff_output__
 
-/samples/type_test.js
+docs/.vitepress/dist
+docs/.vitepress/cache
+docs/.vitepress/config.ts.timestamp*
+docs/api/

.prettierignore

@@ -2,7 +2,10 @@
 /.yarnrc.yml
 /.yarn
 /build
-/docs
+/docs/.vitepress/cache
+/docs/.vitepress/dist
+/docs/.vitepress/config.ts.timestamp*
+/docs/api
 /coverage
 /.gitattributes
 /.gitignore
@@ -14,4 +17,4 @@
 *.tgz
 *.tsbuildinfo
 .eslintcache
-/samples/type_test.js
+.nojekyll

.vscode/settings.json

@@ -13,7 +13,6 @@
   "[yaml]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
-  "eslint.packageManager": "yarn",
   "npm.packageManager": "yarn",
   "eslint.nodePath": ".yarn/sdks",
   "prettier.prettierPath": ".yarn/sdks/prettier/index.js",
@@ -25,6 +24,5 @@
   "search.exclude": {
     "**/.yarn": true,
     "**/.pnp.*": true
-  },
-  "liveServer.settings.port": 5501
+  }
 }

.yarnrc.yml

@@ -3,4 +3,4 @@ packageExtensions:
     dependencies:
       eslint-import-resolver-node: "*"
 
-yarnPath: .yarn/releases/yarn-3.5.0.cjs
+yarnPath: .yarn/releases/yarn-3.6.1.cjs

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2022 Samuel Gratzl
+Copyright (c) 2019-2023 Samuel Gratzl
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,7 +2,7 @@
 
 [![License: MIT][mit-image]][mit-url] [![NPM Package][npm-image]][npm-url] [![Github Actions][github-actions-image]][github-actions-url]
 
-Chart.js module for charting error bars plots. This plugin extends the several char types (`bar`, `horizontalBar`, `line`, `scatter`, `polarArea`)
+Chart.js module for charting error bars plots. This plugin extends the several char types (`bar`, `line`, `scatter`, `polarArea`)
 with their error bar equivalent (`barWithErrorBars`, `lineWithErrorBars`, `scatterWithErrorBars`, `polarAreaWithErrorBars`).
 
 Bar Chart
@@ -45,7 +45,7 @@ npm install --save chart.js chartjs-chart-error-bars
 
 ## Usage
 
-see [Samples](https://github.com/sgratzl/chartjs-chart-error-bars/tree/main/samples) on Github
+see [Examples](https://www.sgratzl.com/chartjs-chart-error-bars/examples)
 
 and [![Open in CodePen][codepen]](https://codepen.io/sgratzl/pen/ZEbqmqx)
 

docs/.vitepress/config.ts

@@ -0,0 +1,63 @@
+import { defineConfig } from 'vitepress';
+import { name, description, repository, license, author } from '../../package.json';
+import typedocSidebar from '../api/typedoc-sidebar.json';
+
+const cleanName = name.replace('@sgratzl/', '');
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: cleanName,
+  description,
+  base: `/${cleanName}/`,
+  useWebFonts: false,
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Getting Started', link: '/getting-started' },
+      { text: 'Examples', link: '/examples/' },
+      { text: 'API', link: '/api/' },
+      { text: 'Related Plugins', link: '/related' },
+    ],
+
+    sidebar: [
+      {
+        text: 'Examples',
+        items: [
+          { text: 'Basic', link: '/examples/' },
+          { text: 'Bar Chart', link: '/examples/bar' },
+          { text: 'Line Chart', link: '/examples/line' },
+          { text: 'Scatter Chart', link: '/examples/scatter' },
+          { text: 'Polar Area Chart', link: '/examples/polarArea' },
+          { text: 'Horizontal Bar Chart', link: '/examples/horizontalBar' },
+          { text: 'Multiple Error Bars', link: '/examples/multibar' },
+          { text: 'Line As Scatter Chart', link: '/examples/lineScatter' },
+          { text: 'Line Timeseries Chart', link: '/examples/lineTime' },
+        ],
+      },
+      {
+        text: 'API',
+        collapsed: true,
+        items: typedocSidebar,
+      },
+    ],
+
+    socialLinks: [{ icon: 'github', link: repository.url.replace('.git', '') }],
+
+    footer: {
+      message: `Released under the <a href="${repository.url.replace(
+        '.git',
+        ''
+      )}/tree/main/LICENSE">${license} license</a>.`,
+      copyright: `Copyright © 2019-present <a href="${author.url}">${author.name}</a>`,
+    },
+
+    editLink: {
+      pattern: `${repository.url.replace('.git', '')}/edit/main/docs/:path`,
+    },
+
+    search: {
+      provider: 'local',
+    },
+  },
+});

docs/.vitepress/theme/index.ts

@@ -0,0 +1,54 @@
+import Theme from 'vitepress/theme';
+import { createTypedChart } from 'vue-chartjs';
+import {
+  LinearScale,
+  CategoryScale,
+  RadialLinearScale,
+  Tooltip,
+  Colors,
+  BarElement,
+  LineElement,
+  PointElement,
+  BarController,
+  LineController,
+  TimeScale,
+} from 'chart.js';
+import {
+  ArcWithErrorBar,
+  BarWithErrorBar,
+  BarWithErrorBarsController,
+  LineWithErrorBarsController,
+  PolarAreaWithErrorBarsController,
+  PointWithErrorBar,
+  ScatterWithErrorBarsController,
+} from '../../../src';
+
+export default {
+  ...Theme,
+  enhanceApp({ app }) {
+    const deps = [
+      LinearScale,
+      CategoryScale,
+      RadialLinearScale,
+      TimeScale,
+      ArcWithErrorBar,
+      BarWithErrorBar,
+      BarWithErrorBarsController,
+      LineWithErrorBarsController,
+      PolarAreaWithErrorBarsController,
+      PointWithErrorBar,
+      ScatterWithErrorBarsController,
+      Tooltip,
+      Colors,
+      BarElement,
+      LineElement,
+      PointElement,
+      BarController,
+      LineController,
+    ];
+    app.component('BarWithErrorBarsChart', createTypedChart('barWithErrorBars', deps));
+    app.component('LineWithErrorBarsChart', createTypedChart('lineWithErrorBars', deps));
+    app.component('PolarAreaWithErrorBarsChart', createTypedChart('polarAreaWithErrorBars', deps));
+    app.component('ScatterWithErrorBarsChart', createTypedChart('scatterWithErrorBars', deps));
+  },
+};

docs/examples/bar.md

@@ -0,0 +1,18 @@
+---
+title: Bar With Error Bars
+---
+
+# Bar With Error Bars
+
+<script setup>
+import {config as bar} from './bar';
+</script>
+
+<BarWithErrorBarsChart
+  :options="bar.options"
+  :data="bar.data"
+/>
+
+### Code
+
+<<< ./bar.ts#config

docs/examples/bar.ts

@@ -0,0 +1,27 @@
+import type { ChartConfiguration } from 'chart.js';
+import type {} from '../../src';
+
+// #region config
+export const config: ChartConfiguration<'barWithErrorBars'> = {
+  type: 'barWithErrorBars',
+  data: {
+    labels: ['A', 'B'],
+    datasets: [
+      {
+        data: [
+          {
+            y: 4,
+            yMin: 1,
+            yMax: 6,
+          },
+          {
+            y: 2,
+            yMin: 1,
+            yMax: 4,
+          },
+        ],
+      },
+    ],
+  },
+};
+// #endregion config

docs/examples/basic.ts

@@ -0,0 +1,58 @@
+import type { ChartConfiguration } from 'chart.js';
+import type {} from '../../src';
+
+// #region bar
+export const bar: ChartConfiguration<'barWithErrorBars'> = {
+  type: 'barWithErrorBars',
+  data: {
+    labels: ['A', 'B'],
+    datasets: [
+      {
+        data: [
+          {
+            y: 4,
+            yMin: 1,
+            yMax: 6,
+          },
+          {
+            y: 2,
+            yMin: 1,
+            yMax: 4,
+          },
+        ],
+      },
+    ],
+  },
+};
+// #endregion bar
+
+// #region scatter
+export const scatter: ChartConfiguration<'scatterWithErrorBars'> = {
+  type: 'scatterWithErrorBars',
+  data: {
+    labels: ['A', 'B'],
+    datasets: [
+      {
+        data: [
+          {
+            x: 2,
+            xMin: 1,
+            xMax: 3,
+            y: 4,
+            yMin: 1,
+            yMax: 6,
+          },
+          {
+            x: 7,
+            xMin: 6,
+            xMax: 9,
+            y: 2,
+            yMin: 1,
+            yMax: 4,
+          },
+        ],
+      },
+    ],
+  },
+};
+// #endregion scatter

docs/examples/horizontalBar.md

@@ -0,0 +1,18 @@
+---
+title: Horizontal Bar With Error Bars
+---
+
+# Horizontal Bar With Error Bars
+
+<script setup>
+import {config as bar} from './horizontalBar';
+</script>
+
+<BarWithErrorBarsChart
+  :options="bar.options"
+  :data="bar.data"
+/>
+
+### Code
+
+<<< ./horizontalBar.ts#config