You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Add `className` prop for css customization native to ag-grid
20
+
- Add `className` prop for css customization native to AG Grid
22
21
- Add `enable*` props for easier user / dash manipulation, for creating buttons
23
22
- 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)
24
23
- Add `data_previous` and `data_previous_timestamp` props to allow easier change tracking in callbacks
@@ -33,47 +32,38 @@ Links "DE#nnn" prior to version 2.0 point to the Dash Enterprise closed-source D
33
32
- Allow for `null` to be passed to `columnSize`, to prevent the fit to width or autosize being the only options
- Allowed for `defaultColDef` to be iterated through for functions
45
-
- Added `tooltipComponent` to be altered if it was list as a function object
46
-
- Added tests for `custom_components.py`, and made it so the stock data is pulled from a csv instead of live.
47
-
48
-
-[#49](https://github.com/plotly/dash-ag-grid/pull/49) Safely handle more attributes when `dangerously_allow_code` is disabled: top-level attributes `rowClassRules`, `getRowStyle`, and `getRowClass`; and column attributes `cellClass`, `cellStyle`, and `cellClassRules`.
40
+
- Allow for `defaultColDef` to be iterated through for functions
41
+
- Add `tooltipComponent` to be altered if it was list as a function object
49
42
50
-
-[#67](https://github.com/plotly/dash-ag-grid/pull/67) Function parsing recursvie columndefs
51
-
- adding more functions to be available for parsing
52
-
- allowed for recursively going through `columnDefs` -> `children` and master detail info
53
-
- added various tests for functionality
43
+
-[#49](https://github.com/plotly/dash-ag-grid/pull/49) Safely handle more attributes when `dangerously_allow_code` is disabled:
44
+
- Top-level attributes `rowClassRules`, `getRowStyle`, and `getRowClass`
45
+
- Column attributes `cellClass`, `cellStyle`, and `cellClassRules`
54
46
55
-
-[#76](https://github.com/plotly/dash-ag-grid/pull/76) Adding logging function
56
-
- adding logging function available by default, available via `{"function": "log()"}`
47
+
-[#67](https://github.com/plotly/dash-ag-grid/pull/67) Function parsing recursive columnDefs
48
+
- Add more functions to be available for parsing
49
+
- Allow for recursively going through `columnDefs` -> `children` and master detail info
- updated `columnSize` option of `autoSizeAll` -> `autoSize`
86
+
-[#132](https://github.com/plotly/dash-ag-grid/pull/132) Change `columnSize` option of `autoSizeAll` -> `autoSize`
101
87
102
-
-[#145](https://github.com/plotly/dash-ag-grid/pull/145) and [#159](https://github.com/plotly/dash-ag-grid/pull/159)
103
-
- updated AG Grid `29.1.0` -> `29.3.3`
88
+
-[#145](https://github.com/plotly/dash-ag-grid/pull/145) and [#159](https://github.com/plotly/dash-ag-grid/pull/159) Update AG Grid `29.1.0` -> `29.3.3`
- Fix issue where conditional formatting was not applied to nested columns
98
+
- Fix conditional formatting for nested columns
115
99
- Fix issue where columns would not take edits or adjustments due to becoming static
116
100
117
101
-[#6](https://github.com/plotly/dash-ag-grid/pull/6) Fix props issue for `enableAddRows`
102
+
118
103
-[#19](https://github.com/plotly/dash-ag-grid/pull/19) Fixed `cellClicked` as reported in [#17](https://github.com/plotly/dash-ag-grid/issues/17)
104
+
119
105
-[#45](https://github.com/plotly/dash-ag-grid/pull/45) Fix [#44](https://github.com/plotly/dash-ag-grid/issues/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`.
106
+
120
107
-[#47](https://github.com/plotly/dash-ag-grid/pull/47) Fix `virtualRowData` by setting the default `rowModelType='clientSide'`
121
-
-[#81](https://github.com/plotly/dash-ag-grid/pull/81) Fixing syncing issue with `rowData`, `virtualRowData` when cell edits and async `rowTransactions` occur
122
-
-[#90](https://github.com/plotly/dash-ag-grid/pull/90) Fixing `columnState` to be populated once `gridReady`
123
-
-[#92](https://github.com/plotly/dash-ag-grid/pull/92) Fixing `defaultStyle` when no `styleConditions` is in `cellStyle`
- fixing templates to only populate when `dangerously_allow_code=True`
109
+
-[#81](https://github.com/plotly/dash-ag-grid/pull/81) Fix syncing issue with `rowData`, `virtualRowData` when cell edits and async `rowTransactions` occur
- fixed the default style to be applied even when a style is given from the developer, `style.height` and `style.width` always exist and can be overridden by the developer if provided
127
+
-[#161](https://github.com/plotly/dash-ag-grid/pull/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.
Copy file name to clipboardExpand all lines: README.md
+15-20
Original file line number
Diff line number
Diff line change
@@ -1,43 +1,39 @@
1
1
# Dash AG Grid
2
2
3
-
Dash AG Grid is a Dash component wrapper for the AG Grid Javascript package, enabling you to display AG Grid tables natively in your Dash app.
3
+
Dash AG Grid is a Dash component wrapper for the AG Grid JavaScript package, enabling you to display AG Grid components natively in your Dash app.
4
4
5
-
The underlying AG Grid Javascript package is a third-party software component developed by [AG Grid Ltd](http://www.ag-grid.com/). Many AG Grid features are available for free in the AG Grid [Community version](https://github.com/ag-grid/ag-grid). However, some features require a paid subscription to the AG Grid Enterprise version ([more info available here](https://www.ag-grid.com/license-pricing.php)). The demos which use Enterprise features are clearly marked.
5
+
The underlying AG Grid JavaScript package is a third-party software component developed by [AG Grid Ltd](http://www.ag-grid.com/). Many features are available for free in the AG Grid [Community version](https://github.com/ag-grid/ag-grid). Some features require a paid subscription to the AG Grid Enterprise version ([more info available here](https://www.ag-grid.com/license-pricing.php)). Both the community and enterprise versions are included in this component, but the enterprise features require you to provide a valid AG Grid license key. The demos which use Enterprise features are clearly marked.
6
6
7
7
8
+
## v2.0.0 Release
8
9
9
-
## Dash AG Grid is currently a prerelease
10
-
11
-
We've completed all planned breaking changes, and we're now doing the final review before the full 2.0.0 release!
12
-
13
-
If you have tried previous alpha releases, please see our [Migration Guide.](https://dashaggrid.pythonanywhere.com/getting-started/migration-guide)
14
-
10
+
If you have tried v2.0.0 alpha releases, release candidates, or our v1.x enterprise package, please see our [Migration Guide](https://dash.plotly.com/dash-ag-grid/migration-guide) (previously hosted [here](https://dashaggrid.pythonanywhere.com/getting-started/migration-guide)).
15
11
16
12
17
13
### Getting Started
18
14
19
-
`pip install dash-ag-grid==2.0.0rc2`
20
-
21
-
1. Read the [Medium article](https://medium.com/plotly/announcing-dash-ag-grid-fbb4a1c83e62#:~:text=Dash%20AG%20Grid%20is%20a,grid%20accessible%20to%20our%20customers) or watch the [webinar](https://www.youtube.com/watch?v=Ggekq7C5pz4?utm_source=Webinar%3A+AG+Grid+1%2F26%2F23&utm_medium=medium_article&utm_content=AnnouncingDashAGGrids) introducing Dash AG Grid.
22
-
2. See the live [stock portfolio demo app](https://sales-demo.plotly.com/dash-ag-grid) from the webinar hosted by Plotly.
23
-
3. Get the code for the demo app in [GitHub](https://github.com/plotly/dash-ag-grid/blob/dev/docs/demo_stock_portfolio.py)
24
-
4. Learn more about [AG Grid](https://www.ag-grid.com/react-data-grid) in the upstream docs, including more information on community features and licensing for the enterprise version.
15
+
`pip install dash-ag-grid`
25
16
17
+
1. Read the [Medium article](https://medium.com/plotly/announcing-dash-ag-grid-fbb4a1c83e62#:~:text=Dash%20AG%20Grid%20is%20a,grid%20accessible%20to%20our%20customers) or watch the [webinar](https://www.youtube.com/watch?v=Ggekq7C5pz4?utm_source=Webinar%3A+AG+Grid+1%2F26%2F23&utm_medium=medium_article&utm_content=AnnouncingDashAGGrids) introducing Dash AG Grid.
18
+
2. See the live [stock portfolio demo app](https://sales-demo.plotly.com/dash-ag-grid) from the webinar hosted by Plotly.
19
+
3. Get the code for the demo app in [GitHub](https://github.com/plotly/dash-ag-grid/blob/dev/docs/demo_stock_portfolio.py)
20
+
4. Learn more about [AG Grid](https://www.ag-grid.com/react-data-grid) in the upstream docs, including more information on community features and licensing for the enterprise version.
26
21
27
22
28
-
29
-
### See the docs app live
30
-
https://dashaggrid.pythonanywhere.com/
23
+
### Documentation
24
+
At v2.0.0 release we're still working to move all the Dash AG Grid docs into the official Dash docs, https://dash.plotly.com/dash-ag-grid.
25
+
In the meantime you can find them all here: https://dashaggrid.pythonanywhere.com/
If you have identified a bug or have an idea for a new feature, it's best to start with a GitHub issue. First look at existing issues at https://github.com/plotly/dash-ag-grid/issues to make sure this is not a duplicate issue. Then create a new issue. Bug reports should be accompanied by a small example app that someone else can copy and run to reproduce the problem.
34
+
If you have identified a bug or have an idea for a new feature, it's best to start with a GitHub issue. First look at existing issues at https://github.com/plotly/dash-ag-grid/issues to make sure this is not a duplicate. Then create a new issue. Bug reports should be accompanied by a small example app that someone else can copy and run to reproduce the problem.
39
35
40
-
The docs are under development as well. There are many examples in the official AG Grid docs that have not been included here yet. Please open an issue or do pull requests for edits or to add examples. Or post your question, comments or demo apps on the Dash Community Forum.
36
+
The docs are under development as well. There are many examples in the official AG Grid docs that have not been included here yet. Please open an issue or do pull requests for edits or to add examples. Or post your question, comments or demo apps on the [Dash Community Forum](https://community.plotly.com/).
41
37
42
38
### Running the docs app locally
43
39
```
@@ -48,7 +44,6 @@ Then you can run the apps there:
48
44
-`demo_stock_portfolio.py` and `demo_stock_portfolio_simple.py` are small apps demonstrating some key features of Dash AG Grid, such as calculated columns, conditional formatting, and connecting its data and selected rows to graphs.
49
45
-`app.py` runs a comprehensive documentation app. After we complete the open-source release, this will be merged into the main dash docs at https://dash.plotly.com/ but right now this app is the best way to explore Dash AG Grid.
50
46
51
-
52
47
### Developing in this repo
53
48
54
49
Make sure you have Dash installed with dev and testing extras:
0 commit comments