Improve keyboard navigation in filtering #2964
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,6 +17,7 @@ import { IBaseChipEventArgs, IgxChipsAreaComponent, IgxChipComponent } from '../ | |
| import { IgxFilteringService, ExpressionUI } from './grid-filtering.service'; | ||
| import { KEYS, cloneArray } from '../../core/utils'; | ||
| import { IgxGridNavigationService } from '../grid-navigation.service'; | ||
| import { first } from 'rxjs/operators'; | ||
|
|
||
| /** | ||
| * @hidden | ||
|
|
@@ -96,52 +97,40 @@ export class IgxGridFilteringCellComponent implements AfterViewInit, OnInit { | |
| } | ||
|
|
||
| ngOnInit(): void { | ||
| this.filteringService.columnToMoreIconHidden.set(this.column.field, true); | ||
| } | ||
|
|
||
| ngAfterViewInit(): void { | ||
| this.updateFilterCellArea(); | ||
| } | ||
|
|
||
| @HostListener('keydown.tab', ['$event']) | ||
| public onTabKeyDown(eventArgs) { | ||
| if (this.isLastElementFocused()) { | ||
| if (this.column.visibleIndex === this.filteringService.grid.columnList.length - 1) { | ||
| eventArgs.preventDefault(); | ||
| if (!this.filteringService.grid.filteredData || this.filteringService.grid.filteredData.length > 0) { | ||
| this.navService.goToFirstCell(); | ||
| } | ||
| } else if (!this.navService.isColumnFullyVisible(this.column.visibleIndex + 1)) { | ||
| eventArgs.preventDefault(); | ||
| this.ScrollToChip(this.column.visibleIndex + 1, true); | ||
| } | ||
| } | ||
| eventArgs.stopPropagation(); | ||
| } | ||
|
|
||
| @HostListener('keydown.shift.tab', ['$event']) | ||
| public onShiftTabKeyDown(eventArgs) { | ||
| if (this.isFisrtElementFocused()) { | ||
| if (this.column.visibleIndex > 0 && !this.navService.isColumnLeftFullyVisible(this.column.visibleIndex - 1)) { | ||
| eventArgs.preventDefault(); | ||
| this.ScrollToChip(this.column.visibleIndex - 1, false); | ||
| } else if (this.column.visibleIndex === 0) { | ||
| eventArgs.preventDefault(); | ||
| } | ||
| } | ||
| eventArgs.stopPropagation(); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -199,6 +188,7 @@ export class IgxGridFilteringCellComponent implements AfterViewInit, OnInit { | |
| public onChipRemoved(eventArgs: IBaseChipEventArgs, item: ExpressionUI): void { | ||
| const indexToRemove = this.expressionsList.indexOf(item); | ||
| this.removeExpression(indexToRemove); | ||
| this.focusChip(); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -224,20 +214,34 @@ export class IgxGridFilteringCellComponent implements AfterViewInit, OnInit { | |
| */ | ||
| public filteringIndicatorClass() { | ||
| return { | ||
| [this.baseClass]: !this.isMoreIconHidden(), | ||
| [`${this.baseClass}--hidden`]: this.isMoreIconHidden() | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Focus a chip depending on the current visible template. | ||
| */ | ||
| public focusChip(fucusFirst?: boolean) { | ||
|
There was a problem hiding this comment. typo - focus instead of fucus There was a problem hiding this comment. This method has very high cyclomatic complexity (12). The good practice is to keep cyclomatic complexity below 6-7. Think of refactoring (extract code to other methods, combine if/else clauses, etc.) the method to avoid so many if/else expressions. There was a problem hiding this comment. This method has very high cyclomatic complexity (12). Consider refactoring this method by extracting code to other methods, joining if/else clauses, etc. There was a problem hiding this comment. It's better to provide a default value for the optional parameters. This makes the code using this parameter simpler and avoids misunderstandings. |
||
| if (this.currentTemplate === this.defaultFilter) { | ||
| if (fucusFirst) { | ||
| if (this.chipsArea.chipsList.length > 0) { | ||
| this.chipsArea.chipsList.first.elementRef.nativeElement.querySelector(`.igx-chip__item`).focus(); | ||
| } else { | ||
| this.moreIcon.nativeElement.focus(); | ||
| } | ||
| } else if (this.filteringService.focusNext) { | ||
| if (this.isMoreIconHidden() === false && this.chipsArea.chipsList.length === 0) { | ||
|
There was a problem hiding this comment. Use |
||
| this.moreIcon.nativeElement.focus(); | ||
| } else { | ||
| this.chipsArea.chipsList.first.elementRef.nativeElement.querySelector(`.igx-chip__item`).focus(); | ||
| } | ||
| } else { | ||
| if (this.isMoreIconHidden() === false) { | ||
| this.moreIcon.nativeElement.focus(); | ||
| } else { | ||
| this.chipsArea.chipsList.last.elementRef.nativeElement.querySelector(`.igx-chip__remove`).focus(); | ||
| } | ||
| } | ||
| } else if (this.currentTemplate === this.emptyFilter) { | ||
| this.ghostChip.elementRef.nativeElement.querySelector(`.igx-chip__item`).focus(); | ||
|
|
@@ -264,7 +268,7 @@ export class IgxGridFilteringCellComponent implements AfterViewInit, OnInit { | |
| this.filteringService.filter(this.column.field, this.rootExpressionsTree); | ||
| } | ||
|
|
||
| private isMoreIconHidden(): boolean { | ||
| return this.filteringService.columnToMoreIconHidden.get(this.column.field); | ||
| } | ||
|
|
||
|
|
@@ -309,4 +313,35 @@ export class IgxGridFilteringCellComponent implements AfterViewInit, OnInit { | |
| this.cdr.detectChanges(); | ||
| } | ||
| } | ||
|
|
||
| private ScrollToChip(columnIndex: number, scrollRight: boolean) { | ||
| this.filteringService.grid.nativeElement.focus({preventScroll: true}); | ||
| this.filteringService.columnToFocus = this.filteringService.grid.visibleColumns[columnIndex]; | ||
|
There was a problem hiding this comment. Setting There was a problem hiding this comment. focusNext is read in the filtering cell when we decide in which direction we should move the focus. |
||
| this.filteringService.focusNext = scrollRight; | ||
| this.filteringService.grid.headerContainer.scrollTo(columnIndex); | ||
| } | ||
|
|
||
| private isFisrtElementFocused(): boolean { | ||
|
|
||
| if (this.chipsArea && this.chipsArea.chipsList.length > 0 && | ||
|
There was a problem hiding this comment. You could combine all this code into one return statement. |
||
| this.chipsArea.chipsList.first.elementRef.nativeElement.querySelector(`.igx-chip__item`) !== document.activeElement) { | ||
| return false; | ||
| } else { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| private isLastElementFocused(): boolean { | ||
|
There was a problem hiding this comment. You could simplify this method. Too many if/else clauses. |
||
| if (this.chipsArea) { | ||
| if (this.isMoreIconHidden() && this.chipsArea.chipsList.last.elementRef.nativeElement.querySelector(`.igx-chip__remove`) !== | ||
| document.activeElement) { | ||
| return false; | ||
| } else if (!this.isMoreIconHidden() && this.moreIcon.nativeElement !== document.activeElement) { | ||
| return false; | ||
| } else { | ||
| return true; | ||
| } | ||
| } else { | ||
| return true; | ||
| } | ||
| } | ||
| } | ||
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
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
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
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this import needed? If so what about
lastwhich is also used several times in this file?