Merge pull request #179 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,8 +13,6 @@
   "[yaml]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
-  "prettier.packageManager": "yarn",
-  "eslint.packageManager": "yarn",
   "npm.packageManager": "yarn",
   "eslint.nodePath": ".yarn/sdks",
   "prettier.prettierPath": ".yarn/sdks/prettier/index.js",
@@ -23,7 +21,6 @@
   "typescript.enablePromptUseWorkspaceTsdk": true,
   "editor.detectIndentation": false,
   "editor.tabSize": 2,
-  "liveServer.settings.port": 5503,
   "search.exclude": {
     "**/.yarn": true,
     "**/.pnp.*": true

.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

docs/.vitepress/config.ts

@@ -0,0 +1,64 @@
+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: 'Choropleth US Map', link: '/examples/choropleth' },
+          { text: 'Bubble Map', link: '/examples/bubbleMap' },
+          { text: 'Custom Color Scale', link: '/examples/custom' },
+          { text: 'Legend Customization', link: '/examples/legend' },
+          { text: 'Tooltip Center', link: '/examples/center' },
+          { text: 'Projection Offset', link: '/examples/offset' },
+          { text: 'Equal Earth Projection', link: '/examples/projection' },
+          { text: 'World Atlas', link: '/examples/earth' },
+          { text: 'Bubble Map Area Mode', link: '/examples/area' },
+        ],
+      },
+      {
+        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,42 @@
+import Theme from 'vitepress/theme';
+import { createTypedChart } from 'vue-chartjs';
+import { Tooltip, PointElement } from 'chart.js';
+import {
+  BubbleMapController,
+  ChoroplethController,
+  ColorScale,
+  ColorLogarithmicScale,
+  SizeLogarithmicScale,
+  SizeScale,
+  GeoFeature,
+  ProjectionScale,
+} from '../../../src';
+
+export default {
+  ...Theme,
+  enhanceApp({ app }) {
+    app.component(
+      'BubbleMapChart',
+      createTypedChart('bubbleMap', [
+        ProjectionScale,
+        BubbleMapController,
+        SizeScale,
+        SizeLogarithmicScale,
+        PointElement,
+        GeoFeature,
+        Tooltip,
+      ])
+    );
+    app.component(
+      'ChoroplethChart',
+      createTypedChart('choropleth', [
+        ProjectionScale,
+        ChoroplethController,
+        ColorScale,
+        ColorLogarithmicScale,
+        GeoFeature,
+        Tooltip,
+      ])
+    );
+  },
+};

docs/examples/albers.ts

@@ -0,0 +1,45 @@
+import type { ChartConfiguration } from 'chart.js';
+import { Feature, topojson } from '../../src';
+
+// #region data
+import states10m from 'us-atlas/states-10m.json';
+
+const nation: Feature = topojson.feature(states10m as any, states10m.objects.nation as any).features[0];
+const states: Feature = topojson.feature(states10m as any, states10m.objects.states as any).features;
+
+export const data: ChartConfiguration<'choropleth'>['data'] = {
+  labels: states.map((d) => d.properties.name),
+  datasets: [
+    {
+      label: 'States',
+      outline: nation,
+      data: states.map((d) => ({
+        feature: d,
+        value: Math.random() * 11,
+      })),
+    },
+  ],
+};
+// #endregion data
+// #region config
+export const config: ChartConfiguration<'choropleth'> = {
+  type: 'choropleth',
+  data,
+  options: {
+    scales: {
+      projection: {
+        axis: 'x',
+        projection: 'albersUsa',
+      },
+      color: {
+        axis: 'x',
+        quantize: 5,
+        legend: {
+          position: 'bottom-right',
+          align: 'right',
+        },
+      },
+    },
+  },
+};
+// #endregion config

docs/examples/area.md

@@ -0,0 +1,24 @@
+---
+title: Bubble Map Area Mode
+---
+
+# Bubble Map Area Mode
+
+<script setup>
+import {config} from './area';
+</script>
+
+<BubbleMapChart
+  :options="config.options"
+  :data="config.data"
+/>
+
+### Code
+
+:::code-group
+
+<<< ./area.ts#config [config]
+
+<<< ./bubbleMap.ts#data [data]
+
+:::

docs/examples/area.ts

@@ -0,0 +1,26 @@
+import type { ChartConfiguration } from 'chart.js';
+import { Feature, topojson } from '../../src';
+import { data } from './bubbleMap';
+
+// #region config
+export const config: ChartConfiguration<'bubbleMap'> = {
+  type: 'bubbleMap',
+  data,
+  options: {
+    scales: {
+      projection: {
+        axis: 'x',
+        projection: 'albersUsa',
+      },
+      size: {
+        axis: 'x',
+        size: [1, 20],
+        mode: 'area',
+      },
+    },
+    layout: {
+      // padding: 20
+    },
+  },
+};
+// #endregion config

docs/examples/bubbleMap.md

@@ -0,0 +1,24 @@
+---
+title: Bubble Map
+---
+
+# Bubble Map
+
+<script setup>
+import {config} from './bubbleMap';
+</script>
+
+<BubbleMapChart
+  :options="config.options"
+  :data="config.data"
+/>
+
+### Code
+
+:::code-group
+
+<<< ./bubbleMap.ts#config [config]
+
+<<< ./bubbleMap.ts#data [data]
+
+:::