# AGGrid for Reflex
This package provides a Reflex component wrapping the AGGrid library.
<img src="aggrid_preview.png" width="500px">
> [!WARNING]
> As it is a WorkInProgress (WIP), only some parts of the AGGrid library features are wrapped, but it should be enough for most use cases.
## Installation
```bash
pip install reflex-ag-grid
```
## Usage
```python
from reflex_ag_grid import ag_grid
```
## Helpers tools
Some implementation is offered for DataSource and handlers.
```python
from reflex_ag_grid.data_source import DataSource
from reflex_ag_grid import handlers
```
## Simple Example
```python
import reflex as rx
from reflex_ag_grid import ag_grid
import pandas as pd
df = pd.read_csv(
"https://raw.githubusercontent.com/plotly/datasets/master/wind_dataset.csv"
)
column_defs = [
ag_grid.column_def(field="direction"),
ag_grid.column_def(field="strength"),
ag_grid.column_def(field="frequency"),
]
def ag_grid_simple():
return ag_grid(
id="ag_grid_basic_1",
row_data=df.to_dict("records"),
column_defs=column_defs,
)
```
Check out more documentation at [Reflex](https://reflex.dev/docs/library/tables-and-data-grids/ag-grid/).
## FAQ
- **The AGGrid feature I want is not available. What can I do?**
This component is a partial wrapping of all the features of AGGrid. If you need a feature that is not available,
open an issue to request it. We will try to implement it when possible.
If you can't wait for the team to implement it, you can also submit a PR with the feature you need.
Raw data
{
"_id": null,
"home_page": null,
"name": "reflex-ag-grid",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "reflex-ag-grid, ag-grid, reflex, reflex-custom-components, aggrid, dashboard",
"author": null,
"author_email": "Reflex Team <team@reflex.dev>",
"download_url": "https://files.pythonhosted.org/packages/09/e8/c602cbf39376ef47ef55a8be8dffa0bb7daa81f4cefac6da4143852bc34a/reflex_ag_grid-0.0.8.tar.gz",
"platform": null,
"description": "# AGGrid for Reflex\n\nThis package provides a Reflex component wrapping the AGGrid library.\n\n<img src=\"aggrid_preview.png\" width=\"500px\">\n\n> [!WARNING]\n> As it is a WorkInProgress (WIP), only some parts of the AGGrid library features are wrapped, but it should be enough for most use cases.\n\n## Installation\n\n```bash\npip install reflex-ag-grid\n```\n\n## Usage\n\n```python\nfrom reflex_ag_grid import ag_grid\n```\n\n## Helpers tools\n\nSome implementation is offered for DataSource and handlers.\n\n```python\nfrom reflex_ag_grid.data_source import DataSource\nfrom reflex_ag_grid import handlers\n```\n\n## Simple Example\n\n```python\nimport reflex as rx\nfrom reflex_ag_grid import ag_grid\nimport pandas as pd\n\n\ndf = pd.read_csv(\n \"https://raw.githubusercontent.com/plotly/datasets/master/wind_dataset.csv\"\n)\n\ncolumn_defs = [\n ag_grid.column_def(field=\"direction\"),\n ag_grid.column_def(field=\"strength\"),\n ag_grid.column_def(field=\"frequency\"),\n]\n\n\ndef ag_grid_simple():\n return ag_grid(\n id=\"ag_grid_basic_1\",\n row_data=df.to_dict(\"records\"),\n column_defs=column_defs,\n )\n```\n\nCheck out more documentation at [Reflex](https://reflex.dev/docs/library/tables-and-data-grids/ag-grid/).\n\n## FAQ\n\n- **The AGGrid feature I want is not available. What can I do?**\n\n This component is a partial wrapping of all the features of AGGrid. If you need a feature that is not available, \n open an issue to request it. We will try to implement it when possible.\n\n If you can't wait for the team to implement it, you can also submit a PR with the feature you need.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "AGGrid wrapping for Reflex",
"version": "0.0.8",
"project_urls": {
"homepage": "https://ag-grid-demo.reflex.run/",
"source": "https://github.com/reflex-dev/reflex-ag-grid"
},
"split_keywords": [
"reflex-ag-grid",
" ag-grid",
" reflex",
" reflex-custom-components",
" aggrid",
" dashboard"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bcae375dde53032d6411f0452179472f7c25204cc7aaa04de6a9242f0917be65",
"md5": "16e07762fa6cf9c651db0bf79ae75401",
"sha256": "411ec0c2d292a277e35678bf788dac427b02d12e4e89bcad94ff3af61b9d5b13"
},
"downloads": -1,
"filename": "reflex_ag_grid-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "16e07762fa6cf9c651db0bf79ae75401",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 12308,
"upload_time": "2024-10-22T11:46:54",
"upload_time_iso_8601": "2024-10-22T11:46:54.723933Z",
"url": "https://files.pythonhosted.org/packages/bc/ae/375dde53032d6411f0452179472f7c25204cc7aaa04de6a9242f0917be65/reflex_ag_grid-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "09e8c602cbf39376ef47ef55a8be8dffa0bb7daa81f4cefac6da4143852bc34a",
"md5": "680203e200ae4b11e6bb781a0b2bf7c6",
"sha256": "0f9c06b70cf91e789fa6ed74510d8fd0489cc0c9ee9513d2fc04b484a044b36a"
},
"downloads": -1,
"filename": "reflex_ag_grid-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "680203e200ae4b11e6bb781a0b2bf7c6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 11977,
"upload_time": "2024-10-22T11:46:56",
"upload_time_iso_8601": "2024-10-22T11:46:56.365337Z",
"url": "https://files.pythonhosted.org/packages/09/e8/c602cbf39376ef47ef55a8be8dffa0bb7daa81f4cefac6da4143852bc34a/reflex_ag_grid-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 11:46:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "reflex-dev",
"github_project": "reflex-ag-grid",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "reflex-ag-grid"
}
JSON
