https://github.com/reflex-dev/reflex-ag-grid
https://github.com/reflex-dev/reflex-ag-grid
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/reflex-dev/reflex-ag-grid
- Owner: reflex-dev
- Created: 2024-09-03T16:39:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-21T11:54:23.000Z (about 1 year ago)
- Last Synced: 2024-12-13T09:10:51.277Z (about 1 year ago)
- Language: Python
- Size: 153 KB
- Stars: 15
- Watchers: 3
- Forks: 2
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> [!WARNING]
> This component is no longer maintained.
>
> For the AG Grid wrapping maintained by the Reflex team, please use https://enterprise.reflex.dev/ag-grid from now on.
# AGGrid for Reflex
This package provides a Reflex component wrapping the AGGrid library.
> [!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.