Nuxt ECharts

Nuxt Module for Apache ECharts™

[!IMPORTANT]

Nuxt ECharts SSR is based on experimental <NuxtIsland>. If you found any issue, design flaw, or have ideas to improve it, please open an issue or a Discussion.

• 📖  Documentation

• ✨  Release Notes

• 🎞️  Online Demo

• 🏀  Online Playground

Features

• ⛰ SSR: Server-side SVG Rendering with Nuxt server components

• ♾️ Client Hydration: lazy-loading full ECharts or lightweight client runtime

• 🛠️ Configurable: import only necessary functionality for shrinking bundle size

• 🦾 Type Strong: auto-import ECharts option type based on your config

• 🌲 Tree-shaking: Components and ECharts are only included if you use them

Quick Setup

Install the module to your Nuxt application with one command:

npx nuxi module add echarts

That's it! You can now use Nuxt ECharts in your Nuxt app ✨

Contribution

Local development

# Install dependencies
pnpm install

# Generate type stubs
pnpm run dev:prepare

# Develop with the playground
pnpm run dev

# Build the playground
pnpm run dev:build

# Run ESLint
pnpm run lint

# Format with Prettier
pnpm run format

# Run Vitest
pnpm run test
pnpm run test:watch

# Release new version
pnpm run release

Credits

The Nuxt ECharts module is heavily inspired by vue-echarts, created by @Justineo.

License

This project is licensed under the MIT License.

This project also partially contains code derived or copied from vue-echarts(MIT).

Notice

The Apache Software Foundation Apache ECharts, ECharts, Apache, the Apache feather, and the Apache ECharts project logo are either registered trademarks or trademarks of the Apache Software Foundation.