Skip to content

CHANGELOG.md

Latest commit

 

History

History
434 lines (296 loc) · 23.7 KB

CHANGELOG.md

File metadata and controls

434 lines (296 loc) · 23.7 KB

Change Log for Dash AG Grid

All notable changes to dash-ag-grid will be documented in this file. This project adheres to Semantic Versioning. Links "DE#nnn" prior to version 2.0 point to the Dash Enterprise closed-source Dash AG Grid repo

[unreleased]

[33.3.3] - 2025-12-19

Fixed

  • #408 fixed issue where the columnState would conflict with columnDefs updates
  • #412 fix "Multi-Column Filter not properly recognized in filterParams"
  • #427 exposes agGrid from the community package for use in custom themes and functions

[33.3.2rc2] - 2025-09-17

Fixed

  • #403 fix "Maximum update depth exceeded" error

[32.3.2] - 2025-09-17

Fixed

  • #403 fix "Maximum update depth exceeded" error

[32.3.2rc1] - 2025-08-05

Fixed

  • #394 allow cellRenderer column def to be a function

[32.3.1] - 2025-08-05

Fixed

  • #394 allow cellRenderer column def to be a function

[33.3.2rc0] - 2025-07-29

Changed

  • bump to v33.3.2 for the grid
  • legacy (CSS-only) themes now require stylesheets to be loaded externally (for example, via the external_stylesheets kwarg to the Dash constructor). See tests/examples/themes_legacy.py for an example.
  • dashGridOptions now accepts a theme string or function as per AG Grid's latest theming system. See tests/examples/themes.py for examples.
  • defaultProps no longer used in modern React versions

[32.3.0] - 2025-07-23

Changed

  • Component is refactored to be a function component rather than a class

Fixed

[32.3.0rc0] - 2025-04-15

Fixed

  • #328 fixed issue where getRowStyle wast able to be passed as a complete function

Changed

  • #328
    • bumping to v32.3 for the grid
    • the grid checks if updates are from an internal source (3.0.2 dash) and will selectively rerender if so

[31.3.1] - 2025-03-17

Fixed

  • #346 Fixes issue #347 where styling wasnt considering if the grid had rows without data. This is related to the alteration in #332
  • #353 Adjustments for support of Dash 3

Added

  • #352 Adds eventData prop for devs to send arbitrary events from the grid events complete with an auto timestamp

Changed

  • #362 bumping to v31.3.4 for the grid

[31.3.0] - 2024-11-22

Fixed

  • #300 Fixes issue #299 where grid was unmounted and trying to update the columnState.
  • #325 Fixes issue #324 where pivotComparator functions were not sorting columns correctly because they were only being passed params.
  • #314
    • locking selenium for tests that were failing due to missing import
  • #313
    • #312 fixing issue where scrollTo was defaulting to not reset the value
      • to maintain scroll position during a grid rerender, be sure to use getRowId
    • fixing side issue where cellDoubleClicked was forcing the grid to rerender
  • #331
    • adjusted setProps -> customSetProps which tests if the grid is active in the dash tree and mounted.
    • #307 fixes JS console error because setProps is no longer called when unmounted.

Added

  • #330 Added dash_clientside to available functions for easier one-liner functions, esp. eventListeners.

Changed

  • #327 bumping to v31.3.2 for the grid
  • #332
    • handleDynamicStyle now checks for params.data before attempting to apply the test
    • #321 fixes issue with infinite scroll and dynamic row styling

[31.2.0] - 2024-02-25

Changed

  • #273 increased the timeout for getApiAsync to 2 minutes.
  • #281 webpack is now designed to build quicker, excludes node_modules and uses a different parser
  • #287 bumping to v31.2.1 for the grid

Added

  • #270
    • support for eventListeners to be added to the grid that get loaded upon gridReady
    • eventListeners are added upon gridReady only, if you need to add or remove other event listeners, please use the getApi or getApiAsync methods
    • added default for selectedRows to be []

Fixed

  • #283
    • selectedRows can now be passed along with the rowData
  • #287
    • aggFuncs can now be passes as an object from the grid to be mapped to functions
    • fixes #278

[31.0.1] - 2024-02-07

  • #266 Updated README

[31.0.0] - 2024-02-01

Added

  • #246
    • grid_version added to allow developer to see underlying AG Grid version in python
    • Added quartz theme native support
    • Added function support for dateParser, dateFormatter, quickFilterParser, components, quickFilterMatcher, predicate, textFormatter, textMatcher, numberFormatter, numberParser, dataTypeMatcher

Removed

  • #246 dropped getColumnApi and getColmunApiAsync as these are deprecated from the underlying grid.

Changed

  • #261 The cellValueChanged property has changed been changed from a (single) event object to a list of event objects. For multi-cell edits, the list will contain an element per change. In other cases, the list will contain a single element. Fixes #262
  • #246
    • updating underlying grid version from AG Grid v29 -> v31, with this change, Dash AG Grid will reflect a similar version number to underlying Grid version.
    • dataTypeDefinitions now supports full js, partial python with full definitions in js of an object, and objects have parts that are js
    • columnSize and columnState cannot be currently passed together when grid initializes, the columnSize will trump the columnState

Fixed

  • #246 testing for grid going to destroyed state

[2.4.0] - 2023-10-17

Added

  • #243 Added function support for:
    • getContextMenuItems, isRowMaster, setPopupParent, popupParent, filter
    • iterate through csvExportParams and defaultCsvExportParams for functions:
      • getCustomContextBelowRow, shouldRowBeSkipped, processCellCallback, processHeaderCallback, processGroupHeaderCallback, processRowGroupCallback

Fixed

  • #237 Fixed issue with grid components not being passed down to the detail grids
  • #232 Fixed height style to unassign automatically if domLayout = 'autoHeight', addresses #231

[2.3.0] - 2023-07-27

Added

  • #212 Async function for getApiAsync and getColumnApiAsync for use with grid initializing

Fixed

  • #226 Fixed issue when using grouped rows with rowData and virtualRowData populating incorrectly. #215

[2.2.0] - 2023-06-20

Added

  • #199 Add scrollTo prop which allows scrolling to rows and columns.
  • #209 Add getApi and getColumnApi to dash_ag_grid namespace to allow for JS functions to call the grid's API directly

Fixed

  • 210 Fix issue with columnState and React 18

Updated

  • 210 Migrate props that use setProps from the render() to componentDidUpdate

[2.1.0] - 2023-06-02

Added

  • #201 Add cellDoubleClicked prop, which works exactly like cellClicked

Updated

  • #174

    • columnState floats during grid interaction and only gets pushed when sent in a callback
    • columnDefs trumps columnState if it is pushed in a callback without a columnState

  • #207 Update AG Grid from 29.3.3 to 29.3.5, with a few minor bugfixes, see their changelog for 29.3.4 and 29.3.5. Also other minor dependency updates.

Fixed

  • #174 Fix #171: Markdown renderer now displays a blank cell rather than writing undefined if there is no value

  • #204 filterOptions will now work as a regular object

  • #206 Fix #195 where if the user was to redo the exact same action, callbacks on cellValueChanged would not trigger again. Fix by adding timestamp into the object, as we have in other event-type props to make them unique.

[2.0.0] - 2023-05-02

Removed

  • Overhaul commit

    • Remove agGridColumns component due to deprecation in AG Grid v29, use columnDefs instead.
    • Remove some hardcoded CSS

  • #132 Remove prop autoSizeAllColumns, use the columnSize prop instead.

Added

  • Overhaul commit

    • Add className prop for css customization native to AG Grid
    • Add enable* props for easier user / dash manipulation, for creating buttons
    • Add overarching dangerously_allow_code prop to grid props only provided at render, to keep columnDefs from receiving possible updates to execute malicious JavaScript (originally called dangerously_allow_html but renamed later)
    • Add data_previous and data_previous_timestamp props to allow easier change tracking in callbacks
    • Add dashGridOptions prop to allow for arbitrary use of AG Grid props not explicitly listed
    • Add setRowId prop to allow rowData change detection
    • Add columnState prop to retrieve the current state of the columns after user interaction

  • #6

    • Allow strings of functions to be passed as parameters to valueGetterFunction, valueFormatterFunction. This allows for functions to be parsed even in a strict CSP environment.
    • Add row conditional formatting via getRowStyle, acts similar to cellStyles
    • Add ability for custom parsing functions to be passed via the namespace window.dashAgGridFunctions
    • Allow for null to be passed to columnSize, to prevent the fit to width or autosize being the only options

  • #28

    • Allow for other column prop functions to pass without disabling them if dangerously_allow_code is not passed
    • Copy over columnDef dangerously_allow_code to allow for the prop to be placed only on the grid level
    • Keep params together instead of splitting into separate keys, to allow for easier transition to using AG Grid docs

  • #39

    • Allow for defaultColDef to be iterated through for functions
    • Add tooltipComponent to be altered if it was list as a function object

  • #49 Safely handle more attributes when dangerously_allow_code is disabled:

    • Top-level attributes rowClassRules, getRowStyle, and getRowClass
    • Column attributes cellClass, cellStyle, and cellClassRules

  • #67 Function parsing recursive columnDefs

    • Add more functions to be available for parsing
    • Allow for recursively going through columnDefs -> children and master detail info

  • #76 Add logging function available by default, available via {"function": "log()"}

  • #111 Add filterModel prop in order to capture the grid's active filters

  • #132

    • Add new columnSize option responsiveSizeToFit, which will adjust column sizes based upon grid size and columns added or removed
    • Add columnSizeOptions prop to modify the behavior chosen in columnSize
    • Add ability to push columnState back to grid and replay the settings

  • #145

    • Support alignedGrids
    • Support functions with tooltipComponentParams
    • Add paginationInfo for read-only info from the grid's pagination
    • Add paginationGoTo to navigate to different pages

-#164 Support passing selectedRows functions or ids for performing selections

Updated

  • Overhaul commit

    • Update AG Grid from v27.x to v29.x - see AG Grid Changelog for details.
    • Update markdown renderer to use github markdown, and also have the ability to be passed a target for links, to avoid dangerously_allow_code
    • Update requirements.txt (Python dependencies for demos and docs) to allow the latest packages

  • #39

    • Change selectionChanged to selectedRows to make props align with AG Grid
    • Allow selectedRows to persist

  • #70 Change clickData to cellRendererData to more closely line up with what this does

  • #81

    • Prop clean-up overhaul
    • Remove cellStyle from the grid level, allowing more flexibility in customization, and alignment with AG grid
    • Allow for functions, styleConditions and regular dictionaries to be passed to the cellStyle on all levels
    • Add rowId to cellClicked data

  • #132 Change columnSize option of autoSizeAll -> autoSize

  • #145 and #159 Update AG Grid 29.1.0 -> 29.3.3

  • #155

    • Update React to 18.2.0
    • Update material-ui to @mui for rowMenuRenderer

-#164 Update selectedRows to maintain persistence by utilizing rowIds if available

Fixed

  • Overhaul commit

    • Fix conditional formatting for nested columns
    • Fix issue where columns would not take edits or adjustments due to becoming static

  • #6 Fix props issue for enableAddRows

  • #19 Fixed cellClicked as reported in #17

  • #45 Fix #44, markdown ignoring target="_blank" to open links in a new tab. Now if dangerously_use_code is false, markdown cells honor columnDef.linkTarget, but if dangerously_use_code is true you MUST use the HTML syntax <a target="_blank"> to achieve this, markdown syntax [text](url) will ignore columnDef.linkTarget.

  • #47 Fix virtualRowData by setting the default rowModelType='clientSide'

  • #81 Fix syncing issue with rowData, virtualRowData when cell edits and async rowTransactions occur

  • #90 Fix columnState to be populated once gridReady

  • #92 Fix defaultStyle when no styleConditions is in cellStyle

  • #111 Fix templates to only populate when dangerously_allow_code=True

  • #132 Fix columnSize to update upon interaction

  • #145

    • Fix onRowDragEnd to trigger virtualRowData update
    • Fix all virtualRowData updates to take into account sorting

  • #155 and #158

    • Fix openGroups where clearing out the set would cause issues
    • Fix paginationGoTo to work with a starting page

  • #161 Fix the default style to be applied even when a style is given from the developer. style.height and style.width always exist but can be overridden if other values are provided in the style prop.

-#164

  • Fix comparator to not be restricted to just params
  • Fix paginationGoTo to allow 0 to be passed

[1.3.2] - 2023-01-13

Updated

  • DE#146 Update DashAgGrid component to be async.

[1.3.1] - 2022-05-05

Fixed

  • DE#129 Rebuild with latest dash component generator for Py3.6 compatibility

[1.3.0] - 2022-05-03

Removed

  • DE#126 AG Grid v27 drops support for IE11

Updated

  • DE#126 Update AG Grid to v27.2.1.

Added

  • DE#125 Enable sparklines
  • DE#124 Add Sidebar support
  • DE#87 Add virtualRowData for accessing filtered data

Fixed

  • DE#105 and DE#108 Update column widths when table is resized or a callback changes columnDefs.
  • DE#96 Persist filters when rowData changes
  • DE#90 and DE#86 Improved selections algorithm
  • DE#88 Persist row groupings when rowData changes

[1.2.1] - 2021-11-23

  • Selections fixes by @ndrezn in DE#78
  • Add 2.0 support by @ndrezn in DE#82
  • Request & response for master detail by @ndrezn in DE#79
  • Update look of docs

[1.2.0] - 2021-10-27

[1.1.2] - 2021-10-16

  • DE#69: Improve support for persistence with selectionChanged.

[1.1.1] - 2021-09-21

  • Fix issue with selectionChanged write support

[1.1.0] - 2021-09-21

  • Adds support for persistence
  • Adds support for exporting data as CSV/excel
  • Adds support for column reset

[1.0.0] - 2021-06-01

This release is as v1.0.0 as it indicates production-ready, and changes the API for infinite scroll.

Fixed

  • DE#47 Fix issues with infinite scroll support

[0.2.0] - 2021-05-21

Added

  • DE#43 Add row menus support
  • DE#42 Add support for DDK theming
  • DE#38 Add Markdown support

Changed

  • DE#37 Remove build artifacts from tracking
  • DE#45 Make download link a dcc.Download component in docs

[0.1.0] - 2021-05-03

Added

  • DE#28 Add cell styling support

Changed

  • DE#31 Allow users to pass in Enterprise key and control whether Enterprise or Community modules are enabled
  • DE#30 New demo illustrating how to generate a popup from a table
  • DE#29 New demo illustrating how to download the dataset from a grid as a CSV file
  • DE#27 Use DDK and GDWC for demo app

[0.0.1] - 2021-04-12

Added

  • DE#8 Add support for selections
  • DE#9 Add support for checkboxes
  • DE#11 Improve editing support
  • DE#14 Autosizing for columns
  • DE#16 Infinite scroll support
  • DE#19 Add API demo/documentation

Changed

  • DE#7 Fix start script to run locally
  • DE#15 Style property
  • DE#20 Default to ag-grid Enterprise