fix(core): Sort Priority Zero Based #4807
Merged
Conversation
This file contains 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
JLLeitschuh
force-pushed
the
fix/sortingZeroIndexed
branch
from
6fe0528
to
cca7734
Compare
|
This has a breaking change. It would be good to do a version bump to 3.1.0 after this is merged. |
| @@ -1876,12 +1876,12 @@ angular.module('ui.grid') | |||
| p = 0; | |||
|
|
|||
| self.columns.forEach(function (col) { | |||
| if (col.sort && col.sort.priority && col.sort.priority > p) { | |||
| p = col.sort.priority; | |||
| if (col.sort && col.sort.priority !== 'undefined' && col.sort.priority >= p) { | |||
There was a problem hiding this comment.
I think here you should compare col.sort.priority to undefined and not 'undefined' or typeof col.sort.priority !== 'undefined'
There was a problem hiding this comment.
Thanks! I'll change that. I saw it like this somewhere else.
|
@JLLeitschuh can you fix the merge issues? I think we need to get this merged and released as soon as we can. thanks. |
|
Yea, I'll try to fix this today. |
JLLeitschuh
force-pushed
the
fix/sortingZeroIndexed
branch
from
cca7734
to
6d41f3d
Compare
Before sort priority was a mix of 0 and 1 based. You could create columns with a sort priority of zero but once the user clicked on a column to sort it its index would change to 1. There was no way for the sort index to return to 0 from within the grid's menus. This mix of 0 and 1 based sorting was confusing and created UI problems when displaying the sort index in the column header. Closes angular-ui#4685 BREAKING CHANGE: **GridOptions.columnDef.sort.priority** now expects the lowest value to be 0. The Grid Header will display a sort priority of 0 as 1. Using `if(col.sort.priority)` to determine if a column is sorted is no longer valid as `0 == false`. Saved grid objects may be affected by this.
JLLeitschuh
force-pushed
the
fix/sortingZeroIndexed
branch
from
6d41f3d
to
62dbcfe
Compare
swalters
added a commit
that referenced
this pull request
Jan 22, 2016
fix(core): Sort Priority Zero Based
| @@ -21,13 +21,13 @@ | |||
| aria-label="{{getSortDirectionAriaLabel()}}"> | |||
| <i | |||
| ng-class="{ 'ui-grid-icon-up-dir': col.sort.direction == asc, 'ui-grid-icon-down-dir': col.sort.direction == desc, 'ui-grid-icon-blank': !col.sort.direction }" | |||
| title="{{isSortPriorityVisible() ? i18n.headerCell.priority + ' ' + col.sort.priority : null}}" | |||
| title="{{isSortPriorityVisible() ? i18n.headerCell.priority + ' ' + ( col.sort.priority + 1 ) : null}}" | |||
There was a problem hiding this comment.
In Grid.js line 1880 aren't you bumping up the sortPriority, so adding 1 again here would be incorrect?
swalters
added a commit
that referenced
this pull request
Jan 22, 2016
ShayArtzi
pushed a commit
to ShayArtzi/ui-grid
that referenced
this pull request
Jan 22, 2016
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Before sort priority was a mix of 0 and 1 based.
You could create columns with a sort priority of zero but once the user
clicked on a column to sort it its index would change to 1. There was no
way for the sort index to return to 0 from within the grid's menus.
This mix of 0 and 1 based sorting was confusing and created UI problems
when displaying the sort index in the column header.
Closes #4685
BREAKING CHANGE:
GridOptions.columnDef.sort.priority now expects the lowest value
to be 0.
The Grid Header will display a sort priority of 0 as 1.
Using
if(col.sort.priority)to determine if a column is sorted is nolonger valid as
0 == false.Saved grid objects may be affected by this.