|
1 | 1 | ## Version 0.1.4 (in development) |
2 | 2 |
|
3 | | -* Add `multiple` property for `Select` component to enable the |
| 3 | +- Add `multiple` property for `Select` component to enable the |
4 | 4 | of multiple elements. |
5 | 5 |
|
6 | | -## Version 0.1.0 (in development) |
| 6 | +## Version 0.1.3 (from 2025/01/28) |
7 | 7 |
|
8 | | -* Reorganised Chartlets project to better separate demo from library code. |
| 8 | +- **Chore:** Version bump to align CI process with GitHub release flow. |
| 9 | + No functional changes. This release ensures proper triggering of the CI |
| 10 | + pipeline for publishing and NPM. |
| 11 | + |
| 12 | +## Version 0.1.0 (from 2025/01/14) |
| 13 | + |
| 14 | +- Reorganised Chartlets project to better separate demo from library code. |
9 | 15 | Using monorepo layout for `chartlets.js` with workspaces `lib` and `demo` |
10 | 16 | that host the packages for `chartlets` and `chartlets-demo`. |
11 | 17 |
|
12 | | -* Other code reorganisations: |
13 | | - - moved `component/Registry` into `store` |
14 | | - - renamed module `component` into `components` |
| 18 | +- Other code reorganisations: |
| 19 | + |
| 20 | + - moved `component/Registry` into `store` |
| 21 | + - renamed module `component` into `components` |
15 | 22 | - no longer exposing `Registry` type |
16 | 23 |
|
17 | | -* Chartlets now allows for plugins that can provide individual component |
| 24 | +- Chartlets now allows for plugins that can provide individual component |
18 | 25 | implementations. |
19 | | - The Vega-based chart and MUI components are now optional and have been |
| 26 | + The Vega-based chart and MUI components are now optional and have been |
20 | 27 | moved into respective plugin modules `chartlets/plugins/vega` and |
21 | 28 | `chartlets/plugins/mui`. |
22 | | - To activate them, use the new `plugins: PluginLike[]` option |
| 29 | + To activate them, use the new `plugins: PluginLike[]` option |
23 | 30 | of `FrameworkOptions`: |
| 31 | + |
24 | 32 | ```TypeScript |
25 | 33 | import { configureFramework } from "chartlets"; |
26 | 34 | import mui from "chartlets/plugins/mui"; |
27 | 35 | import vega from "chartlets/plugins/vega"; |
28 | | - |
29 | | - configureFramework({ plugins: [mui(), vega()], ... }); |
| 36 | + |
| 37 | + configureFramework({ plugins: [mui(), vega()], ... }); |
30 | 38 | ``` |
31 | 39 |
|
32 | | -* Renamed `Plot` component into `VegaChart`. |
| 40 | +- Renamed `Plot` component into `VegaChart`. |
33 | 41 |
|
34 | | -* The new `VegaChart` component respects a `theme` property. If not given, |
| 42 | +- The new `VegaChart` component respects a `theme` property. If not given, |
35 | 43 | it will respect the current theme mode `"dark"` otherwise fallback to the |
36 | | - Vega default theme. |
| 44 | + Vega default theme. |
37 | 45 |
|
38 | | -* The demo application now allows for switching the theme mode between |
| 46 | +- The demo application now allows for switching the theme mode between |
39 | 47 | dark, light, and system mode. |
40 | 48 |
|
41 | | -* Changed the yet unused descriptor type `CbFunction` for callback functions. |
| 49 | +- Changed the yet unused descriptor type `CbFunction` for callback functions. |
| 50 | + |
42 | 51 | - using `schema` instead of `type` property for callback arguments |
43 | 52 | - using `return` object with `schema` property for callback return values |
44 | 53 |
|
45 | | -* New (MUI) components |
| 54 | +- New (MUI) components |
| 55 | + |
46 | 56 | - `Divider` |
47 | 57 | - `LinearProgress` |
48 | 58 | - `RadioGroup` and `Radio` |
49 | 59 | - `Switch` |
50 | 60 | - `Tabs` |
51 | 61 | - `Slider` |
52 | 62 |
|
53 | | -* Supporting `tooltip` property for interactive MUI components. |
| 63 | +- Supporting `tooltip` property for interactive MUI components. |
54 | 64 |
|
55 | 65 | ## Version 0.0.29 (from 2024/11/26) |
56 | 66 |
|
57 | | -* Resolved warnings that appeared when using Vega charts. |
| 67 | +- Resolved warnings that appeared when using Vega charts. |
58 | 68 |
|
59 | 69 | ## Version 0.0.28 (from 2024/11/26) |
60 | 70 |
|
61 | | -* Updated docs. |
| 71 | +- Updated docs. |
62 | 72 |
|
63 | 73 | ## Version 0.0.27 (from 2024/11/25) |
64 | 74 |
|
65 | | -* Added component `IconButton` and enhanced other components' attributes. |
| 75 | +- Added component `IconButton` and enhanced other components' attributes. |
66 | 76 |
|
67 | 77 | ## Version 0.0.26 (from 2024/11/23) |
68 | 78 |
|
69 | | -* Channels such as `Input`, `State`, `Output` no longer have a `link` property. |
| 79 | +- Channels such as `Input`, `State`, `Output` no longer have a `link` property. |
70 | 80 | Instead, we use a special `id` format, namely `"@app"` and `@container` |
71 | 81 | to address states other than components. (#52) |
72 | 82 |
|
73 | 83 | ## Version 0.0.25 (from 2024/11/23) |
74 | 84 |
|
75 | | -* `Registry.register()` now requires the `type` |
| 85 | +- `Registry.register()` now requires the `type` |
76 | 86 | to be passed as 1st argument because `component.name` will |
77 | 87 | be a mangled name in most cases. |
78 | 88 |
|
79 | 89 | ## Version 0.0.24 (from 2024/11/23) |
80 | 90 |
|
81 | | -* Exporting required `HostStore` type. |
| 91 | +- Exporting required `HostStore` type. |
82 | 92 |
|
83 | 93 | ## Version 0.0.23 (from 2024/11/23) |
84 | 94 |
|
85 | | -* Introduced new interface `HostState` that applications may implement |
| 95 | +- Introduced new interface `HostState` that applications may implement |
86 | 96 | to provide computed properties, i.e., a derived state. (#43) |
87 | 97 |
|
88 | | -* Replacing entire components if a related component `StateChange` |
| 98 | +- Replacing entire components if a related component `StateChange` |
89 | 99 | has an empty `property`. (#38) |
90 | 100 |
|
91 | | -* Added handy hooks `useContributions` and `useComponentChangeHandlers`. |
92 | | - |
| 101 | +- Added handy hooks `useContributions` and `useComponentChangeHandlers`. |
93 | 102 |
|
94 | 103 | ## Version 0.0.22 (from 2024/11/19) |
95 | 104 |
|
96 | | -* Improved robustness while rendering the in `Select` component |
| 105 | +- Improved robustness while rendering the in `Select` component |
97 | 106 | wrt `options` property. |
98 | 107 |
|
99 | | -* `Button` component now sets a `clicked: boolean` property instead |
| 108 | +- `Button` component now sets a `clicked: boolean` property instead |
100 | 109 | of `n_clicks: int`. |
101 | 110 |
|
102 | 111 | ## Version 0.0.21 (from 2024/11/19) |
103 | 112 |
|
104 | | -* `Component` children can now also be text nodes (of type `string`). |
| 113 | +- `Component` children can now also be text nodes (of type `string`). |
105 | 114 |
|
106 | | -* `Typography` component has children instead of `text`. |
| 115 | +- `Typography` component has children instead of `text`. |
107 | 116 |
|
108 | | -* A component's `children` property can now be changed, even from a |
| 117 | +- A component's `children` property can now be changed, even from a |
109 | 118 | scalar. |
110 | 119 |
|
111 | | -* Renamed `Dropdown` component into `Select` |
| 120 | +- Renamed `Dropdown` component into `Select` |
112 | 121 | (to refer to MUI component with same name). |
113 | 122 |
|
114 | | -* `Select` component has more flexible options. |
| 123 | +- `Select` component has more flexible options. |
115 | 124 |
|
116 | 125 | ## Version 0.0.20 (from 2024/11/19) |
117 | 126 |
|
118 | | -* Using `FrameworkOptions.getDerivedHostState` also in |
| 127 | +- Using `FrameworkOptions.getDerivedHostState` also in |
119 | 128 | `handleHostStoreChange()`. |
120 | 129 |
|
121 | | -* Actions `handleComponentChange()` and `handleHostStoreChange()` |
| 130 | +- Actions `handleComponentChange()` and `handleHostStoreChange()` |
122 | 131 | now exit immediately, if no extensions are configured yet. |
123 | 132 |
|
124 | | -* Module `utils.objPath`: Renamed `toObjPath` into `normalizeObjPath`, |
| 133 | +- Module `utils.objPath`: Renamed `toObjPath` into `normalizeObjPath`, |
125 | 134 | added `formatObjPath`. |
126 | 135 |
|
127 | 136 | ## Version 0.0.19 (from 2024/11/18) |
128 | 137 |
|
129 | | -* Fixed TypeScript typing issues with `configureFramework<S>()` and |
| 138 | +- Fixed TypeScript typing issues with `configureFramework<S>()` and |
130 | 139 | `FrameworkOptions`. |
131 | | - |
| 140 | + |
132 | 141 | ## Version 0.0.18 (from 2024/11/18) |
133 | 142 |
|
134 | | -* Fixed TypeScript typing issues with `configureFramework<S>()` and |
135 | | - `FrameworkOptions`. |
| 143 | +- Fixed TypeScript typing issues with `configureFramework<S>()` and |
| 144 | + `FrameworkOptions`. |
136 | 145 |
|
137 | 146 | ## Version 0.0.17 (from 2024/11/18) |
138 | 147 |
|
139 | | -* Enhanced interface `FrameworkOptions` by property `getDerivedHostState`, |
| 148 | +- Enhanced interface `FrameworkOptions` by property `getDerivedHostState`, |
140 | 149 | which is a user-supplied function that can compute derived |
141 | | - host state property. |
142 | | - |
| 150 | + host state property. |
| 151 | + |
143 | 152 | ## Version 0.0.16 (from 2024/11/12) |
144 | 153 |
|
145 | | -Initial, still experimental version. |
| 154 | +Initial, still experimental version. |
0 commit comments