feat: updateMode prop (#962)

apertureless · Dec 5, 2022 · 5bd9805 · 5bd9805
1 parent c3f8fc9
commit 5bd9805
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/src/chart.ts b/src/chart.ts
@@ -53,7 +53,7 @@ export const Chart = defineComponent({
     }
 
     const update = (chart: ChartJS) => {
-      chart.update()
+      chart.update(props.updateMode)
     }
 
     onMounted(renderChart)

diff --git a/src/props.ts b/src/props.ts
@@ -1,5 +1,5 @@
 import type { PropType } from 'vue'
-import type { ChartType, ChartData, Plugin } from 'chart.js'
+import type { ChartType, ChartData, Plugin, UpdateMode } from 'chart.js'
 
 export const CommonProps = {
   data: {
@@ -17,6 +17,10 @@ export const CommonProps = {
   datasetIdKey: {
     type: String,
     default: 'label'
+  },
+  updateMode: {
+    type: String as PropType<UpdateMode>,
+    default: undefined
   }
 } as const
 

diff --git a/src/types.ts b/src/types.ts
@@ -5,7 +5,8 @@ import type {
   ChartData,
   ChartOptions,
   DefaultDataPoint,
-  Plugin
+  Plugin,
+  UpdateMode
 } from 'chart.js'
 
 export interface ChartProps<
@@ -39,6 +40,11 @@ export interface ChartProps<
    * @default 'label'
    */
   datasetIdKey?: string
+  /**
+   * A mode string to indicate transition configuration should be used.
+   * @see https://www.chartjs.org/docs/latest/developers/api.html#update-mode
+   */
+  updateMode?: UpdateMode
 }
 
 export interface ChartComponentRef<