streamlit-aggrid-m1212 2.0.0rc1.post5

Unofficial fixed fork of the Streamlit component implementation of AG Grid

streamlit-aggrid

[!IMPORTANT] This release branch publishes the temporary, unofficial streamlit-aggrid-m1212 distribution containing the fixes proposed in upstream PR #350. It retains the public st_aggrid and streamlit_aggrid Python imports, but it must not be installed alongside the upstream streamlit-aggrid distribution because both distributions provide those same import packages.

[!IMPORTANT] 💡 Support the Development of streamlit-aggrid!
This project is the result of countless hours of dedication by a solo Python developer. If you find it useful, consider giving back to help keep it alive and thriving.

Ways to Contribute:

• Donate via PayPal: A quick and secure way to show your support.

Every contribution, no matter the size, makes a difference and helps ensure the continued improvement of this project. Thank you for your generosity! 🙌

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 36.0.0

Install

pip install streamlit-aggrid-m1212==2.0.0rc1.post5

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 2.0.0

• Migrated to Streamlit Components V2 (requires streamlit >= 1.59).
• Temporarily requires pandas >= 1.4,<3 while pandas 3 support is validated.
• Temporarily requires pyarrow <25 to avoid the confirmed PyArrow 25 allocator crash in Streamlit's ScriptRunner lifecycle.
• The implementation package is now streamlit_aggrid; from st_aggrid import ... keeps working as an alias.
• Removed automatic dtype conversion of returned data and the conversion_errors parameter.
• JSON string inputs now return DataFrames (previously returned JSON strings).
• Preserved custom_css compatibility inside the Components V2 style root; global CSS can use st.markdown() + isolate_styles=False.
• AG Grid and its toolbar now inherit Streamlit's configured app font through the Components V2 theme CSS variable, without per-cell JavaScript or a bundled font.
• Fixed CUSTOM return mode, the manual update button, and the callback parameter.
• Made DataReturnMode.MINIMAL return only compact triggering-event data without walking the full row model.
• Added opt-in server_wins_rows synchronization for client-side grids with explicit stable row IDs. It preserves unchanged browser row objects so AG Grid refreshes only changed rows while keeping server data authoritative.
• Added opt-in clipboard_batching=True for Components V2. Excel paste, cut, cell-selection delete, and fill operations produce one end-of-operation response instead of one response per changed cell, while ordinary single-cell edits keep their existing fast path.
• Preserved the 1.x toolbar default (show_toolbar=False); enable it explicitly when needed.
• Large internal cleanup (removed dead collector/processor modules) and a new unit test suite.
• See MIGRATION.md for the full migration guide.

Release validation

Components V2 loads its frontend from metadata embedded in the distribution, so a source-only test cannot catch a missing package, manifest, or asset directory. Before publishing, build the frontend, wheel, and source distribution, then run the packaging contract against the exact artifacts that will be uploaded:

yarn build
poetry build
pytest -q test/unit/test_packaging_contract.py

The check selects the sole wheel and source distribution in dist/ and verifies their metadata, both public import packages, embedded component manifest, and the exact hashed JavaScript and CSS assets. Set STREAMLIT_AGGRID_WHEEL and STREAMLIT_AGGRID_SDIST when validating artifacts stored elsewhere.

The million-row end-to-end suite is an absolute regression smoke check with generous, machine-dependent thresholds. It does not compare 1.x and 2.x and must not be used as evidence that Components V2 is faster without a controlled baseline run against both versions.

Enterprise cell selection and batched clipboard edits

AG Grid Enterprise is required for its Excel-compatible clipboard, cell selection, and aggregation status panel. The wrapper can enable those modules, but its MIT licence does not grant an AG Grid Enterprise licence; production users must provide a suitable AG Grid 36 licence key.

options = {
    "defaultColDef": {"editable": True},
    "cellSelection": True,
    "statusBar": {
        "statusPanels": [
            {
                "statusPanel": "agAggregationComponent",
                "statusPanelParams": {
                    "aggFuncs": ["count", "sum", "min", "max", "avg"]
                },
            }
        ]
    },
}

response = AgGrid(
    df,
    gridOptions=options,
    enable_enterprise_modules="enterpriseOnly",
    license_key=st.secrets["AG_GRID_LICENSE_KEY"],
    clipboard_batching=True,
    key="editable-grid",
)

With batching enabled, ordinary single-cell edits still follow update_on and the selected data-return collector. Bracketed paste, cut, cell-selection delete, and fill operations suppress intermediate cellValueChanged returns and return once at pasteEnd, cutEnd, cellSelectionDeleteEnd, or fillEnd. Empty operations do not return. Legacy data-return modes keep their usual .data snapshot and add response.clipboard_batch / .clipboard_changes; MINIMAL returns only the compact batch. A CUSTOM collector runs once and can map eventData.cellChanges, whose entries retain the usual native cellValueChanged fields (data, context, node, column, colDef, oldValue, and newValue).

When the complete Streamlit app is embedded cross-origin, the outer iframe may also need allow="clipboard-read; clipboard-write" and a compatible browser Permissions Policy.

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
• post1: fixes empty data initialization.

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

• Solves #306 and #305

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.

[!WARNING] v1.0.0 breaks compatibility with previous versions and many people reached me to say that it is unstable.
Main changes are on gridReturn object as I'm moving heavy processment to python side.
I'm working to stabilize it, if you find any issues, please open a topic on the issue tracker
with a reproductile example, if possible.
Meanwhile use the last v.0.3.4 if things are not working for you! I hope to have everything fixed soon.

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 4^th 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...