@simahfud/klinecharts-pro 1.0.0

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/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,462 @@
1
+ # KLineChart Pro
2
+
3
+ [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
4
+ [![KLineChart](https://img.shields.io/badge/based%20on-KLineChart-orange)](https://github.com/liihuu/KLineChart)
5
+
6
+ A professional-grade, TradingView-inspired charting component built on [KLineChart](https://github.com/liihuu/KLineChart), powered by **SolidJS**. Features 25 built-in drawing tools, bar replay, keyboard shortcuts, multi-chart type support, and a complete custom tool API.
7
+
8
+ > ๐Ÿ”— **Repository**: [github.com/SiMahfud/klinechartpro](https://github.com/SiMahfud/klinechartpro)
9
+ > ๐Ÿ“ฆ Forked from [klinecharts/pro](https://github.com/klinecharts/pro)
10
+
11
+ ---
12
+
13
+ ## โœจ Features
14
+
15
+ ### Core
16
+ - ๐Ÿ“Š Built on KLineChart with SolidJS rendering
17
+ - ๐ŸŽจ Light & Dark themes with CSS custom properties
18
+ - ๐ŸŒ 5 locales: Chinese, English, Indonesian, Japanese, Korean
19
+ - ๐Ÿ’พ Data persistence via localStorage (symbols, periods, indicators, drawings)
20
+ - ๐Ÿ”” Price alert system with browser notifications
21
+ - ๐Ÿ“ˆ Multi-symbol comparison mode
22
+ - โšก Performance monitoring panel (FPS, memory, WS latency)
23
+ - โ™ฟ Full modal accessibility (focus trap, keyboard nav, ARIA)
24
+ - ๐Ÿ“ฑ Responsive layout with mobile support
25
+
26
+ ### Chart Types (6 types)
27
+
28
+ | Type | Key | Description |
29
+ |---|---|---|
30
+ | **Candles** | `candle_solid` | Standard filled candlestick (default) |
31
+ | **Hollow Candles** | `candle_stroke` | All candles outlined |
32
+ | **Up Hollow** | `candle_up_stroke` | Up candles hollow, down filled |
33
+ | **Down Hollow** | `candle_down_stroke` | Down candles hollow, up filled |
34
+ | **OHLC Bars** | `ohlc` | Traditional open-high-low-close bars |
35
+ | **Area** | `area` | Filled area chart |
36
+
37
+ ### Drawing Tools (25 built-in)
38
+
39
+ | Category | Tools |
40
+ |---|---|
41
+ | **Lines** | Horizontal/Vertical (straight, ray, segment), Trend Line, Ray, Segment, Arrow, Price Line |
42
+ | **Channels** | Price Channel, Parallel Line |
43
+ | **Shapes** | Circle, Rectangle, Parallelogram, Triangle |
44
+ | **Fibonacci** | Line, Segment, Circle, Spiral, Fan, Extension |
45
+ | **Gann** | Gann Box |
46
+ | **Waves** | XABCD, ABCD, 3-Wave, 5-Wave, 8-Wave, Any Wave |
47
+ | **Trading** | Long Position, Short Position, Measure Tool |
48
+ | **Annotation** | Volume Profile (FRVP), Price Range, Text Note, Anchored VWAP, Price Label |
49
+
50
+ ### Technical Indicators (26 built-in)
51
+
52
+ **Main chart:** MA, EMA, SMA, BOLL, SAR, BBI
53
+ **Sub chart:** VOL, MACD, KDJ, RSI, BIAS, BRAR, CCI, DMI, CR, PSY, DMA, TRIX, OBV, VR, WR, MTM, EMV, ROC, PVT, AO
54
+
55
+ ### Advanced Features
56
+
57
+ | Feature | Description |
58
+ |---|---|
59
+ | **โฏ Bar Replay** | Step through historical data bar by bar with play/pause/speed controls |
60
+ | **โŒจ๏ธ Keyboard Shortcuts** | Configurable hotkeys for all chart operations |
61
+ | **๐ŸŒณ Object Tree** | Manage all drawings โ€” toggle visibility, select, delete |
62
+ | **๐Ÿ’พ Chart Templates** | Save/load indicator + style presets via localStorage |
63
+ | **๐Ÿท๏ธ Price Labels** | Custom price markers on Y-axis |
64
+ | **๐Ÿ”— Crosshair Sync** | Synchronize crosshair across multiple chart instances |
65
+ | **๐ŸŽจ Style Editor** | Edit drawing properties (color, width, style) via right-click |
66
+ | **๐Ÿ“‹ Context Menu** | Right-click overlay menu with Edit/Hide/Delete actions |
67
+ | **๐Ÿ“Š Chart Type Selector** | Switch between 6 chart types from the toolbar |
68
+
69
+ ---
70
+
71
+ ## ๐Ÿ“ฆ Installation
72
+
73
+ ### Using npm
74
+
75
+ ```bash
76
+ npm install klinecharts @klinecharts/pro
77
+ ```
78
+
79
+ ### Using unpkg or jsDelivr (CDN)
80
+
81
+ The library is published as a UMD bundle, so you can load it directly via `<script>` tags:
82
+
83
+ ```html
84
+ <!-- KLineChart (dependency, must be loaded first) -->
85
+ <script src="https://unpkg.com/klinecharts/dist/klinecharts.min.js"></script>
86
+
87
+ <!-- KLineChart Pro -->
88
+ <!-- using unpkg -->
89
+ <script src="https://unpkg.com/@klinecharts/pro/dist/klinecharts-pro.umd.js"></script>
90
+ <!-- OR using jsDelivr -->
91
+ <script src="https://cdn.jsdelivr.net/npm/@klinecharts/pro/dist/klinecharts-pro.umd.js"></script>
92
+
93
+ <!-- CSS styles (required) -->
94
+ <link rel="stylesheet" href="https://unpkg.com/@klinecharts/pro/dist/klinecharts-pro.css" />
95
+ ```
96
+
97
+ After loading, the global variable `klinechartspro` is available:
98
+
99
+ ```html
100
+ <!DOCTYPE html>
101
+ <html>
102
+ <head>
103
+ <link rel="stylesheet" href="https://unpkg.com/@klinecharts/pro/dist/klinecharts-pro.css" />
104
+ </head>
105
+ <body>
106
+ <div id="chart-container" style="width:100%;height:600px;"></div>
107
+
108
+ <script src="https://unpkg.com/klinecharts/dist/klinecharts.min.js"></script>
109
+ <script src="https://unpkg.com/@klinecharts/pro/dist/klinecharts-pro.umd.js"></script>
110
+ <script>
111
+ // Access via global: klinechartspro
112
+ const { KLineChartPro, DefaultDatafeed } = klinechartspro
113
+
114
+ const chart = new KLineChartPro({
115
+ container: document.getElementById('chart-container'),
116
+ symbol: { ticker: 'AAPL', name: 'Apple Inc.', market: 'stocks' },
117
+ period: { multiplier: 1, timespan: 'day', text: 'D' },
118
+ datafeed: new DefaultDatafeed('YOUR_POLYGON_API_KEY'),
119
+ theme: 'dark',
120
+ locale: 'en-US'
121
+ })
122
+ </script>
123
+ </body>
124
+ </html>
125
+ ```
126
+
127
+ > **๐Ÿ’ก Note**: For your fork, after running `npm run build-core`, the `dist/` folder will contain your customized UMD/ES bundles. You can self-host these files or publish to npm to use via CDN.
128
+
129
+ ### Building from source
130
+
131
+ ```bash
132
+ git clone https://github.com/SiMahfud/klinechartpro.git
133
+ cd klinechartpro
134
+ npm install
135
+ npm run build-core # โ†’ dist/klinecharts-pro.umd.js + klinecharts-pro.js + klinecharts-pro.css
136
+ ```
137
+
138
+ ---
139
+
140
+ ## ๐Ÿš€ Quick Start
141
+
142
+ ```typescript
143
+ import { KLineChartPro, DefaultDatafeed } from 'klinecharts-pro'
144
+
145
+ const chart = new KLineChartPro({
146
+ container: 'chart-container',
147
+ symbol: { ticker: 'AAPL', name: 'Apple Inc.', market: 'stocks' },
148
+ period: { multiplier: 1, timespan: 'day', text: 'D' },
149
+ datafeed: new DefaultDatafeed('YOUR_POLYGON_API_KEY'),
150
+ theme: 'dark',
151
+ locale: 'en-US'
152
+ })
153
+
154
+ // Wait for chart to be ready before calling methods
155
+ await chart.ready()
156
+ console.log('Chart initialized:', chart.getSymbol())
157
+ ```
158
+
159
+ ---
160
+
161
+ ## ๐Ÿ”ง API Reference
162
+
163
+ ### Core Methods
164
+
165
+ ```typescript
166
+ // Theme
167
+ chart.setTheme('dark') // 'dark' | 'light'
168
+ chart.getTheme()
169
+
170
+ // Locale
171
+ chart.setLocale('en-US') // 'en-US' | 'zh-CN' | 'id-ID' | 'ja-JP' | 'ko-KR'
172
+ chart.getLocale()
173
+
174
+ // Symbol & Period
175
+ chart.setSymbol({ ticker: 'MSFT', name: 'Microsoft' })
176
+ chart.getSymbol()
177
+ chart.setPeriod({ multiplier: 5, timespan: 'minute', text: '5m' })
178
+ chart.getPeriod()
179
+
180
+ // Timezone
181
+ chart.setTimezone('Asia/Jakarta')
182
+ chart.getTimezone()
183
+
184
+ // Styles (deep partial merge)
185
+ chart.setStyles({ candle: { bar: { upColor: '#26A69A' } } })
186
+ chart.getStyles()
187
+ ```
188
+
189
+ ### Chart Type
190
+
191
+ ```typescript
192
+ // Switch chart type
193
+ chart.setChartType('ohlc') // candle_solid | candle_stroke | candle_up_stroke | candle_down_stroke | ohlc | area
194
+ chart.getChartType() // Returns current type
195
+ ```
196
+
197
+ ### Bar Replay
198
+
199
+ ```typescript
200
+ // Start replay using current chart data
201
+ chart.startReplay('current')
202
+
203
+ // Or start replay loading custom historical data
204
+ chart.startReplay('custom')
205
+
206
+ // Stop and restore original data
207
+ chart.stopReplay()
208
+ ```
209
+
210
+ **Programmatic control via `BarReplayManager`:**
211
+
212
+ ```typescript
213
+ import { BarReplayManager } from 'klinecharts-pro'
214
+
215
+ const replay = new BarReplayManager(chartWidget, datafeed)
216
+
217
+ replay.setHandlers({
218
+ onStep: (index, total, bar) => console.log(`${index}/${total}`),
219
+ onPlay: () => console.log('Playing'),
220
+ onPause: () => console.log('Paused'),
221
+ onEnd: () => console.log('Replay ended'),
222
+ onStatusChange: (status) => console.log('Status:', status)
223
+ })
224
+
225
+ await replay.start({ dataSource: 'current', speed: 500, startFrom: 0 })
226
+
227
+ // Controls
228
+ replay.play() // Auto-advance
229
+ replay.pause() // Pause
230
+ replay.stepForward() // Next bar
231
+ replay.stepBackward() // Previous bar
232
+ replay.seekTo(50) // Jump to index
233
+ replay.setSpeed(100) // 100ms per bar
234
+
235
+ // State
236
+ replay.getStatus() // 'idle' | 'playing' | 'paused' | 'ended'
237
+ replay.getIndex() // Current position
238
+ replay.getTotal() // Total bars
239
+
240
+ // Cleanup
241
+ replay.stop() // Restore original data
242
+ replay.destroy() // Full cleanup
243
+ ```
244
+
245
+ ### Object Tree & Style Editor
246
+
247
+ ```typescript
248
+ // Open Object Tree modal (lists all overlays)
249
+ chart.showObjectTree()
250
+
251
+ // Open Style Editor for a specific overlay
252
+ chart.showStyleEditor('overlay_id_123')
253
+ ```
254
+
255
+ ### Keyboard Shortcuts
256
+
257
+ ```typescript
258
+ import { KeyboardShortcutManager } from 'klinecharts-pro'
259
+
260
+ const shortcuts = new KeyboardShortcutManager(containerElement)
261
+
262
+ shortcuts.register({ key: 'ctrl+z', description: 'Undo', callback: () => drawings.undo() })
263
+ shortcuts.register({ key: 'ctrl+y', description: 'Redo', callback: () => drawings.redo() })
264
+ shortcuts.register({ key: 'delete', callback: () => chart.removeOverlay() })
265
+ shortcuts.register({ key: 'escape', callback: () => chart.removeOverlay() })
266
+
267
+ // Disable during modals
268
+ shortcuts.setEnabled(false)
269
+ shortcuts.setEnabled(true)
270
+
271
+ shortcuts.destroy()
272
+ ```
273
+
274
+ ### Chart Templates
275
+
276
+ ```typescript
277
+ import { ChartTemplateManager } from 'klinecharts-pro'
278
+
279
+ const templates = new ChartTemplateManager(chartStore)
280
+
281
+ // Save current configuration
282
+ templates.saveTemplate({
283
+ name: 'My Scalping Setup',
284
+ mainIndicators: ['EMA', 'BOLL'],
285
+ subIndicators: ['RSI', 'MACD'],
286
+ theme: 'dark',
287
+ period: { multiplier: 5, timespan: 'minute', text: '5m' },
288
+ createdAt: Date.now()
289
+ })
290
+
291
+ // List and load
292
+ templates.getTemplateNames() // ['My Scalping Setup']
293
+ const tmpl = templates.loadTemplate('My Scalping Setup')
294
+
295
+ // Delete
296
+ templates.deleteTemplate('My Scalping Setup')
297
+ ```
298
+
299
+ ### Crosshair Sync
300
+
301
+ ```typescript
302
+ import { CrosshairSyncManager } from 'klinecharts-pro'
303
+
304
+ const sync = new CrosshairSyncManager()
305
+
306
+ sync.addChart(chart1)
307
+ sync.addChart(chart2)
308
+ // Moving crosshair on chart1 now moves it on chart2 and vice versa
309
+
310
+ sync.removeChart(chart1)
311
+ sync.destroy()
312
+ ```
313
+
314
+ ### Custom Indicators & Overlays
315
+
316
+ ```typescript
317
+ import { registerCustomIndicator, registerCustomOverlay } from 'klinecharts-pro'
318
+
319
+ // Register a custom indicator (auto-appears in Indicator menu)
320
+ registerCustomIndicator({
321
+ template: { name: 'MyRSI', calc: (dataList) => { /* ... */ }, figures: [{ key: 'value', type: 'line' }] },
322
+ label: 'My Custom RSI',
323
+ paneType: 'sub'
324
+ })
325
+
326
+ // Register a custom overlay (auto-appears in Drawing menu)
327
+ registerCustomOverlay({
328
+ template: { name: 'myTool', totalStep: 2, createPointFigures: (params) => { /* ... */ } },
329
+ label: 'My Tool'
330
+ })
331
+ ```
332
+
333
+ ### Price Alerts
334
+
335
+ ```typescript
336
+ chart.setAlert({ id: 'alert1', price: 150.00, condition: 'crosses_above', symbol: 'AAPL' })
337
+ chart.getAlerts()
338
+ chart.removeAlert('alert1')
339
+ ```
340
+
341
+ ### Multi-Symbol Comparison
342
+
343
+ ```typescript
344
+ import { ComparisonManager } from 'klinecharts-pro'
345
+
346
+ const comparison = new ComparisonManager(chartWidget, datafeed)
347
+ await comparison.addSymbol({ ticker: 'MSFT' }, period, from, to)
348
+ comparison.getSymbols()
349
+ comparison.toggleVisibility('MSFT')
350
+ comparison.removeSymbol('MSFT')
351
+ comparison.destroy()
352
+ ```
353
+
354
+ ---
355
+
356
+ ## ๐Ÿ“Š DefaultDatafeed
357
+
358
+ ```typescript
359
+ import { DefaultDatafeed } from 'klinecharts-pro'
360
+
361
+ // Uses Polygon.io API
362
+ const datafeed = new DefaultDatafeed('YOUR_API_KEY')
363
+ ```
364
+
365
+ Implements the `Datafeed` interface:
366
+
367
+ ```typescript
368
+ interface Datafeed {
369
+ searchSymbols(search?: string): Promise<SymbolInfo[]>
370
+ getHistoryKLineData(symbol: SymbolInfo, period: Period, from: number, to: number): Promise<KLineData[]>
371
+ subscribe(symbol: SymbolInfo, period: Period, callback: DatafeedSubscribeCallback): void
372
+ unsubscribe(symbol: SymbolInfo, period: Period): void
373
+ }
374
+ ```
375
+
376
+ ---
377
+
378
+ ## ๐Ÿ— Architecture
379
+
380
+ ```
381
+ src/
382
+ โ”œโ”€โ”€ index.ts # Entry point + exports
383
+ โ”œโ”€โ”€ KLineChartPro.tsx # Main class (lifecycle, API)
384
+ โ”œโ”€โ”€ ChartProComponent.tsx # SolidJS component (all UI wiring)
385
+ โ”œโ”€โ”€ types.ts # TypeScript interfaces
386
+ โ”œโ”€โ”€ config.ts # Shared constants
387
+ โ”œโ”€โ”€ registry.ts # Custom tool registry (auto-menu)
388
+ โ”œโ”€โ”€ error.ts # Error handling system
389
+ โ”œโ”€โ”€ store.ts # localStorage persistence
390
+ โ”œโ”€โ”€ drawing-store.ts # Undo/redo + drawing persistence
391
+ โ”œโ”€โ”€ comparison.ts # Multi-symbol comparison
392
+ โ”œโ”€โ”€ bar-replay.ts # Bar replay engine
393
+ โ”œโ”€โ”€ keyboard-shortcuts.ts # Keyboard shortcut manager
394
+ โ”œโ”€โ”€ chart-template.ts # Template save/load
395
+ โ”œโ”€โ”€ crosshair-sync.ts # Multi-chart crosshair sync
396
+ โ”œโ”€โ”€ DefaultDatafeed.ts # Polygon.io data feed
397
+ โ”œโ”€โ”€ i18n/ # 5 locale files (168+ keys each)
398
+ โ”œโ”€โ”€ extension/ # 25 overlay templates
399
+ โ”‚ โ”œโ”€โ”€ longPosition.ts # Long Position tool
400
+ โ”‚ โ”œโ”€โ”€ shortPosition.ts # Short Position tool
401
+ โ”‚ โ”œโ”€โ”€ frvp.ts # Volume Profile
402
+ โ”‚ โ”œโ”€โ”€ measure.ts # Measure tool
403
+ โ”‚ โ”œโ”€โ”€ priceRange.ts # Price Range zone
404
+ โ”‚ โ”œโ”€โ”€ textNote.ts # Text annotation
405
+ โ”‚ โ”œโ”€โ”€ anchoredVwap.ts # Anchored VWAP
406
+ โ”‚ โ”œโ”€โ”€ priceLabel.ts # Price Label
407
+ โ”‚ โ””โ”€โ”€ ... (17 more)
408
+ โ”œโ”€โ”€ widget/
409
+ โ”‚ โ”œโ”€โ”€ period-bar/ # Toolbar (periods, chart type, settings)
410
+ โ”‚ โ”œโ”€โ”€ drawing-bar/ # Drawing toolbar (8 groups)
411
+ โ”‚ โ”œโ”€โ”€ replay-bar/ # Replay controls (play/pause/step/speed)
412
+ โ”‚ โ”œโ”€โ”€ object-tree/ # Object manager modal
413
+ โ”‚ โ”œโ”€โ”€ drawing-style-editor/ # Style editor modal
414
+ โ”‚ โ”œโ”€โ”€ context-menu/ # Right-click menu
415
+ โ”‚ โ”œโ”€โ”€ error-banner/ # Error notification
416
+ โ”‚ โ”œโ”€โ”€ performance-panel/ # Debug panel
417
+ โ”‚ โ”œโ”€โ”€ alert-modal/ # Price alerts UI
418
+ โ”‚ โ””โ”€โ”€ ...
419
+ โ”œโ”€โ”€ component/ # Reusable UI (Modal, Select, List, etc.)
420
+ โ””โ”€โ”€ __tests__/ # 38 unit tests (100% pass)
421
+ ```
422
+
423
+ ---
424
+
425
+ ## ๐Ÿงช Testing
426
+
427
+ ```bash
428
+ # Run all tests
429
+ npx vitest run
430
+
431
+ # Run with verbose output
432
+ npx vitest run --reporter=verbose
433
+
434
+ # Watch mode
435
+ npx vitest
436
+ ```
437
+
438
+ Current status: **38/38 tests passing** โœ…
439
+
440
+ ---
441
+
442
+ ## ๐Ÿ›  Development
443
+
444
+ ```bash
445
+ # Install dependencies
446
+ npm install
447
+
448
+ # Start dev server
449
+ npm run dev
450
+
451
+ # Build for production
452
+ npm run build-core
453
+
454
+ # Run tests
455
+ npx vitest run
456
+ ```
457
+
458
+ ---
459
+
460
+ ## ๐Ÿ“„ License
461
+
462
+ Apache License 2.0