Skip to content

Latest commit

 

History

History
104 lines (76 loc) · 2.36 KB

README.md

File metadata and controls

104 lines (76 loc) · 2.36 KB

react-echarts-json

No-invasive debugging based on Echarts

💻 Live

Docs Live

✨ Features

  • Easy to learn and use
  • No-invasive
  • Dependent on updates
  • Log view monitoring
  • Visual debugging echarts options
  • Support multi-chart
  • Can customize the combination views

📦 Install

$ npm install --save react-echarts-json
# or
$ yarn add react-echarts-json

🔨 Usage

Use the container that displays the view

renderable can control asynchronous loading without worrying about importing resources

import { ViewContainer } from 'react-echarts-json'
import 'react-echarts-json/dist/style.css'

// view
// EchartDefaultView --- Default view component
;<ViewContainer renderable={true}></ViewContainer>

You need to inject messages in the components using echarts(jsx or tsx)

import { InjectView } from 'react-echarts-json'
;<InjectView
	chart={chart}
	option={option}
	id="demo"
	name="demo"
	renderFlag={true}
/>

👨‍💻👩🏻‍💻 Custom view

You can customize your view through the components and hooks provided

import {
	useMedia,
	useDarkMode,
	useEcharts,
	useInjection,
	useChartSelect,
	useChartEventEmitter,
	useCreateEditor,
	ViewContainer,
	Editor,
	LogView,
	InjectView,
	ReactEchartsJson,
} from 'react-echarts-json'

ViewContainer

Display container

Components

  • Editor --- code Editor Copomponent
  • LogView --- echart log
  • ReactEchartsJson --- echart option json view
  • InjectView --- inject chart

Hooks

  • useDarkMode --- dark theme
  • useMedia --- media
  • useEcharts --- for fast create demo
  • useChartSelect --- select active chart
  • useCreateEditor --- createEditor and run code # If you don t use the Editor component then you need to use this hook
  • useChartEventEmitter --- chart eventBus

Can you use hook and component to customize the components you want.The EchartDefaultView component is made up of them.

🖼 View

darl

darl

log