README.md

August 28, 2025 ยท View on GitHub

KLineChart

English | ็ฎ€ไฝ“ไธญๆ–‡

๐Ÿ’น๐Ÿ“ˆ Lightweight k-line chart built with html5 canvas.

GitHub Workflow Status (with branch) Version Size npms.io (maintenance) Typescript LICENSE Docs

Issues Discussions Telegram Wechat

โœจ 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

npm install klinecharts --save

Using yarn

yarn add klinecharts

CDNs

unpkg

<script type="text/javascript" src="https://unpkg.com/klinecharts/dist/klinecharts.min.js"></script>

jsDelivr

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/klinecharts/dist/klinecharts.min.js"></script>

๐Ÿ“„ Docs

Online

https://www.klinecharts.com

Locale

Execute command in root directory. Node.js is required.

# Install the dependencies
npm install

# Start document service
npm run docs:dev

After successful startup, open in the browser http://localhost:8888 .

๐Ÿ› ๏ธ Build

Execute command in root directory. Node.js is required.

# Install the dependencies
npm install

# Build files
npm run build

The generated files are in the dist folder.

ยฉ๏ธ License

KLineChart is available under the Apache License V2.