Skip to content

feat(select): allow for letter key debounce interval to be customized #16579

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
Jul 25, 2019
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
36 changes: 30 additions & 6 deletions src/material/select/select.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ import {
} from './select-errors';


/** The debounce interval when typing letters to select an option. */
const LETTER_KEY_DEBOUNCE_INTERVAL = 200;
/** Default debounce interval when typing letters to select an option. */
const DEFAULT_TYPEAHEAD_DEBOUNCE_INTERVAL = 200;

describe('MatSelect', () => {
let overlayContainer: OverlayContainer;
Expand Down Expand Up @@ -469,20 +469,42 @@ describe('MatSelect', () => {
expect(formControl.value).toBeFalsy('Expected no initial value.');

dispatchEvent(select, createKeyboardEvent('keydown', 80, undefined, 'p'));
tick(200);
tick(DEFAULT_TYPEAHEAD_DEBOUNCE_INTERVAL);

expect(options[1].selected).toBe(true, 'Expected second option to be selected.');
expect(formControl.value).toBe(options[1].value,
'Expected value from second option to have been set on the model.');

dispatchEvent(select, createKeyboardEvent('keydown', 69, undefined, 'e'));
tick(200);
tick(DEFAULT_TYPEAHEAD_DEBOUNCE_INTERVAL);

expect(options[5].selected).toBe(true, 'Expected sixth option to be selected.');
expect(formControl.value).toBe(options[5].value,
'Expected value from sixth option to have been set on the model.');
}));

it('should be able to customize the typeahead debounce interval', fakeAsync(() => {
const formControl = fixture.componentInstance.control;
const options = fixture.componentInstance.options.toArray();

fixture.componentInstance.typeaheadDebounceInterval = 1337;
fixture.detectChanges();

expect(formControl.value).toBeFalsy('Expected no initial value.');

dispatchEvent(select, createKeyboardEvent('keydown', 80, undefined, 'p'));
tick(DEFAULT_TYPEAHEAD_DEBOUNCE_INTERVAL);

expect(formControl.value).toBeFalsy('Expected no value after a bit of time has passed.');

tick(1337);

expect(options[1].selected)
.toBe(true, 'Expected second option to be selected after all the time has passed.');
expect(formControl.value).toBe(options[1].value,
'Expected value from second option to have been set on the model.');
}));

it('should open the panel when pressing a vertical arrow key on a closed multiple select',
fakeAsync(() => {
fixture.destroy();
Expand Down Expand Up @@ -1969,7 +1991,7 @@ describe('MatSelect', () => {
// Press the letter 'o' 15 times since all the options are named 'Option <index>'
dispatchEvent(host, createKeyboardEvent('keydown', 79, undefined, 'o'));
fixture.detectChanges();
tick(LETTER_KEY_DEBOUNCE_INTERVAL);
tick(DEFAULT_TYPEAHEAD_DEBOUNCE_INTERVAL);
}
flush();

Expand Down Expand Up @@ -4275,7 +4297,8 @@ describe('MatSelect', () => {
<mat-form-field>
<mat-select placeholder="Food" [formControl]="control" [required]="isRequired"
[tabIndex]="tabIndexOverride" [aria-label]="ariaLabel" [aria-labelledby]="ariaLabelledby"
[panelClass]="panelClass" [disableRipple]="disableRipple">
[panelClass]="panelClass" [disableRipple]="disableRipple"
[typeaheadDebounceInterval]="typeaheadDebounceInterval">
<mat-option *ngFor="let food of foods" [value]="food.value" [disabled]="food.disabled">
{{ food.viewValue }}
</mat-option>
Expand Down Expand Up @@ -4304,6 +4327,7 @@ class BasicSelect {
ariaLabelledby: string;
panelClass = ['custom-one', 'custom-two'];
disableRipple: boolean;
typeaheadDebounceInterval: number;

@ViewChild(MatSelect, {static: true}) select: MatSelect;
@ViewChildren(MatOption) options: QueryList<MatOption>;
Expand Down
9 changes: 8 additions & 1 deletion src/material/select/select.ts
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,9 @@ export class MatSelect extends _MatSelectMixinBase implements AfterContentInit,
/** Object used to control when error messages are shown. */
@Input() errorStateMatcher: ErrorStateMatcher;

/** Time to wait in milliseconds after the last keystroke before moving focus to an item. */
@Input() typeaheadDebounceInterval: number;

/**
* Function used to sort the values in a select in multiple mode.
* Follows the same logic as `Array.prototype.sort`.
Expand Down Expand Up @@ -570,6 +573,10 @@ export class MatSelect extends _MatSelectMixinBase implements AfterContentInit,
if (changes['disabled']) {
this.stateChanges.next();
}

if (changes['typeaheadDebounceInterval'] && this._keyManager) {
this._keyManager.withTypeAhead(this.typeaheadDebounceInterval);
}
}

ngOnDestroy() {
Expand Down Expand Up @@ -897,7 +904,7 @@ export class MatSelect extends _MatSelectMixinBase implements AfterContentInit,
/** Sets up a key manager to listen to keyboard events on the overlay panel. */
private _initKeyManager() {
this._keyManager = new ActiveDescendantKeyManager<MatOption>(this.options)
.withTypeAhead()
.withTypeAhead(this.typeaheadDebounceInterval)
.withVerticalOrientation()
.withHorizontalOrientation(this._isRtl() ? 'rtl' : 'ltr')
.withAllowedModifierKeys(['shiftKey']);
Expand Down
1 change: 1 addition & 0 deletions tools/public_api_guard/material/select.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ export declare class MatSelect extends _MatSelectMixinBase implements AfterConte
sortComparator: (a: MatOption, b: MatOption, options: MatOption[]) => number;
trigger: ElementRef;
readonly triggerValue: string;
typeaheadDebounceInterval: number;
value: any;
readonly valueChange: EventEmitter<any>;
constructor(_viewportRuler: ViewportRuler, _changeDetectorRef: ChangeDetectorRef, _ngZone: NgZone, _defaultErrorStateMatcher: ErrorStateMatcher, elementRef: ElementRef, _dir: Directionality, _parentForm: NgForm, _parentFormGroup: FormGroupDirective, _parentFormField: MatFormField, ngControl: NgControl, tabIndex: string, scrollStrategyFactory: any,
Expand Down