Skip to content

Commit 762b084

Browse files
committed
update
1 parent b20a247 commit 762b084

File tree

1 file changed

+15
-19
lines changed

1 file changed

+15
-19
lines changed

chartlets.js/CHANGES.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,22 @@
11
## Version 0.1.0 (not started)
22

3-
* Reorganise Chartlets project
4-
- Create `chartlets` GH org.
5-
- Split current `chartlets` repo and move to `chartlets` org:
6-
- `chartlets.py` The Python package, defines standard components
7-
- `chartlets.js` The JS package, implements standard components
8-
- `chartlets-demo` Chartlets demo which uses the above
9-
- Allow for different component implementation bases, therefore
10-
make corresponding dependencies optional and dynamically check at runtime
11-
whether they are available.
12-
13-
## Version 0.0.30 (in development)
14-
15-
* Chartlets now allows for different component providers.
16-
Therefore, Vega-based `Plot` and MUI components have been made optional.
17-
To activate, use the new `plugins: Plugin[]` option of `FrameworkOptions`.
3+
* Reorganised Chartlets project to better separate demo from library code.
4+
- Using monorepo layout for `chartlets.js` that contains separate
5+
packages for `chartlets` and `chartlets-demo`.
6+
- Created separate package `demo` in `chartlets.py` that contains
7+
a demo server and example contributions.
8+
9+
* Chartlets now allows for plugins that can provide individual component
10+
implementations.
11+
Therefore, the Vega-based chart and MUI components have been made optional.
12+
To activate them, use the new `plugins: PluginLike[]` option
13+
of `FrameworkOptions`:
1814
```TypeScript
19-
import { initializeContributions } from "chartlets";
20-
import mui from "chartlets/dist/plugins/mui";
21-
import vega from "chartlets/dist/plugins/vega";
15+
import { configureFramework } from "chartlets";
16+
import mui from "chartlets/plugins/mui";
17+
import vega from "chartlets/plugins/vega";
2218

23-
initializeContributions({ plugins: [mui, vega], ... })
19+
configureFramework({ plugins: [mui(), vega()], ... });
2420
```
2521
In addition:
2622
- Renamed `Plot` into `VegaChart` and moved to `src/plugins/vega`.

0 commit comments

Comments
 (0)