Yunti Charts

☁️ Yunti Charts is an open-source Charts component library for building web apps

English ・ 简体中文 ・ Changelog · Report Bug · Request Feature

Table of contents

TOC

• 📦 Installation
  • Compile with NextJS
• ☁️ Usage
• ⌨️ Local Development
• 🤝 Contributing

📦 Installation

Important

This package is ESM only.

To install Yunti Charts, run the following command:

pnpm add @yuntijs/charts

Compile with NextJS

Note

By work correct with nextjs ssr, add transpilePackages: ['@yuntijs/charts'] to next.config.js. For example:

// next.config.js
const nextConfig = {
  // ...other config

  transpilePackages: ['@yuntijs/charts'],
};

☁️ Usage

Note

The YuntiCharts components are inspired by AntV G2 and developed based on Antd, fully compatible with Antd components, and it is recommended to use antd-style as the default css-in-js styling solution.

import { LineChart } from '@yuntijs/charts';

export default () => (
  <LineChart/>
);

⌨️ Local Development

You can use Github Codespaces for online development:

Or clone it for local development:

git clone https://github.com/yuntijs/yunti-charts.git
cd yunti-charts
pnpm install
pnpm dev

🤝 Contributing

Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub Issues to get stuck in to show us what you’re made of.

---

📝 License

Copyright © 2024 YuntiJS.
This project is MIT licensed.