# reflex-echarts
A Reflex wrapper for
[echarts-for-react](https://www.npmjs.com/package/echarts-for-react) library.
## Installation
```bash
pip install reflex-echarts
```
## Usage
See [echarts_demo/echarts_demo.py](echarts_demo/echarts_demo/echarts_demo.py) for a
working example.
Props are based on the `echarts-for-react` library, so please refer to the
documentation there for further explanation.
## Themes
Themes can be set by passing a `theme` prop to the `ECharts` component.
To load custom themes, provide the JS code that ultimately calls `echarts.registerTheme` as
a string to the `register_theme_code` prop (this cannot be a State Var).
## Limitations
* Event handling is not yet implemented.
* Inline functions for formatters and data key extraction is not implemented.
Due to how the chart `option` is serialized as JSON, there is not a clean way
to pass inline functions from the Python backend to the Javascript frontend.
* All chart types are available, which increases the bundle size of the application.
There is not currently a mechanism to only include the chart types which are used.
* Cannot figure out how to load external themes from a JS file...
Raw data
{
"_id": null,
"home_page": null,
"name": "reflex-echarts",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "reflex, reflex-custom-components",
"author": null,
"author_email": "Masen Furer <m_github@0x26.net>",
"download_url": "https://files.pythonhosted.org/packages/82/03/9a7e4abcfe223572c971557bd950e9f398a349280380a495d2b954f64eaf/reflex-echarts-0.0.1.tar.gz",
"platform": null,
"description": "# reflex-echarts\n\nA Reflex wrapper for\n[echarts-for-react](https://www.npmjs.com/package/echarts-for-react) library.\n\n## Installation\n\n```bash\npip install reflex-echarts\n```\n\n## Usage\n\nSee [echarts_demo/echarts_demo.py](echarts_demo/echarts_demo/echarts_demo.py) for a\nworking example.\n\nProps are based on the `echarts-for-react` library, so please refer to the\ndocumentation there for further explanation.\n\n## Themes\n\nThemes can be set by passing a `theme` prop to the `ECharts` component.\n\nTo load custom themes, provide the JS code that ultimately calls `echarts.registerTheme` as\na string to the `register_theme_code` prop (this cannot be a State Var).\n\n## Limitations\n\n* Event handling is not yet implemented.\n* Inline functions for formatters and data key extraction is not implemented.\n Due to how the chart `option` is serialized as JSON, there is not a clean way\n to pass inline functions from the Python backend to the Javascript frontend.\n* All chart types are available, which increases the bundle size of the application.\n There is not currently a mechanism to only include the chart types which are used.\n* Cannot figure out how to load external themes from a JS file...\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Reflex Wrapper for echarts-for-react library.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/masenf/react-echarts"
},
"split_keywords": [
"reflex",
" reflex-custom-components"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "22efc478adbfeba5fc66a7d26fb0f05f0846b3208860ff11ddf0ea44381f98d2",
"md5": "8fbaab187a74377f1b7ea9c9a3ba8e08",
"sha256": "1757932ceccff1e0476b553b912d9c8920d133289e02925ed4ef402d47d7b8b2"
},
"downloads": -1,
"filename": "reflex_echarts-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8fbaab187a74377f1b7ea9c9a3ba8e08",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 3285,
"upload_time": "2024-03-27T20:37:37",
"upload_time_iso_8601": "2024-03-27T20:37:37.073709Z",
"url": "https://files.pythonhosted.org/packages/22/ef/c478adbfeba5fc66a7d26fb0f05f0846b3208860ff11ddf0ea44381f98d2/reflex_echarts-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "82039a7e4abcfe223572c971557bd950e9f398a349280380a495d2b954f64eaf",
"md5": "b7779ca21cf0bf3db8edb5a362284549",
"sha256": "d17b72bc172164ea3a6d24fceb522e519f93cb47bcd92b2d239bbca5d03d858e"
},
"downloads": -1,
"filename": "reflex-echarts-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "b7779ca21cf0bf3db8edb5a362284549",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3101,
"upload_time": "2024-03-27T20:37:38",
"upload_time_iso_8601": "2024-03-27T20:37:38.422341Z",
"url": "https://files.pythonhosted.org/packages/82/03/9a7e4abcfe223572c971557bd950e9f398a349280380a495d2b954f64eaf/reflex-echarts-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 20:37:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "masenf",
"github_project": "react-echarts",
"github_not_found": true,
"lcname": "reflex-echarts"
}
JSON
