KLineChart
đšđ Lightweight k-line chart built with html5 canvas.
[![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/liihuu/KLineChart/build.yml?logo=github)](https://github.com/liihuu/KLineChart/actions/workflows/build.yml)
[![Version](https://badgen.net/npm/v/klinecharts)](https://www.npmjs.com/package/klinecharts)
[![Size](https://badgen.net/bundlephobia/minzip/klinecharts@latest)](https://bundlephobia.com/result?p=klinecharts@latest)
[![npms.io (maintenance)](https://img.shields.io/npms-io/quality-score/klinecharts)](https://www.npmjs.com/package/klinecharts)
[![Typescript](https://badgen.net/npm/types/klinecharts)](types/index.d.ts)
[![LICENSE](https://badgen.net/github/license/liihuu/KLineChart)](LICENSE)
[![Docs](https://badgen.net/badge/docs%20by/vitepress/10B981)](https://vitepress.dev/)
[![Github Issues](https://img.shields.io/static/v1?color=1f2328&logo=github&logoColor=fff&label&message=Github%20Issues)](https://github.com/liihuu/KLineChart/issues)
[![Github Discussions](https://img.shields.io/static/v1?color=1f2328&logo=github&logoColor=fff&label&message=Github%20Discussions)](https://github.com/liihuu/KLineChart/discussions)
[![Telegram](https://img.shields.io/static/v1?color=1296DB&logo=telegram&logoColor=fff&label&message=Telegram)](https://t.me/+098syuQtzI0yNzll)
[![Discord](https://img.shields.io/static/v1?color=738BD8&logo=discord&logoColor=fff&label&message=Discord)](https://discord.gg/7YjHYgvvvZ)
[![Wechat](https://img.shields.io/static/v1?color=1EBE1F&logo=wechat&logoColor=fff&label&message=Wechat)](https://klinecharts.com/en-US/guide/feedback.html)
English | [įŽäŊä¸æ](./README.zh-CN.md)
## ⨠Features
- đĻ Out of the box: Simple and fast integration, basically zero cost to get started.
- đ Lightweight and smooth: Zero dependencies, only 40k under gzip compression.
- đĒ Powerful functions: Built-in multiple indicators and line drawing models.
- đ¨ Highly scalable: With rich style configuration and API, the function can be extended as you like.
- đą Mobile: Support mobile, one chart, handle multiple terminals.
- đĄ Typescript development: Provide complete type definition files.
## đĻ Install
### Using npm
```bash
npm install klinecharts --save
```
### Using yarn
```bash
yarn add klinecharts
```
### CDNs
#### [unpkg](https://unpkg.com)
```html
```
#### [jsDelivr](https://cdn.jsdelivr.net)
```html
```
## đ Docs
+ [English](https://www.klinecharts.com/en-US)
+ [ä¸æ](https://www.klinecharts.com)
## đ ī¸ Build
Execute command in root directory. [Node.js](https://nodejs.org) is required.
```bash
# Install the dependencies from NPM:
npm install
# Build files:
npm run build
```
The generated files are in the dist folder.
## đ Links
+ [Online Preview](https://preview.klinecharts.com)
+ [KLineChart Pro](https://pro.klinecharts.com)
+ [Sample Code](https://github.com/liihuu/KLineChartSample)
## Šī¸ License
KLineChart is available under the Apache License V2.