Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update TS and useRef example #554

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,24 @@ const echartInstance = this.echartRef.getEchartsInstance();
const base64 = echartInstance.getDataURL();
```

TypeScript and `useRef()` example:
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

useRef() example:

remove typescript


```ts
const getOption = () => {/** */}
export default function App() {
const echartsRef = useRef<InstanceType<typeof ReactEcharts>>(null);

useEffect(() => {
if (echartsRef.current) {
const echartsInstance = echartsRef.current.getEchartsInstance();
// do something
echartsInstance.resize();
}
}, []);
return <ReactEcharts ref={echartsRef} option={getOption()} />;
}
```

**About API of echarts, can see** [https://echarts.apache.org/api.html#echartsInstance](https://echarts.apache.org/api.html#echartsInstance).

You can use the API to do:
Expand Down