README.md
August 28, 2025 ยท View on GitHub
KLineChart
English | ็ฎไฝไธญๆ
๐น๐ Lightweight k-line chart built with html5 canvas.
โจ 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
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.
๐ Links
- KLineChart Preview: A more complete example.
- KLineChart Pro: Financial chart built out of the box based on KLineChart.
- openctp: Trading simulation environment for the Chinese market.
ยฉ๏ธ License
KLineChart is available under the Apache License V2.