tickup 1.0.30 → 1.0.32
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 +54 -44
- package/dist/components/TickUpHost.d.ts +5 -1
- package/dist/tickup-full.cjs.js +232 -311
- package/dist/tickup-full.cjs.js.map +1 -0
- package/dist/tickup-full.es.js +236 -5589
- package/dist/tickup-full.es.js.map +1 -0
- package/dist/tickup.cjs.js +228 -307
- package/dist/tickup.cjs.js.map +1 -0
- package/dist/tickup.es.js +236 -5329
- package/dist/tickup.es.js.map +1 -0
- package/package.json +5 -3
package/README.md
CHANGED
|
@@ -1,68 +1,78 @@
|
|
|
1
|
-
|
|
2
|
-
<img src="https://raw.githubusercontent.com/BARDAMRI/tickup-charts/main/public/tickup-icon.svg" alt="TickUp logo" width="96" height="96" />
|
|
3
|
-
</p>
|
|
1
|
+
|
|
4
2
|
|
|
5
|
-
|
|
3
|
+
# TickUp Charts
|
|
6
4
|
|
|
7
|
-
|
|
5
|
+
[](https://www.npmjs.com/package/tickup)
|
|
6
|
+
[](https://github.com/BARDAMRI/tickup-charts/blob/main/LICENSE)
|
|
7
|
+
[](https://bundlephobia.com/package/tickup)
|
|
8
8
|
|
|
9
|
-
|
|
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>
|
|
9
|
+
High-performance, canvas-based financial charting engine for React.
|
|
14
10
|
|
|
15
|
-
|
|
11
|
+
|
|
16
12
|
|
|
17
|
-
|
|
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)
|
|
13
|
+
## Feature Highlights
|
|
19
14
|
|
|
20
|
-
|
|
15
|
+
- Canvas 2D rendering optimized for smooth pan/zoom and large data streams.
|
|
16
|
+
- Built-in indicators and overlays for practical market analysis workflows.
|
|
17
|
+
- RTL-ready chart interfaces for multilingual financial products.
|
|
18
|
+
- TypeScript-first API with imperative controls for advanced integrations.
|
|
21
19
|
|
|
22
|
-
|
|
23
|
-
|
|
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. |
|
|
27
|
-
|
|
28
|
-
### Standard vs Prime
|
|
20
|
+
## TickUp Lite (Core) vs TickUp Prime
|
|
29
21
|
|
|
30
22
|
| Feature | Standard (MIT) | Prime (Pro) |
|
|
31
|
-
|
|
|
23
|
+
| :--- | :--- | :--- |
|
|
32
24
|
| Engine | ✅ High-Speed Canvas 2D | 🚀 Ultra-Low Latency Rendering |
|
|
33
|
-
| Visuals | ✅ Standard Financial Styles | 💎
|
|
34
|
-
|
|
|
35
|
-
|
|
|
36
|
-
|
|
|
37
|
-
|
|
38
|
-
|
|
25
|
+
| Visuals | ✅ Standard Financial Styles | 💎 Neon Rendering Engine |
|
|
26
|
+
| Indicators | ✅ Core Indicator Set | 💎 Advanced Indicators (Fibonacci, Elliott) |
|
|
27
|
+
| Localization | ✅ LTR Support | 🚀 Full RTL + Professional i18n Workflows |
|
|
28
|
+
| License | ✅ MIT Open Source | 💎 Commercial License |
|
|
29
|
+
|
|
30
|
+
## Prime Evaluation State
|
|
31
|
+
|
|
32
|
+
When you run the Prime tier without an active license key, TickUp stays fully interactive for evaluation but clearly marks the session:
|
|
33
|
+
|
|
34
|
+
- An **Evaluation** badge appears in the Prime shell.
|
|
35
|
+
- The Prime view keeps a visible evaluation/watermark treatment until a valid key is applied.
|
|
39
36
|
|
|
40
|
-
|
|
37
|
+
This makes demos easy while keeping production licensing explicit.
|
|
41
38
|
|
|
42
|
-
|
|
39
|
+
## How to Upgrade
|
|
43
40
|
|
|
44
|
-
|
|
45
|
-
| --- | --- |
|
|
46
|
-
|  |  |
|
|
41
|
+
Ready for the Pro/Luxury Prime tier?
|
|
47
42
|
|
|
48
|
-
|
|
43
|
+
1. Explore the Prime offering: [TickUp Prime Repository](https://github.com/BARDAMRI/tickup-prime)
|
|
44
|
+
2. Try the live experience: [Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
45
|
+
3. Request a commercial license key for production use.
|
|
46
|
+
|
|
47
|
+
## Pricing & Licensing
|
|
48
|
+
|
|
49
|
+
| Plan | License | Best For | Price |
|
|
50
|
+
| :--- | :--- | :--- | :--- |
|
|
51
|
+
| Community | MIT | Open Source & Hobby Projects | Free |
|
|
52
|
+
| Professional | Commercial | Solo Founders & Small Teams | $99/yr |
|
|
53
|
+
| Enterprise | Custom | HFT Platforms, Brokerages, and Banks | Contact |
|
|
54
|
+
|
|
55
|
+
## Quick Start
|
|
49
56
|
|
|
50
57
|
```bash
|
|
51
58
|
npm install tickup react react-dom styled-components
|
|
52
59
|
```
|
|
53
60
|
|
|
54
|
-
|
|
61
|
+
```tsx
|
|
62
|
+
import { TickUpStage } from 'tickup';
|
|
55
63
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
### 🚀 Take it to the next level with TickUp Prime
|
|
64
|
+
export function App() {
|
|
65
|
+
return <TickUpStage intervalsArray={[]} />;
|
|
66
|
+
}
|
|
67
|
+
```
|
|
61
68
|
|
|
62
|
-
|
|
69
|
+
## Documentation
|
|
63
70
|
|
|
64
|
-
|
|
71
|
+
- [Documentation Hub](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/README.md)
|
|
72
|
+
- [Quick Start Guide](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/03-quick-start.md)
|
|
73
|
+
- [Imperative API Reference](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/06-imperative-api.md)
|
|
74
|
+
- [Live Data & Updates](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/07-data-and-live-updates.md)
|
|
65
75
|
|
|
66
|
-
|
|
76
|
+
## Prime CTA
|
|
67
77
|
|
|
68
|
-
[
|
|
78
|
+
Interested in TickUp Prime? Visit the live [Showcase](https://bardamri.github.io/tickup-charts/) to test it now, or review the [Prime repository](https://github.com/BARDAMRI/tickup-prime) for integration details.
|
|
@@ -131,8 +131,12 @@ export type TickUpHostProps = {
|
|
|
131
131
|
* Forced on for `productId="desk"`. Default true. Set false to disable branding.
|
|
132
132
|
*/
|
|
133
133
|
showAttribution?: boolean;
|
|
134
|
-
/** For `productId="prime"`:
|
|
134
|
+
/** For `productId="prime"`: candidate key passed into Prime validation. */
|
|
135
135
|
licenseKey?: string | null;
|
|
136
|
+
/** Optional user/account identifier paired with the Prime license key. */
|
|
137
|
+
licenseUserIdentifier?: string | null;
|
|
138
|
+
/** Optional override for Prime validation result. */
|
|
139
|
+
licenseValidationOverride?: boolean;
|
|
136
140
|
/**
|
|
137
141
|
* Shell **light** / **dark** (toolbar, settings modal chrome, `GlobalStyle` page background).
|
|
138
142
|
* When set, the host is **controlled**: update this prop when {@link onThemeVariantChange} fires
|