madhupolu / vue-chart-3

📊 A simple wrapper around Chart.js 3 for Vue 2 & 3

📊 Chart.js 3 for Vue 2 and Vue 3

This package is a rewrite of vue-chartjs for Chart.js 3, but written in Typescript with Vue 3 composition api in mind.

Documentation

Full documentation

⚠️ Breaking changes and new versions numbers

In previous versions, vue-demi was used. It worked really well, but as the project advanced, they were a lot of problems with vue-related typescript definitions, tests and conflict between dependencies.

This new system will keep vue-chart-3 working for both Vue 2 & 3 with designated versions (2.x and 3.x respectively), but each one designed for their specific Vue version.

Code wise, there is not big breaking changes. But the Vue 3 version will have improved type checking for components template (with Volar extension).

For Vue 3 users, nothing changes. For Vue 2 users, you will have to keep 2.x version of vue-chart-3

Installation

For Vue 3

npm i vue-chart-3
#or
yarn add vue-chart-3
#or
pnpm i vue-chart-3

For Vue 2

npm i vue-chart-3@legacy
#or
yarn add vue-chart-3@legacy
#or
pnpm i vue-chart-3@legacy

Important notes

Using with Vue 3 or Vue 2

This package works with version 2.x and 3.x of Vue.

• Vue 3 works out-of-the-box
• Vue 2 requires @vue/composition-api package to also be installed and registered, to provide Vue 3's Composition API features like ref, defineComponent, computed, reactive.

⚠️ Since 2.0.3 (for Vue 2 users), Vue composition api will not register itself. Update your project if you didn't do it manually!

Demos

• Vue 3: CodeSandbox demo Vue 3
• Vue 2 + composition API: CodeSandbox demo Vue 2 + composition
• Vue 2 + Typescript + class API CodeSandox demo Vue 2 + class
• Nuxt 2 + SSR CodeSandbox demo Nuxt 2 + SSR