Skip to main content
Yanked

This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 1.2.1.post2 instead.
Reason given by maintainers: Bug when init with empty data

streamlit-aggrid

Open in Streamlit GitHub PyPI Downloads

For sponsoring, development support, features prioritization you can email me.

Live examples and documentation on Streamlit Cloud.


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!

Current AgGrid version is 34.3.1

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.

example image

Development Notes

Version 1.2.0

  • Added server_sync_strategy parameter to control data synchronization between server and client
  • Deprecates try_to_convert_back_to_original_types, now grid will always try to keep proper datatypes when editing data.
  • Upgrades internal ag-grid to version 34.3.1

Version 1.1.9

  • Updates internal grid to 34.2.0
  • Fixes BigInt serialization bug, caused by the new PyArrow serialization.

Version 1.1.8

  • Major refactor: Introduced collector-based architecture for grid data return processing
  • Added new DataReturnMode.CUSTOM allowing custom JavaScript data collection logic
  • Improved data serialization and handling of complex data types (data is now transfered using Streamlit`s ArrowTable protobuff)
  • Enhanced performance for large datasets through optimized data processing
  • Added comprehensive test suite for grid return functionality
  • Added deprecation warnings for GridUpdateMode (use update_on parameter instead)
  • Enhanced documentation with detailed parameter descriptions

Version 1.1.7

  • Updates inner Ag-Grid to v. 34.0.2
  • Fixes a bug related to moving columns with grandTotalRow present

Version 1.1.5

  • Fix licensing when not using License bundled with AgCharts.
  • Added option for fullscreen mode.
  • Refactored grid toolbar.

Version 1.1.4

  • onGridReady Event fires when set in grid Options.
  • Fixes grid return when data input data is Json.
  • post1 fixes packaging bug caused by poetry update to 2.1.2

Version 1.1.3

  • fixes enterprise modules being enabled by default. (If using enterprise features, buy a license from Ag Grid.)
  • fixes grid initialization when neither data nor gridOptions are set.
  • 1.1.3.post1 fixes #317

Version 1.1.2

  • adds PR #308 - Callbacl functionality

Version 1.1.1

Version 1.1.0

  • Updated AgGrid to version 32.3
  • Added partial support for the aggrid Theming - Check example
  • Cleaned project dependencies (Altair < 5)

Version 1.0.5

  • Updated AgGrid to version 31.3

Version 1.0.4

  • Added information on the event that triggered app rerun

Version 1.0.2

  • Moved a lot of response processment to python side.
  • Changed grid return object.
  • Fix bugs and code cleanup.

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

  • Fixes issue #3
  • Adds support for timedelta columns check example

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...

Metadata

Release files for streamlit-aggrid 1.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for streamlit-aggrid 1.2.0
File Size Uploaded Provenance Actions
streamlit_aggrid-1.2.0.tar.gz 5.7 MB Without provenance Details for streamlit_aggrid-1.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for streamlit-aggrid 1.2.0
File Interpreter ABI Platform Actions
streamlit_aggrid-1.2.0-py3-none-any.whl Python 3 none any Details for streamlit_aggrid-1.2.0-py3-none-any.whl

Total release size: 11.4 MB

Release files / streamlit_aggrid-1.2.0.tar.gz

Download URL streamlit_aggrid-1.2.0.tar.gz
Size 5.7 MB
Tags Source
SHA-256 checksum
How to use checksums
c49d380b2361ed5daf236ffa7e7140a3854bbccb4a6c380243237636039e3abb
BLAKE2b-256 checksum
How to use checksums
0b010ae200f00ff961b869cbdcd0ab6b0d1215e0e9acb4ba55a9e1757d98f9e4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.13.5 Darwin/24.6.0

Release files / streamlit_aggrid-1.2.0-py3-none-any.whl

Download URL streamlit_aggrid-1.2.0-py3-none-any.whl
Size 5.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
f9c40b27172b5673719a8b2c8144444e39a26195b11f45887b093c317840e360
BLAKE2b-256 checksum
How to use checksums
2df076d7db834699ef03072bf3b1e8421995b7164113d3171309eb39424c8fa4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.13.5 Darwin/24.6.0

Security for streamlit-aggrid 1.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.2.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page