tickup 1.0.12 β†’ 1.0.30

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.
Files changed (22) hide show
  1. package/README.md +40 -29
  2. package/dist/tickup-full.cjs.js +282 -282
  3. package/dist/tickup-full.es.js +3388 -3397
  4. package/dist/tickup.cjs.js +275 -275
  5. package/dist/tickup.es.js +3595 -3598
  6. package/documentation/01-glossary.md +8 -0
  7. package/documentation/01-introduction.md +8 -0
  8. package/documentation/02-installation.md +8 -0
  9. package/documentation/03-quick-start.md +8 -0
  10. package/documentation/04-products-and-layout.md +8 -0
  11. package/documentation/05-props-and-chart-options.md +8 -0
  12. package/documentation/06-imperative-api.md +8 -0
  13. package/documentation/07-data-and-live-updates.md +8 -0
  14. package/documentation/08-drawings-and-shapes.md +8 -0
  15. package/documentation/09-settings-modal.md +8 -0
  16. package/documentation/10-toolbar-and-interactions.md +8 -0
  17. package/documentation/11-exports-and-advanced.md +8 -0
  18. package/documentation/12-overlays-and-indicators.md +8 -0
  19. package/documentation/13-internationalization-and-axes.md +8 -0
  20. package/documentation/14-legal-and-policies.md +8 -0
  21. package/documentation/README.md +8 -0
  22. package/package.json +5 -27
package/README.md CHANGED
@@ -1,57 +1,68 @@
1
- # πŸš€ TickUp Charts
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
- ## High-Performance React Financial Charts for the Modern Web
5
+ <h1 align="center">TickUp Charts</h1>
4
6
 
5
- **Live Demo & Docs:** [View Live Showcase](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/README.md)
7
+ <p align="center"><strong>The High-Performance Canvas Engine for Modern Financial Apps.</strong></p>
6
8
 
7
- TickUp is a lightning-fast, Canvas 2D-based charting library for React. Built for speed and precision, it handles thousands of data points with zero lag, providing a professional trading experience out of the box.
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
- ## 🌐 VIEW LIVE SHOWCASE & DOCUMENTATION
15
+ ### Live Demo & Documentation
10
16
 
11
- [Experience the performance and explore the full API documentation.](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/README.md)
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
- ## πŸ“Έ Visual Showcase
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
- ### πŸ’Ž The Prime Experience
22
+ ### Why TickUp
16
23
 
17
- The optional Prime engine adds high-fidelity neon aesthetics and professional rendering profiles.
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
- ![Prime Hero](https://raw.githubusercontent.com/BARDAMRI/tickup-charts/main/assets/showcase/hero-prime-neon.png)
28
+ ### Standard vs Prime
20
29
 
21
- ### πŸ“Š Core vs. Prime
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
- | Standard Core | Prime Turbo Mode |
24
- | --- | --- |
25
- | Clean, functional, and fast. | Neon glow, pro indicators, and high-density mode. |
26
- | ![Core](https://raw.githubusercontent.com/BARDAMRI/tickup-charts/main/assets/showcase/compare-standard.png) | ![Prime](https://raw.githubusercontent.com/BARDAMRI/tickup-charts/main/assets/showcase/compare-prime.png) |
40
+ ### Visual Showcase
27
41
 
28
- ## ✨ Key Features
42
+ ![Prime Hero](https://raw.githubusercontent.com/BARDAMRI/tickup-charts/main/assets/showcase/hero-prime-neon.png)
29
43
 
30
- - Canvas 2D Engine: Ultra-smooth rendering without WebGL complexity.
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.
44
+ | Core Rendering | Prime Rendering |
45
+ | --- | --- |
46
+ | ![Core](https://raw.githubusercontent.com/BARDAMRI/tickup-charts/main/assets/showcase/compare-standard.png) | ![Prime](https://raw.githubusercontent.com/BARDAMRI/tickup-charts/main/assets/showcase/compare-prime.png) |
34
47
 
35
- ## πŸ› οΈ Quick Start
48
+ ### Installation
36
49
 
37
50
  ```bash
38
51
  npm install tickup react react-dom styled-components
39
52
  ```
40
53
 
41
- ## πŸ“– Documentation
54
+ ### Documentation
42
55
 
43
56
  - [Quick Start Guide](./documentation/03-quick-start.md)
44
57
  - [Imperative API Reference](./documentation/06-imperative-api.md)
45
58
  - [Live Data & Updates](./documentation/07-data-and-live-updates.md)
46
59
 
47
- ## πŸ’Ž Go Premium
60
+ ### πŸš€ Take it to the next level with TickUp Prime
48
61
 
49
- Need the neon glow and advanced pro indicators? Check out [TickUp Prime](https://github.com/BARDAMRI/tickup-prime).
62
+ Explore the Prime Showcase on GitHub Pages: [https://bardamri.github.io/tickup-charts/](https://bardamri.github.io/tickup-charts/)
50
63
 
51
- ## πŸ—ΊοΈ Roadmap
64
+ Experience the glowing shaders and professional analysis suite in our live demo.
52
65
 
53
- - Q2 2026: Advanced Indicators (Ichimoku, SuperTrend).
54
- - Q3 2026: WebGL Rendering Engine for 1M+ points.
55
- - Q4 2026: Collaborative Drawing Tools.
66
+ ### Contact
56
67
 
57
- Contact: [bardamri1702@gmail.com](mailto:bardamri1702@gmail.com) | [GitHub](https://github.com/BARDAMRI)
68
+ [bardamri1702@gmail.com](mailto:bardamri1702@gmail.com) | [GitHub](https://github.com/BARDAMRI)