This repository was archived by the owner on Aug 29, 2025. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 72
Refactor table API #446
Merged
Merged
Refactor table API #446
Changes from all commits
Commits
Show all changes
55 commits
Select commit
Hold shift + click to select a range
2314ad3
- column id: remove number supprt
b3ea7a0
Merge branch 'master' into core-issue-58-refactor-api
Marc-Andre-Rivet 2d56558
refactor options
54be160
update tests
594748d
add back dropdown_properties
2ea9806
move column.clerable into the dropdown props
bb1411f
dropdown_properties usage: options -> dropdown
c89f797
Merge branch 'master' into core-issue-58-refactor-api
Marc-Andre-Rivet e854f89
remove `navigation`
f9163e1
Merge branch 'core-issue-58-refactor-api' of github.com:plotly/dash-t…
51cc1bc
remove `navigation` from tests
ac44115
- rename dropdown props
5deb109
rename `column_dropdown_*` props to `dropdown_*`
fefa090
update standalone tests
9735a69
- column_id and filter on dropdown_conditional
5fade01
lint
1ff1394
update fixtures
dfff80f
fix dropdown usage
0dcfcdc
rename tooltip props
abc552b
tighten tooltip props proptypes
d053273
Merge branch 'master' into core-issue-58-refactor-api
Marc-Andre-Rivet c3b2e40
remove unused filter_type(s)
29b3910
Merge branch 'core-issue-58-refactor-api' of github.com:plotly/dash-t…
bdd61eb
- fixed_rows, fixed_columns rename + improved typing
8a225d6
lint
7ffab10
typo
d01b33d
typing
e05f625
typo + wrong sanitation logic
063462c
Merge branch 'master' into core-issue-58-refactor-api
Marc-Andre-Rivet 6521192
fix hidden borders in FF
c8ef334
Remove content_style (as part of API refactoring) (#453)
Marc-Andre-Rivet 973d94e
Refactor sorting (#454)
Marc-Andre-Rivet 0b1f68b
merge with master
fa7e455
Page, filter, sort props refactoring
Marc-Andre-Rivet 5d33f4e
Merge branch 'master' into core-issue-58-refactor-api
Marc-Andre-Rivet c9957e0
dropdown_data & tooltip_data
7c33fa0
Merge branch 'core-issue-58-refactor-api' of github.com:plotly/dash-t…
36d9ec0
rename `dropdown` nest prop `options`
f0298e6
ignore `inst` during lint
2cc9acc
dropdown -> options
c06a637
update docstrings
9f58e8a
update changelog
98834e4
clean up console errors in standalone mode
3586758
sort_as_none changelog
ce68fc6
sort_as_null
42075a2
flags and props
799369a
typing, changelog
55703a4
Update CHANGELOG.md
Marc-Andre-Rivet 4f3c4c1
Update CHANGELOG.md
Marc-Andre-Rivet 1ede48f
Update CHANGELOG.md
Marc-Andre-Rivet 7445e3d
Update CHANGELOG.md
Marc-Andre-Rivet 4609c44
column deletable, renamable changelog
b0a2c21
Apply suggestions from code review
Marc-Andre-Rivet 5a1d7d4
sort_as_null and `None` usage
da09942
Update CHANGELOG.md
Marc-Andre-Rivet File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -3,16 +3,90 @@ All notable changes to this project will be documented in this file. | |||||||
| This project adheres to [Semantic Versioning](http://semver.org/). | ||||||||
|
|
||||||||
| ## [Unreleased] | ||||||||
| ### Changed | ||||||||
| [#446](https://github.com/plotly/dash-table/pull/446) | ||||||||
| - Table API rework | ||||||||
| #### NEW | ||||||||
| - `column.sort_as_null`: Allows sorting behavior customization. | ||||||||
| Accepts an array of string, number or booleans. | ||||||||
|
|
||||||||
| #### REMOVED | ||||||||
| - `column.clearable`: Allows clearing the value of a dropdown cell. | ||||||||
| Removed in favor of `dropdown_**` `clearable` nested property. | ||||||||
| - `column.options` | ||||||||
| Removed. Redundant with `dropdown`. | ||||||||
| - `pagination_settings` | ||||||||
| Replaced by two props `page_current` and `page_size`. | ||||||||
|
|
||||||||
| #### RENAMED | ||||||||
| - `column_static_tooltip` | ||||||||
| Renamed to `tooltip`. | ||||||||
| - `column_conditional_tooltips` | ||||||||
| Renamed to `tooltip_conditional`. | ||||||||
| - `filter` | ||||||||
| Renamed to `filter_query`. | ||||||||
| - `sort_type` | ||||||||
| Renamed to `sort_mode`. | ||||||||
| - `derived_filter_structure` | ||||||||
| Renamed to `derived_filter_query_structure`. | ||||||||
|
|
||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
| #### MODIFIED | ||||||||
| - `column.deletable`: Allows column deletion. | ||||||||
| Now accepts a boolean or an array of booleans (for multi-line headers). | ||||||||
| For example, if there are multiple headers and you want the second header row to be deletable, this would be `[False, True]`. | ||||||||
| - `column.editable_name`: Allows column renaming. | ||||||||
| Renamed to `column.renamable` | ||||||||
| Now accepts a boolean or an array of booleans (for multi-line headers). | ||||||||
| For example, if there are multiple headers and you want the second row's header's name to be editable, this would be `[False, True]`. | ||||||||
| - `column.id` | ||||||||
| Now accepts `string` only -- `number` column ids can be casted to string. | ||||||||
| - `n_fixed_columns`: Will fix columns to the left. | ||||||||
| Renamed to `fixed_columns` | ||||||||
| Now accepts an object { headers: boolean, data: number } instead of a number. | ||||||||
| { headers: true } determines the number of columns to fix automatically. For example, if the rows are selectable or deletable, { headers: true } would fix those columns automatically. If { headers: true, data: 2 }, it would fix the first two data columns in addition to the selectable and deletable if visible. | ||||||||
| - `n_fixed_rows`: Will fix rows to the top. | ||||||||
| Renamed to `fixed_rows` | ||||||||
| Now accepts an object { headers: boolean, data: number } instead of a number. | ||||||||
| { headers: true } determines the number of rows to fix automatically (i.e. if there are multiple headers, it will fix all of them as well as the filter row). | ||||||||
| { headers: true, data: 2} would fix all of the header rows as well as the first 2 data rows. | ||||||||
| - `pagination_mode` | ||||||||
| Renamed to `page_action`. | ||||||||
|
Marc-Andre-Rivet marked this conversation as resolved.
|
||||||||
| `'fe'` is now `'native'`, `'be'` is now `'custom'`, and `false` is now '`none'` | ||||||||
| - `column_static_dropdown` | ||||||||
| Renamed to `dropdown`. | ||||||||
| Now an object with each entry refering to a Column ID. Each nested prop expects. | ||||||||
| `clearable` and `options`. | ||||||||
| - `column_conditional_dropdowns` | ||||||||
| Renamed to `dropdown_conditional`. | ||||||||
| `condition` changed to the same `if` nested prop used by styles. | ||||||||
| `dropdown` renamed to `options`. | ||||||||
| - `dropdown_properties` | ||||||||
| Renamed to `dropdown_data`. | ||||||||
| Matches the `data` structure. | ||||||||
| - `tooltips` | ||||||||
| Renamed to `tooltip_data`. | ||||||||
| Matches the `data` structure. | ||||||||
| - `filtering` | ||||||||
| Renamed to `filter_action`. | ||||||||
| - `sorting` | ||||||||
| Renamed to `sort_action`. | ||||||||
| - `sorting_treat_empty_string_as_none` | ||||||||
| Renamed to `sort_as_null`. | ||||||||
| Now accepts an array of string, number or booleans that can be ignored during sort. | ||||||||
| Table-level prop for the `column.sort_as_null` column nested prop. | ||||||||
| - `style_data_conditional` | ||||||||
| Renamed `filter` to `filter_query`. | ||||||||
|
|
||||||||
| ### Added | ||||||||
| [#456](https://github.com/plotly/dash-table/issues/456) | ||||||||
| - Support for dash-table is now available for R users of Dash. | ||||||||
|
|
||||||||
| ### Fixed | ||||||||
| [#434](https://github.com/plotly/dash-table/issues/434) | ||||||||
| - Fix CSS borders propeties overwrite style_* borders properties. | ||||||||
| - Fix CSS borders properties overwrite style_* borders properties. | ||||||||
|
|
||||||||
| [#435](https://github.com/plotly/dash-table/issues/435) | ||||||||
| - selected_cells background color is set through styling pipeline / derivations. | ||||||||
| - selected_cells background color is set through styling pipeline / derivations. | ||||||||
|
|
||||||||
| ## [3.7.0] - 2019-05-15 | ||||||||
| ### Added | ||||||||
|
|
@@ -315,8 +389,8 @@ The remote URL path for the bundle was incorrect. | |||||||
| } | ||||||||
|
|
||||||||
| A+B = { | ||||||||
| background_color: 'floralwhite', // from A, not overriden | ||||||||
| color: 'black', // from B, A overriden | ||||||||
| background_color: 'floralwhite', // from A, not overridden | ||||||||
| color: 'black', // from B, A overridden | ||||||||
| font_size: 22, // from B | ||||||||
| font_type: 'monospace', // from A | ||||||||
| width: 100 // from A | ||||||||
|
|
@@ -352,7 +426,7 @@ The remote URL path for the bundle was incorrect. | |||||||
| if: { column_id: string | number, header_index: number | 'odd' | 'even' }, | ||||||||
| ...CSSProperties | ||||||||
| }] | ||||||||
| - All CSSProperties are supported in kebab-cass, camelCase and snake_case | ||||||||
| - All CSSProperties are supported in kebab-case, camelCase and snake_case | ||||||||
|
|
||||||||
| ### Changed | ||||||||
| - Renaming 'dataframe' props to 'data' | ||||||||
|
|
@@ -637,7 +711,7 @@ Freeze Top Rows (Limitations) | |||||||
| Freeze Left Columns (Limitations) | ||||||||
| - performance is highly impacted if the table is in a scrollable container as the frozen columns position has to be recalculated on each scroll event; impact is minimal up to 50-100 items and makes the table difficult to use with 250-500 items | ||||||||
| - can't freeze rows and columns at the same time | ||||||||
| - when using merged headers, make sure that the number of fixed columns respects the merged headers, otherwise there will be some unresolved visual bugs/artefacts | ||||||||
| - when using merged headers, make sure that the number of fixed columns respects the merged headers, otherwise there will be some unresolved visual bugs/artifacts | ||||||||
| - rows are assumed to all have the same height | ||||||||
|
|
||||||||
| Deletable Columns (Limitations) | ||||||||
|
|
||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.