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.
- package/README.md +40 -29
- package/dist/tickup-full.cjs.js +282 -282
- package/dist/tickup-full.es.js +3388 -3397
- package/dist/tickup.cjs.js +275 -275
- package/dist/tickup.es.js +3595 -3598
- 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 -27
|
@@ -59,3 +59,11 @@ Internal drawing **mode** (toolbar) toggles between none, draw tools, select, an
|
|
|
59
59
|
|
|
60
60
|
- **Trading session** — Recurring weekday window (`dayOfWeek` + `HH:mm` start/end) used to dim time outside regular hours.
|
|
61
61
|
- **Holiday** — ISO date string list for calendar-aware behavior where applied.
|
|
62
|
+
|
|
63
|
+
### Pro Tip
|
|
64
|
+
|
|
65
|
+
Prime-only terms (advanced analysis packs, premium engines, and commercial licensing) are easiest to evaluate side-by-side in the live showcase before rollout planning.
|
|
66
|
+
|
|
67
|
+
### Prime Showcase
|
|
68
|
+
|
|
69
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
@@ -5,3 +5,11 @@ TickUp is a high-performance React charting library for financial OHLCV workflow
|
|
|
5
5
|
You can start with the open-source core package for charting, drawing tools, overlays, and streaming data, then move to the **Prime Engine** as the professional upgrade path when you need premium visual rendering profiles and advanced Pro capabilities.
|
|
6
6
|
|
|
7
7
|
For onboarding, continue to [Installation](./02-installation.md) and [Quick start](./03-quick-start.md).
|
|
8
|
+
|
|
9
|
+
### Pro Tip
|
|
10
|
+
|
|
11
|
+
TickUp Prime is the fastest path to premium visuals and advanced analysis workflows when your product moves from MVP to production-grade trading UX.
|
|
12
|
+
|
|
13
|
+
### Prime Showcase
|
|
14
|
+
|
|
15
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
@@ -46,3 +46,11 @@ export function SmokeTest() {
|
|
|
46
46
|
```
|
|
47
47
|
|
|
48
48
|
You still need to pass `intervalsArray` (can be `[]` for an empty chart). See [Quick start](./03-quick-start.md).
|
|
49
|
+
|
|
50
|
+
### Pro Tip
|
|
51
|
+
|
|
52
|
+
Start with the MIT core install for development, then upgrade to TickUp Prime in production environments that require advanced visuals and commercial Pro tooling.
|
|
53
|
+
|
|
54
|
+
### Prime Showcase
|
|
55
|
+
|
|
56
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
@@ -84,3 +84,11 @@ See [Props & chart options](./05-props-and-chart-options.md).
|
|
|
84
84
|
|
|
85
85
|
- [Products & layout](./04-products-and-layout.md) — choose the right tier
|
|
86
86
|
- [Imperative API](./06-imperative-api.md) — full ref surface
|
|
87
|
+
|
|
88
|
+
### Pro Tip
|
|
89
|
+
|
|
90
|
+
Use the same host integration from this guide with Prime enabled to unlock premium rendering profiles without rewriting your app shell.
|
|
91
|
+
|
|
92
|
+
### Prime Showcase
|
|
93
|
+
|
|
94
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
@@ -49,3 +49,11 @@ Then you control which chrome appears. Settings saved in the modal still respect
|
|
|
49
49
|
## Mode provider
|
|
50
50
|
|
|
51
51
|
The shell wraps children in **`ModeProvider`** internally. If you use **`TickUpStage`** alone (advanced), wrap with `ModeProvider` yourself. See [Exports & advanced](./11-exports-and-advanced.md).
|
|
52
|
+
|
|
53
|
+
### Pro Tip
|
|
54
|
+
|
|
55
|
+
Prime tiers are ideal when you need a product-ready trader layout with premium visuals and minimal custom chrome development.
|
|
56
|
+
|
|
57
|
+
### Prime Showcase
|
|
58
|
+
|
|
59
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
@@ -107,3 +107,11 @@ See [Overlays & indicators](./12-overlays-and-indicators.md).
|
|
|
107
107
|
Under `base.style.drawings`: line color, width, line style, fill, and **selected** state styling.
|
|
108
108
|
|
|
109
109
|
See also existing reference: [`docs/Documentation/ChartStyleOptions.md`](../docs/Documentation/ChartStyleOptions.md) if present for extra detail; defaults live in `src/components/DefaultData.ts`.
|
|
110
|
+
|
|
111
|
+
### Pro Tip
|
|
112
|
+
|
|
113
|
+
Keep your `chartOptions` stable in core, then layer Prime engine patches for premium rendering without changing your component contracts.
|
|
114
|
+
|
|
115
|
+
### Prime Showcase
|
|
116
|
+
|
|
117
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
@@ -115,3 +115,11 @@ chartRef.current?.updateSelectedShape({
|
|
|
115
115
|
// 3. Clear focus
|
|
116
116
|
chartRef.current?.unselectShape();
|
|
117
117
|
```
|
|
118
|
+
|
|
119
|
+
### Pro Tip
|
|
120
|
+
|
|
121
|
+
Prime workflows benefit most from the imperative API when you need precise runtime control over rendering mode, overlays, and drawing orchestration.
|
|
122
|
+
|
|
123
|
+
### Prime Showcase
|
|
124
|
+
|
|
125
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
@@ -60,3 +60,11 @@ Use **`onIntervalSearch(tf)`** on the `TickUpHost` to intercept these changes. T
|
|
|
60
60
|
|
|
61
61
|
- Do not pass a **new literal** `chartOptions={{}}` every render without `useMemo`; see [Props & chart options](./05-props-and-chart-options.md).
|
|
62
62
|
- Ensure `t` is monotonic where your feed requires it; merge modes handle ordering differently.
|
|
63
|
+
|
|
64
|
+
### Pro Tip
|
|
65
|
+
|
|
66
|
+
Prime deployments pair live merge flows with high-density rendering profiles to keep interaction smooth on larger streaming datasets.
|
|
67
|
+
|
|
68
|
+
### Prime Showcase
|
|
69
|
+
|
|
70
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
@@ -130,3 +130,11 @@ chartRef.current?.updateSelectedShape({
|
|
|
130
130
|
## Shape properties UI
|
|
131
131
|
|
|
132
132
|
`ShapePropertiesModal` is exported for advanced hosts who want to embed the same form outside the default flow. The shell wires it from the chart when editing.
|
|
133
|
+
|
|
134
|
+
### Pro Tip
|
|
135
|
+
|
|
136
|
+
Note: Advanced drawing tools like Fibonacci Retracements are available exclusively in TickUp Prime.
|
|
137
|
+
|
|
138
|
+
### Prime Showcase
|
|
139
|
+
|
|
140
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
@@ -35,3 +35,11 @@ Several toggles map to `chartOptions.base` and `base.style`:
|
|
|
35
35
|
- `showCandleTooltip`, `showCrosshair`, `showCrosshairValues`
|
|
36
36
|
- `showHistogram`, `showGrid`
|
|
37
37
|
- Axes, colors, drawings defaults as described in [Props & chart options](./05-props-and-chart-options.md).
|
|
38
|
+
|
|
39
|
+
### Pro Tip
|
|
40
|
+
|
|
41
|
+
Use settings parity between Standard and Prime during QA, then enable Prime-only visual profiles per workspace or account tier.
|
|
42
|
+
|
|
43
|
+
### Prime Showcase
|
|
44
|
+
|
|
45
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
@@ -83,3 +83,11 @@ From back to front: main OHLC (and grid, session shading, watermark), optional h
|
|
|
83
83
|
## Copy
|
|
84
84
|
|
|
85
85
|
Selected axis or formatted numbers may normalize to clipboard-friendly representation when copying from the app (formatting service integration).
|
|
86
|
+
|
|
87
|
+
### Pro Tip
|
|
88
|
+
|
|
89
|
+
Prime users get the most value from interaction-heavy views where precision drawing and premium rendering run together under active market feeds.
|
|
90
|
+
|
|
91
|
+
### Prime Showcase
|
|
92
|
+
|
|
93
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
@@ -140,3 +140,11 @@ Wrap with **`ModeProvider`**. Pass **all** required `TickUpStageProps` from Type
|
|
|
140
140
|
## Deprecated
|
|
141
141
|
|
|
142
142
|
- `ChartStage`, `ChartStageProps`, `ChartStageHandle` → use `TickUpStage*`.
|
|
143
|
+
|
|
144
|
+
### Pro Tip
|
|
145
|
+
|
|
146
|
+
Build on core exports first, then adopt Prime engine helpers to add premium behavior while preserving your existing API integration.
|
|
147
|
+
|
|
148
|
+
### Prime Showcase
|
|
149
|
+
|
|
150
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
@@ -63,3 +63,11 @@ Lower-level functions such as `computeSeriesBySpec`, `drawOverlays`, `drawOverla
|
|
|
63
63
|
## Chart types
|
|
64
64
|
|
|
65
65
|
Overlays are wired in **candlestick**, **line**, **area**, and **bar** draw paths when `showOverlayLine` is true.
|
|
66
|
+
|
|
67
|
+
### Pro Tip
|
|
68
|
+
|
|
69
|
+
Prime indicator packs are designed for desks that need richer multi-study analysis than the standard open-source baseline.
|
|
70
|
+
|
|
71
|
+
### Prime Showcase
|
|
72
|
+
|
|
73
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
@@ -54,3 +54,11 @@ Axes support:
|
|
|
54
54
|
## Clipboard (shell behavior)
|
|
55
55
|
|
|
56
56
|
When users copy selected text, the host shell may **normalize** numbers to a canonical plain form using the same axis parsing rules (implemented inside the chart app wrapper). This is a UX nicety for spreadsheets, not a separate public API export.
|
|
57
|
+
|
|
58
|
+
### Pro Tip
|
|
59
|
+
|
|
60
|
+
TickUp Prime is the right upgrade path for teams that need production-grade multilingual interfaces with advanced layout and rendering requirements.
|
|
61
|
+
|
|
62
|
+
### Prime Showcase
|
|
63
|
+
|
|
64
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
|
@@ -30,3 +30,11 @@ These markdown files are **starting points**, not a substitute for counsel. Repl
|
|
|
30
30
|
## Older stub
|
|
31
31
|
|
|
32
32
|
A short legacy note lives in the repo under **`docs/Documentation/Terms_of_Use.md`** (that tree is **not** bundled on npm). [View on GitHub](https://github.com/BARDAMRI/TickUp/blob/main/docs/Documentation/Terms_of_Use.md) — it points here and to **`legal/`**.
|
|
33
|
+
|
|
34
|
+
### Pro Tip
|
|
35
|
+
|
|
36
|
+
Commercial Prime deployments should always pair technical rollout with the appropriate legal terms and policy templates for hosted services.
|
|
37
|
+
|
|
38
|
+
### Prime Showcase
|
|
39
|
+
|
|
40
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
package/documentation/README.md
CHANGED
|
@@ -31,3 +31,11 @@ The **reference example app** in [`../example/`](../example/) (Vite + React) exe
|
|
|
31
31
|
## Older material
|
|
32
32
|
|
|
33
33
|
Additional notes and legacy pages may still live under [`../docs/`](../docs/) (roadmap, contributing, design). The **authoritative integration reference** is this `documentation/` folder.
|
|
34
|
+
|
|
35
|
+
### Pro Tip
|
|
36
|
+
|
|
37
|
+
Use this docs hub for core integration, then evaluate TickUp Prime for teams that require premium rendering profiles and commercial-grade analysis workflows.
|
|
38
|
+
|
|
39
|
+
### Prime Showcase
|
|
40
|
+
|
|
41
|
+
[Explore the TickUp Prime Showcase](https://bardamri.github.io/tickup-charts/)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tickup",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.30",
|
|
4
4
|
"description": "High-performance React financial charts. Canvas 2D rendering, advanced technical analysis tools, and real-time data streaming.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/tickup.cjs.js",
|
|
@@ -38,34 +38,12 @@
|
|
|
38
38
|
"combine-code": "node combineFiles.cjs",
|
|
39
39
|
"test": "jest"
|
|
40
40
|
},
|
|
41
|
-
"keywords": [
|
|
42
|
-
"tickup",
|
|
43
|
-
"react",
|
|
44
|
-
"fintech",
|
|
45
|
-
"canvas-2d",
|
|
46
|
-
"financial-visualization",
|
|
47
|
-
"chart",
|
|
48
|
-
"charts",
|
|
49
|
-
"financial",
|
|
50
|
-
"investments",
|
|
51
|
-
"money",
|
|
52
|
-
"charting",
|
|
53
|
-
"analysis",
|
|
54
|
-
"candlestick",
|
|
55
|
-
"ohlc",
|
|
56
|
-
"ohlcv",
|
|
57
|
-
"trading",
|
|
58
|
-
"canvas",
|
|
59
|
-
"stock",
|
|
60
|
-
"crypto",
|
|
61
|
-
"typescript"
|
|
62
|
-
],
|
|
63
41
|
"author": "Bar Damri",
|
|
64
42
|
"license": "MIT",
|
|
65
|
-
"homepage": "https://
|
|
43
|
+
"homepage": "https://bardamri.github.io/tickup-charts/",
|
|
66
44
|
"repository": {
|
|
67
45
|
"type": "git",
|
|
68
|
-
"url": "https://github.com/BARDAMRI/tickup-charts"
|
|
46
|
+
"url": "git+https://github.com/BARDAMRI/tickup-charts.git"
|
|
69
47
|
},
|
|
70
48
|
"bugs": {
|
|
71
49
|
"url": "https://github.com/BARDAMRI/tickup-charts/issues"
|
|
@@ -74,7 +52,7 @@
|
|
|
74
52
|
"access": "public"
|
|
75
53
|
},
|
|
76
54
|
"engines": {
|
|
77
|
-
"node": ">=
|
|
55
|
+
"node": ">=22.14.0"
|
|
78
56
|
},
|
|
79
57
|
"peerDependencies": {
|
|
80
58
|
"react": "^18.0.0 || ^19.0.0",
|
|
@@ -100,4 +78,4 @@
|
|
|
100
78
|
"date-fns": "^4.1.0",
|
|
101
79
|
"lucide-react": "^0.541.0"
|
|
102
80
|
}
|
|
103
|
-
}
|
|
81
|
+
}
|