Skip to content

fix(list): don't handle events when modifier key is pressed #14313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 29, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions src/lib/list/selection-list.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,26 @@ describe('MatSelectionList without forms', () => {
expect(ENTER_EVENT.defaultPrevented).toBe(true);
});

it('should not be able to toggle an item when pressing a modifier key', () => {
const testListItem = listOptions[1].nativeElement as HTMLElement;
const selectList =
selectionList.injector.get<MatSelectionList>(MatSelectionList).selectedOptions;

expect(selectList.selected.length).toBe(0);

[ENTER, SPACE].forEach(key => {
const event = createKeyboardEvent('keydown', key, testListItem);
Object.defineProperty(event, 'ctrlKey', { get: () => true });

dispatchFakeEvent(testListItem, 'focus');
selectionList.componentInstance._keydown(event);
fixture.detectChanges();
expect(event.defaultPrevented).toBe(false);
});

expect(selectList.selected.length).toBe(0);
});

it('should not be able to toggle a disabled option using SPACE', () => {
const testListItem = listOptions[1].nativeElement as HTMLElement;
const selectionModel = selectionList.componentInstance.selectedOptions;
Expand Down Expand Up @@ -332,6 +352,20 @@ describe('MatSelectionList without forms', () => {
expect(event.defaultPrevented).toBe(true);
});

it('should not change focus when pressing HOME with a modifier key', () => {
const manager = selectionList.componentInstance._keyManager;
expect(manager.activeItemIndex).toBe(-1);

const event = createKeyboardEvent('keydown', HOME);
Object.defineProperty(event, 'shiftKey', { get: () => true });

dispatchEvent(selectionList.nativeElement, event);
fixture.detectChanges();

expect(manager.activeItemIndex).toBe(-1);
expect(event.defaultPrevented).toBe(false);
});

it('should focus the last item when pressing END', () => {
const manager = selectionList.componentInstance._keyManager;
expect(manager.activeItemIndex).toBe(-1);
Expand All @@ -343,6 +377,20 @@ describe('MatSelectionList without forms', () => {
expect(event.defaultPrevented).toBe(true);
});

it('should not change focus when pressing END with a modifier key', () => {
const manager = selectionList.componentInstance._keyManager;
expect(manager.activeItemIndex).toBe(-1);

const event = createKeyboardEvent('keydown', END);
Object.defineProperty(event, 'shiftKey', { get: () => true });

dispatchEvent(selectionList.nativeElement, event);
fixture.detectChanges();

expect(manager.activeItemIndex).toBe(-1);
expect(event.defaultPrevented).toBe(false);
});

it('should select all items using ctrl + a', () => {
const event = createKeyboardEvent('keydown', A, selectionList.nativeElement);
Object.defineProperty(event, 'ctrlKey', {get: () => true});
Expand Down
28 changes: 21 additions & 7 deletions src/lib/list/selection-list.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,16 @@
import {FocusableOption, FocusKeyManager} from '@angular/cdk/a11y';
import {coerceBooleanProperty} from '@angular/cdk/coercion';
import {SelectionModel} from '@angular/cdk/collections';
import {SPACE, ENTER, HOME, END, UP_ARROW, DOWN_ARROW, A} from '@angular/cdk/keycodes';
import {
SPACE,
ENTER,
HOME,
END,
UP_ARROW,
DOWN_ARROW,
A,
hasModifierKey,
} from '@angular/cdk/keycodes';
import {
AfterContentInit,
Attribute,
Expand Down Expand Up @@ -417,21 +426,26 @@ export class MatSelectionList extends _MatSelectionListMixinBase implements Focu
const keyCode = event.keyCode;
const manager = this._keyManager;
const previousFocusIndex = manager.activeItemIndex;
const hasModifier = hasModifierKey(event);

switch (keyCode) {
case SPACE:
case ENTER:
this._toggleFocusedOption();
// Always prevent space from scrolling the page since the list has focus
event.preventDefault();
if (!hasModifier) {
this._toggleFocusedOption();
// Always prevent space from scrolling the page since the list has focus
event.preventDefault();
}
break;
case HOME:
case END:
keyCode === HOME ? manager.setFirstItemActive() : manager.setLastItemActive();
event.preventDefault();
if (!hasModifier) {
keyCode === HOME ? manager.setFirstItemActive() : manager.setLastItemActive();
event.preventDefault();
}
break;
case A:
if (event.ctrlKey) {
if (hasModifierKey(event, 'ctrlKey')) {
this.options.find(option => !option.selected) ? this.selectAll() : this.deselectAll();
event.preventDefault();
}
Expand Down