tickup 1.0.12 β 1.0.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +49 -30
- package/dist/tickup-full.cjs.js +232 -311
- package/dist/tickup-full.cjs.js.map +1 -0
- package/dist/tickup-full.es.js +236 -5598
- package/dist/tickup-full.es.js.map +1 -0
- package/dist/tickup.cjs.js +236 -315
- package/dist/tickup.cjs.js.map +1 -0
- package/dist/tickup.es.js +232 -5328
- package/dist/tickup.es.js.map +1 -0
- package/documentation/01-glossary.md +8 -0
- package/documentation/01-introduction.md +8 -0
- package/documentation/02-installation.md +8 -0
- package/documentation/03-quick-start.md +8 -0
- package/documentation/04-products-and-layout.md +8 -0
- package/documentation/05-props-and-chart-options.md +8 -0
- package/documentation/06-imperative-api.md +8 -0
- package/documentation/07-data-and-live-updates.md +8 -0
- package/documentation/08-drawings-and-shapes.md +8 -0
- package/documentation/09-settings-modal.md +8 -0
- package/documentation/10-toolbar-and-interactions.md +8 -0
- package/documentation/11-exports-and-advanced.md +8 -0
- package/documentation/12-overlays-and-indicators.md +8 -0
- package/documentation/13-internationalization-and-axes.md +8 -0
- package/documentation/14-legal-and-policies.md +8 -0
- package/documentation/README.md +8 -0
- package/package.json +5 -26
package/README.md
CHANGED
|
@@ -1,57 +1,76 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/BARDAMRI/tickup-charts/main/public/tickup-icon.svg" alt="TickUp logo" width="96" height="96" />
|
|
3
|
+
</p>
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
<h1 align="center">TickUp Charts</h1>
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
<p align="center"><strong>The High-Performance Canvas Engine for Modern Financial Apps.</strong></p>
|
|
6
8
|
|
|
7
|
-
|
|
9
|
+
<p align="center">
|
|
10
|
+
<a href="https://www.npmjs.com/package/tickup"><img src="https://img.shields.io/npm/v/tickup.svg" alt="NPM Version" /></a>
|
|
11
|
+
<a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-yellow.svg" alt="License" /></a>
|
|
12
|
+
<a href="https://bundlephobia.com/package/tickup"><img src="https://img.shields.io/bundlephobia/minzip/tickup" alt="Bundle Size" /></a>
|
|
13
|
+
</p>
|
|
8
14
|
|
|
9
|
-
|
|
15
|
+
### Live Demo & Documentation
|
|
10
16
|
|
|
11
|
-
|
|
17
|
+
**Live Demo:** [https://bardamri.github.io/tickup-charts/](https://bardamri.github.io/tickup-charts/)
|
|
18
|
+
**Docs Hub:** [https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/README.md](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/README.md)
|
|
12
19
|
|
|
13
|
-
|
|
20
|
+
TickUp is a lightning-fast, Canvas 2D-based charting library for React. It is built for professional financial interfaces where smooth interaction, visual accuracy, and predictable performance are critical.
|
|
14
21
|
|
|
15
|
-
###
|
|
22
|
+
### Why TickUp
|
|
16
23
|
|
|
17
|
-
|
|
24
|
+
| Speed | Extensibility | Developer Experience |
|
|
25
|
+
| --- | --- | --- |
|
|
26
|
+
| **Canvas 2D pipeline** tuned for fast redraws and high-frequency updates. | **Composable architecture** ready for custom tools, overlays, and host app workflows. | **TypeScript-first API** with strong typing, IntelliSense, and practical docs. |
|
|
18
27
|
|
|
19
|
-
|
|
28
|
+
### Standard vs Prime
|
|
20
29
|
|
|
21
|
-
|
|
30
|
+
| Feature | Standard (MIT) | Prime (Pro) |
|
|
31
|
+
| --- | --- | --- |
|
|
32
|
+
| Engine | β
High-Speed Canvas 2D | π Ultra-Low Latency Rendering |
|
|
33
|
+
| Visuals | β
Standard Financial Styles | π "Neon" Glowing Rendering Mode |
|
|
34
|
+
| Analysis Tools | β
Basic Indicators | π Pro Tools (Fibonacci, Elliott, Gann) |
|
|
35
|
+
| Interaction | β
Pan & Zoom | π Advanced Multi-Touch & Precision Drawing |
|
|
36
|
+
| Localization | β
LTR Only | π Full RTL Support (Hebrew/Arabic) |
|
|
37
|
+
| Performance | β
Up to 50k Data Points | π 1M+ Data Points (HFT Optimized) |
|
|
38
|
+
| License | β
MIT (Open Source) | π Commercial (Private & Protected) |
|
|
22
39
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
|
26
|
-
|
|
|
40
|
+
### Pricing & Licensing
|
|
41
|
+
|
|
42
|
+
| Plan | License | Best For | Price |
|
|
43
|
+
| :--- | :--- | :--- | :--- |
|
|
44
|
+
| Community | MIT | Open Source & Hobbyists | Free |
|
|
45
|
+
| Professional | Commercial | Solo Founders & Small Teams | $99/yr |
|
|
46
|
+
| Enterprise | Custom | High-Frequency Trading & Banks | Contact Us |
|
|
47
|
+
|
|
48
|
+
**Pro Features:** **Neon Rendering Engine**, **Advanced Indicators (Fibonacci, Elliott)**, **RTL Support**, and **Priority Support**.
|
|
27
49
|
|
|
28
|
-
|
|
50
|
+
### Visual Showcase
|
|
29
51
|
|
|
30
|
-
|
|
31
|
-
- Pro Drawing Tools: Trend lines, Fibonacci, shapes, and full imperative API.
|
|
32
|
-
- Live Data Flow: Seamless WebSocket integration (replace/append/merge).
|
|
33
|
-
- Financial Tier Layouts: Built-in products like Pulse, Flow, Command, and Desk.
|
|
52
|
+

|
|
34
53
|
|
|
35
|
-
|
|
54
|
+
| Core Rendering | Prime Rendering |
|
|
55
|
+
| --- | --- |
|
|
56
|
+
|  |  |
|
|
57
|
+
|
|
58
|
+
### Installation
|
|
36
59
|
|
|
37
60
|
```bash
|
|
38
61
|
npm install tickup react react-dom styled-components
|
|
39
62
|
```
|
|
40
63
|
|
|
41
|
-
|
|
64
|
+
### Documentation
|
|
42
65
|
|
|
43
66
|
- [Quick Start Guide](./documentation/03-quick-start.md)
|
|
44
67
|
- [Imperative API Reference](./documentation/06-imperative-api.md)
|
|
45
68
|
- [Live Data & Updates](./documentation/07-data-and-live-updates.md)
|
|
46
69
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
Need the neon glow and advanced pro indicators? Check out [TickUp Prime](https://github.com/BARDAMRI/tickup-prime).
|
|
70
|
+
### π Take it to the next level with TickUp Prime
|
|
50
71
|
|
|
51
|
-
|
|
72
|
+
Interested in TickUp Prime? Visit our [Showcase](https://bardamri.github.io/tickup-charts/) to test it live or email us for a license key.
|
|
52
73
|
|
|
53
|
-
|
|
54
|
-
- Q3 2026: WebGL Rendering Engine for 1M+ points.
|
|
55
|
-
- Q4 2026: Collaborative Drawing Tools.
|
|
74
|
+
### Contact
|
|
56
75
|
|
|
57
|
-
|
|
76
|
+
[bardamri1702@gmail.com](mailto:bardamri1702@gmail.com) | [GitHub](https://github.com/BARDAMRI)
|