Skip to content

Commit ced52de

Browse files
committed
Merge branch 'main' into forman-x-callback_function_descriptor
# Conflicts: # chartlets.js/CHANGES.md # chartlets.js/package.json # chartlets.py/CHANGES.md # chartlets.py/chartlets/version.py
2 parents e190419 + edee572 commit ced52de

File tree

129 files changed

+14377
-2105
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

129 files changed

+14377
-2105
lines changed

.github/workflows/frontend-ci.yml

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,32 @@ jobs:
1717
with:
1818
node-version: '18.x'
1919

20-
- name: Install dependencies
20+
- name: Install common dependencies
2121
run: |
2222
cd chartlets.js
2323
npm install
2424
25-
- name: Linter
25+
- name: Lib lint
2626
run: |
27-
cd chartlets.js
27+
cd chartlets.js/packages/lib
2828
npm run lint
2929
30-
- name: Run frontend tests
30+
- name: Lib tests
3131
run: |
32-
cd chartlets.js
32+
cd chartlets.js/packages/lib
3333
npm run test
3434
35-
- name: Build frontend application
35+
- name: Lib build
3636
run: |
37-
cd chartlets.js
37+
cd chartlets.js/packages/lib
38+
npm run build
39+
40+
- name: Demo lint
41+
run: |
42+
cd chartlets.js/packages/demo
43+
npm run lint
44+
45+
- name: Demo build
46+
run: |
47+
cd chartlets.js/packages/demo
3848
npm run build

.github/workflows/publish.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,11 @@ jobs:
123123
cache-dependency-path: chartlets.js/package-lock.json
124124

125125
- run: npm ci
126-
- run: npm run build
127-
- run: npm publish --access public
126+
- run: |
127+
cd packages/lib
128+
npm run build
129+
- run: |
130+
cd packages/lib
131+
npm publish --access public
128132
env:
129133
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ Please see the [Documentation](https://bcdev.github.io/chartlets/) for more info
1111

1212
## Features
1313

14-
- Enhance your React web application by UI-contributions programmed in Python
15-
- Enhance your (Python) web API to serve server-side UI-contributions.
16-
- Uses [Material UI](https://mui.com/material-ui/) components and
17-
[Vega-Lite](https://vega.github.io/vega-lite/) charts.
14+
- Enhance your React web application by UI-contributions programmed in Python.
15+
- Enhance your Python REST server to publish server-side UI-contributions.
16+
- Support your favorite charting library or UI component library by plugins.
17+
- Use provided plugins for [Vega-Lite](https://vega.github.io/vega-lite/) charts and [Material UI](https://mui.com/material-ui/)
18+
components.
1819

1920
## License
2021

chartlets.js/.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ yarn-error.log*
77
pnpm-debug.log*
88
lerna-debug.log*
99

10-
node_modules
10+
packages/lib/node_modules
1111
dist
1212
dist-ssr
1313
*.local

chartlets.js/CHANGES.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,39 @@
1-
## Version 0.0.x (in development)
1+
## Version 0.1.0 (in development)
2+
3+
* Reorganised Chartlets project to better separate demo from library code.
4+
Using monorepo layout for `chartlets.js` with workspaces `lib` and `demo`
5+
that host the packages for `chartlets` and `chartlets-demo`.
6+
7+
* Chartlets now allows for plugins that can provide individual component
8+
implementations.
9+
The Vega-based chart and MUI components are now optional and have been
10+
moved into respective plugin modules `chartlets/plugins/vega` and
11+
`chartlets/plugins/mui`.
12+
To activate them, use the new `plugins: PluginLike[]` option
13+
of `FrameworkOptions`:
14+
```TypeScript
15+
import { configureFramework } from "chartlets";
16+
import mui from "chartlets/plugins/mui";
17+
import vega from "chartlets/plugins/vega";
18+
19+
configureFramework({ plugins: [mui(), vega()], ... });
20+
```
21+
22+
* Renamed `Plot` component into `VegaChart`.
23+
24+
* The new `VegaChart` component respects a `theme` property. If not given,
25+
it will respect the current theme mode `"dark"` otherwise fallback to the
26+
Vega default theme.
27+
28+
* The demo application now allows for switching the theme mode between
29+
dark, light, and system mode.
230

331
* Changed the yet unused descriptor type `CbFunction` for callback functions.
432

33+
## Version 0.0.29 (from 2024/11/26)
34+
35+
* Resolved warnings that appeared when using Vega charts.
36+
537
## Version 0.0.28 (from 2024/11/26)
638

739
* Updated docs.

chartlets.js/README.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,14 @@
1-
# chartlets
1+
# Chartlets
22

3-
[![Frontend CI workflow](https://github.com/bcdev/chartlets/actions/workflows/frontend-ci.yml/badge.svg)](https://github.com/bcdev/chartlets/actions/workflows/frontend-ci.yml)
4-
[![NPM Version](https://badge.fury.io/js/chartlets.svg)](https://npmjs.org/package/chartlets)
3+
[![CI](https://github.com/bcdev/chartlets/actions/workflows/frontend-ci.yml/badge.svg)](https://github.com/bcdev/chartlets/actions/workflows/frontend-ci.yml)
4+
[![npm](https://badge.fury.io/js/chartlets.svg)](https://npmjs.org/package/chartlets)
55
![](https://img.shields.io/badge/Linting-TypeScript%20%26%20Prettier-blue?logo=typescript&logoColor=white)
66

7-
8-
[![NPM Download Stats](https://nodei.co/npm/chartlets.png?downloads=true)](https://www.npmjs.com/package/chartlets)
9-
107
Chartlets is a software framework that allows websites developed with
118
React to be extended by server-side widgets programmed in Python or other
129
programming languages.
1310

14-
This is the JavaScript/React library of the framework.
11+
This is the **JavaScript/React library** of the framework.
1512

1613
For details refer to the [documentation](https://bcdev.github.io/chartlets/).
1714

18-
## Run the demo UI
19-
20-
``` bash
21-
npm install
22-
npm run dev
23-
```

0 commit comments

Comments
 (0)