Skip to content

Commit

Permalink
[optimize] upgrade Node.js, PNPM & other Upstream packages
Browse files Browse the repository at this point in the history
[optimize] update ReadMe document
  • Loading branch information
TechQuery committed Aug 13, 2023
1 parent e52b6d2 commit 96d8731
Show file tree
Hide file tree
Showing 6 changed files with 2,018 additions and 1,734 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ jobs:

- uses: pnpm/action-setup@v2
with:
version: 7
version: 8
- uses: actions/setup-node@v3
with:
node-version: 14
node-version: 18
registry-url: https://registry.npmjs.org
cache: pnpm
- name: Install Dependencies
Expand Down
30 changes: 19 additions & 11 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

A real [JSX][1] wrapper for [ECharts][2] based on [TypeScript][3]

[![CI & CD](https://github.com/idea2app/ECharts-JSX/actions/workflows/main.yml/badge.svg)][4]
[![NPM Dependency](https://img.shields.io/librariesio/github/idea2app/ECharts-JSX.svg)][4]
[![CI & CD](https://github.com/idea2app/ECharts-JSX/actions/workflows/main.yml/badge.svg)][5]
[![](https://raw.githubusercontent.com/sindresorhus/awesome/main/media/mentioned-badge.svg)][6]

[![NPM](https://nodei.co/npm/echarts-jsx.png?downloads=true&downloadRank=true&stars=true)][5]
[![NPM](https://nodei.co/npm/echarts-jsx.png?downloads=true&downloadRank=true&stars=true)][7]

## Features

- [x] All kinds of options can be write in **JSX syntax**
- [x] All kinds of options & event handlers can be write in **JSX syntax**
- [x] Parallel chart
- [x] Line chart
- [x] Scatter chart
Expand Down Expand Up @@ -37,9 +39,9 @@ npm i echarts-jsx react react-dom

### Simple example

Origin: [ECharts official example][6]
Origin: [ECharts official example][8]

[![Edit ECharts-JSX-demo](https://codesandbox.io/static/img/play-codesandbox.svg)][7]
[![Edit ECharts-JSX-demo](https://codesandbox.io/static/img/play-codesandbox.svg)][9]

```tsx
import { render } from 'react-dom';
Expand Down Expand Up @@ -73,7 +75,11 @@ render(
/>
<YAxis />

<BarSeries name="sales" data={[5, 20, 36, 10, 10, 20]} />
<BarSeries
name="sales"
data={[5, 20, 36, 10, 10, 20]}
onClick={console.log}
/>
</CanvasCharts>,
document.body
);
Expand All @@ -88,12 +94,14 @@ render(

## User cases

1. [China Open-source Map](https://test.kaiyuanshe.cn/organization/)
1. [China Open-source Map](https://kaiyuanshe.cn/organization/)

[1]: https://facebook.github.io/jsx/
[2]: https://echarts.apache.org/
[3]: https://www.typescriptlang.org/
[4]: https://github.com/idea2app/ECharts-JSX/actions/workflows/main.yml
[5]: https://nodei.co/npm/echarts-jsx/
[6]: https://echarts.apache.org/handbook/en/get-started/
[7]: https://codesandbox.io/s/echarts-jsx-demo-bouwsf?autoresize=1&fontsize=14&module=%2Fsrc%2FBar.tsx&theme=dark
[4]: https://libraries.io/npm/echarts-jsx
[5]: https://github.com/idea2app/ECharts-JSX/actions/workflows/main.yml
[6]: https://github.com/ecomfe/awesome-echarts
[7]: https://nodei.co/npm/echarts-jsx/
[8]: https://echarts.apache.org/handbook/en/get-started/
[9]: https://codesandbox.io/s/echarts-jsx-demo-bouwsf?autoresize=1&fontsize=14&module=%2Fsrc%2FBar.tsx&theme=dark
28 changes: 14 additions & 14 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "echarts-jsx",
"version": "0.5.0",
"version": "0.5.2",
"license": "LGPL-3.0",
"author": "shiy2008@gmail.com",
"description": "A real JSX wrapper for ECharts based on TypeScript",
Expand All @@ -12,7 +12,7 @@
"chart",
"typescript"
],
"homepage": "https://ideapp.dev/ECharts-JSX/",
"homepage": "https://idea2app.github.io/ECharts-JSX/",
"repository": {
"type": "git",
"url": "git+https://github.com/idea2app/ECharts-JSX.git"
Expand All @@ -25,25 +25,25 @@
"module": "dist/index.js",
"main": "dist/index.umd.js",
"dependencies": {
"echarts": "^5.4.0",
"echarts": "^5.4.3",
"lodash": "^4.17.21",
"web-utility": "^3.9.9"
"web-utility": "^4.1.0"
},
"peerDependencies": {
"react": ">=16.0.0"
"react": ">=16"
},
"devDependencies": {
"@types/lodash": "^4.14.189",
"@types/react": "^17.0.52",
"husky": "^8.0.2",
"lint-staged": "^13.0.3",
"@types/lodash": "^4.14.197",
"@types/react": "^17.0.64",
"husky": "^8.0.3",
"lint-staged": "^13.3.0",
"microbundle": "^0.15.1",
"open-cli": "^7.1.0",
"prettier": "^2.7.1",
"open-cli": "^7.2.0",
"prettier": "^3.0.1",
"react": "^17.0.2",
"typedoc": "^0.23.21",
"typedoc-plugin-mdn-links": "^2.0.0",
"typescript": "~4.8.4"
"typedoc": "^0.24.8",
"typedoc-plugin-mdn-links": "^3.0.3",
"typescript": "~5.1.6"
},
"prettier": {
"singleQuote": true,
Expand Down
Loading

0 comments on commit 96d8731

Please sign in to comment.