streamlit-aggrid
If you want to sponsor or support this project you can mail me.
if you like the project, you can Buy me a coffee or if you prefer send it through Paypal
AgGrid is an awesome grid for web frontend. More information in https://www.ag-grid.com/. Consider purchasing a license from Ag-Grid if you are going to use enterprise features!
Live examples on Streamlit Cloud Some basic documentation is available: https://streamlit-aggrid.readthedocs.io
Install
pip install streamlit-aggrid
Quick Use
Create an example.py file
from st_aggrid import AgGrid
import pandas as pd
df = pd.read_csv('https://raw.githubusercontent.com/fivethirtyeight/data/master/airline-safety/airline-safety.csv')
AgGrid(df)
Run :
streamlit run example.py
Demo
Grid data is sent back to streamlit and can be reused in other components. In the example below a chart is updated on grid edition.
Development Notes
Version 0.3.5
- Merged many PR, thanks everybody.
- Grid State can be saved and retrieved. Many people requested this one. Live Example Here
Version 0.3.4
- Added quickfilter
- Added Excel Export Module
- Bugfixes (an probably introduced new ones :/)
- Code cleanup
- Updated Ag-Grit to 29.1.0 (including ag-grid-react) which will cause direct HTML returns to stop rendering (#198). Use a cellRenderer instead.
Version 0.3.3
- Fixes #132
- Fixes #131 and #130
- Added Sparklines #118
- Changed Grid Return to support #117
- Rebuilt streamlit theme
Version 0.3.0
- Merged some PR (Thanks everybody!) check PR at github!
- Added class parsing in React Side, so more advanced CellRenderers can be used. (Thanks kjakaitis)
- Added gridOptionsBuilder.configure_first_column_as_index() to, well, style the first columns as an index (MultiIndex to come!)
- Improved serialization performance by using simpler pandas to_json method (PR #62, #85)
- Added option to render plain json instead of pd.dataframes
- gridOptions may be loaded from file paths or strings
- gridReturn is now a @dataclass with rowIndex added to selected_rows, (previous version returned only the selected data, now you can know which row was selected)
- Changed GridReturnMode behavior. Now update_on accepts a list of gridEvents that will trigger a streamlit refresh, making it possible to subscribe to any gridEvent.
- Removed dot-env and simplejson dependencies.
- Other smaller fixes and typos corrections.
Version 0.2.3
- small fixes
- Merged PR #44 and #25 (thanks msabramo and ljnsn)
- Merged PR #58 - allow nesting dataframes. Included an example in exampes folder.
Version 0.2.2
- Updated frontend dependencies to latest version
- Corrected text color for better viz when using streamlit theme (thanks jasonpmcculloch)
- Switched default theme to Balham Light ('light'), if you want to use streamlit theme set
theme='streamlit'on agGrid call
Version 0.2.0
- Support Themes
- Incorporated Pull Requests with fixes and pre-select rows (Thanks randomseed42 and msabramo)
- You can use strings instead of importing GridUpdateMode and DataReturnMode enumerators
- it works fine with st.forms!
- new theme example in example folder
Version 0.1.9
- Small fixes
- Organized examples folder
Version 0.1.8
- Fixes a bug that breaks the grid when NaN or Inf values are present in the data
Version 0.1.7
- Fixes a bug that happened when converting data back from the grid with only one row
- Added license_key parameter on AgGrid call.
Version 0.1.6
Version 0.1.5
- small bug fixes
- there is an option to avoid grid re-initialization on app update (check fixed_key_example.py on examples folder or here)
Version 0.1.3
- Fixed bug where cell was blank after edition.
- Added enable_enterprise_modules argument to AgGrid call for enabling/disabling enterprise features
- It is now possible to inject js functions on gridOptions. Enabling advanced customizations such as conditional formatting (check 4th column on the example)
Version 0.1.2
- added customCurrencyFormat as column type
Version 0.1.0:
- I worked a little bit more on making the example app functional.
- Couple configuration options for update mode (How frontend updates streamlit) and for data returns (grid should return data filtered? Sorted?)
- Some basic level of row selection
- Added some docstrings specially on gridOptionsBuilder methods
- Lacks performance for production. JS Client code is slow...
1 maintainer
Metadata
1 maintainer
Release files for streamlit-aggrid 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| streamlit_aggrid-1.0.2.tar.gz | 4.0 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| streamlit_aggrid-1.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.0 MB
Release files / streamlit_aggrid-1.0.2.tar.gz
| Download URL | streamlit_aggrid-1.0.2.tar.gz |
|---|---|
| Size | 4.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9896145ff5e43dfdb4b475bf940d412c2b03da7d435924475e266e96b178c05e
|
|
BLAKE2b-256 checksum How to use checksums |
901f9561957bcd3a0734e3e02574cd2b4c14f7b528846f6dcefacda88db33aa0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.8.2 Linux/5.10.102.1-microsoft-standard-WSL2
|
Release files / streamlit_aggrid-1.0.2-py3-none-any.whl
| Download URL | streamlit_aggrid-1.0.2-py3-none-any.whl |
|---|---|
| Size | 4.0 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2afd859cd1935581a7c7389f78ff1b877f4692e3730e905a1b458c949acaad9a
|
|
BLAKE2b-256 checksum How to use checksums |
f2a7c0d7e0805988ac3f4bd619ea1decf1c49631cf33d2810686cdba0de62da1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.8.2 Linux/5.10.102.1-microsoft-standard-WSL2
|
