Skip to content

Commit 2b917ac

Browse files
author
Niilo Keinänen
committed
Drafting 1st version of lightningchart-js skill
1 parent 36ba927 commit 2b917ac

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

lightningchart-js/SKILL.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ before making assumptions how LCJS API works.
3636
NEVER guess LCJS APIs, method names, constructor options, enum names,
3737
configuration objects, import paths, or documentation URLs from memory.
3838

39-
## Common Errors
39+
## Common Issues
4040

4141
- Version matters. Prefer the URLs and API entries discovered from the supplied index unless the user or project explicitly targets another LCJS version.
4242
- The correct NPM package is `@lightningchart/lcjs`, NOT `@arction/lcjs`. Always install using the latest tag with `npm i @lightningchart/lcjs@latest` unless specified otherwise, but do not leave `latest` in `package.json`.
@@ -55,7 +55,13 @@ lightningChart({
5555
- Tell the user to write their license to the environment variable or download their free license from https://lightningchart.com/js-charts/ if they don't have one (IMPORTANT!)
5656
- LCJS versions under v9.0 override the passed DIV `style.position`. If using CSS, use `!important` syntax. If using JS, style after creating the chart.
5757
- `lightningChart()` function creates a side effect that must be included in cleanup handling (if any), like `const lc = lightningChart(...) ---> lc.dispose()`
58+
- If your application creates several charts, it is best to reuse the same `lightningChart()` context for all of them.
5859

5960
## Validation
6061

6162
If possible, rely on local type checks to confirm correct LCJS API usage.
63+
64+
## Upgrading LightningChart JS version
65+
66+
When migrating to newer major versions, please refer to official migration guides found at: https://lightningchart.com/js-charts/docs/migration-guides/v8.0.0/ (replace v8.0.0 with version target).
67+
These pages list all backward incompatibilities and recommended actions during migration.

0 commit comments

Comments
 (0)