Skip to content

Commit 23565da

Browse files
committed
feat(combo): make 'clear selection' button focusable
1 parent c71bc6e commit 23565da

File tree

7 files changed

+74
-12
lines changed

7 files changed

+74
-12
lines changed

projects/igniteui-angular/src/lib/combo/combo.component.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
</ng-container>
2020
@if (displayValue) {
2121
<igx-suffix [attr.aria-label]="resourceStrings.igx_combo_clearItems_placeholder" class="igx-combo__clear-button"
22-
(click)="handleClearItems($event)">
22+
(click)="handleClearItems($event)" (keydown)="handleClearKeyDown($event)" [tabindex]="disabled ? -1 : 0" role="button">
2323
@if (clearIconTemplate) {
2424
<ng-container *ngTemplateOutlet="clearIconTemplate"></ng-container>
2525
}

projects/igniteui-angular/src/lib/combo/combo.component.spec.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2269,6 +2269,21 @@ describe('igxCombo', () => {
22692269
cancel: false
22702270
});
22712271
});
2272+
it('should clear the selection on Enter of the focused clear icon', () => {
2273+
const selectedItem_1 = combo.dropdown.items[1];
2274+
combo.toggle();
2275+
fixture.detectChanges();
2276+
simulateComboItemClick(1);
2277+
expect(combo.selection[0]).toEqual(selectedItem_1.value);
2278+
expect(combo.value[0]).toEqual(selectedItem_1.value[combo.valueKey]);
2279+
2280+
const clearBtn = fixture.debugElement.query(By.css(`.${CSS_CLASS_CLEARBUTTON}`));
2281+
UIInteractions.triggerEventHandlerKeyDown('Enter', clearBtn);
2282+
fixture.detectChanges();
2283+
expect(input.nativeElement.value).toEqual('');
2284+
expect(combo.selection.length).toEqual(0);
2285+
expect(combo.value.length).toEqual(0);
2286+
});
22722287
it('should not be able to select group header', () => {
22732288
spyOn(combo.selectionChanging, 'emit').and.callThrough();
22742289
combo.toggle();

projects/igniteui-angular/src/lib/combo/combo.component.ts

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -276,10 +276,7 @@ export class IgxComboComponent extends IgxComboBaseDirective implements AfterVie
276276
/**
277277
* @hidden @internal
278278
*/
279-
public handleClearItems(event: Event): void {
280-
if (this.disabled) {
281-
return;
282-
}
279+
public clearInput(event: Event): void {
283280
this.deselectAllItems(true, event);
284281
if (this.collapsed) {
285282
this.getEditElement().focus();
@@ -289,6 +286,26 @@ export class IgxComboComponent extends IgxComboBaseDirective implements AfterVie
289286
event.stopPropagation();
290287
}
291288

289+
/**
290+
* @hidden @internal
291+
*/
292+
public handleClearItems(event: Event): void {
293+
if (this.disabled) {
294+
return;
295+
}
296+
this.clearInput(event);
297+
}
298+
299+
/**
300+
* @hidden @internal
301+
*/
302+
public handleClearKeyDown(eventArgs: KeyboardEvent) {
303+
if (eventArgs.key === 'Enter' || eventArgs.key === ' ') {
304+
eventArgs.preventDefault();
305+
this.clearInput(eventArgs);
306+
}
307+
}
308+
292309
/**
293310
* Select defined items
294311
*

projects/igniteui-angular/src/lib/core/styles/components/combo/_combo-theme.scss

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,10 @@
270270
%igx-combo__clear-button {
271271
color: var-get($theme, 'clear-button-foreground-focus');
272272
background: var-get($theme, 'clear-button-background-focus');
273+
274+
&:focus {
275+
color: color($color: 'secondary');
276+
}
273277
}
274278
}
275279

projects/igniteui-angular/src/lib/simple-combo/simple-combo.component.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
@if (hasSelectedItem) {
2828
<igx-suffix [attr.aria-label]="resourceStrings.igx_combo_clearItems_placeholder" class="igx-combo__clear-button"
29-
(click)="handleClear($event)">
29+
(click)="handleClear($event)" (keydown)="handleClearKeyDown($event)" [tabindex]="disabled ? -1 : 0" role="button">
3030
@if (clearIconTemplate) {
3131
<ng-container *ngTemplateOutlet="clearIconTemplate"></ng-container>
3232
}

projects/igniteui-angular/src/lib/simple-combo/simple-combo.component.spec.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1230,6 +1230,19 @@ describe('IgxSimpleCombo', () => {
12301230
expect(combo.displayValue).toEqual('Wisconsin');
12311231
});
12321232

1233+
it('should clear the selection on Enter of the focused clear icon', () => {
1234+
combo.select(combo.data[2][combo.valueKey]);
1235+
fixture.detectChanges();
1236+
expect(combo.selection).toBeDefined()
1237+
expect(input.nativeElement.value).toEqual('Massachusetts');
1238+
1239+
const clearBtn = fixture.debugElement.query(By.css(`.${CSS_CLASS_CLEARBUTTON}`));
1240+
UIInteractions.triggerEventHandlerKeyDown('Enter', clearBtn);
1241+
fixture.detectChanges();
1242+
expect(input.nativeElement.value.length).toEqual(0);
1243+
expect(combo.selection).not.toBeDefined();
1244+
});
1245+
12331246
it('should display the AddItem button when allowCustomValues is true and there is a partial match', fakeAsync(() => {
12341247
fixture.componentInstance.allowCustomValues = true;
12351248
fixture.detectChanges();

projects/igniteui-angular/src/lib/simple-combo/simple-combo.component.ts

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -424,15 +424,11 @@ export class IgxSimpleComboComponent extends IgxComboBaseDirective implements Co
424424
}
425425

426426
/** @hidden @internal */
427-
public handleClear(event: Event): void {
428-
if (this.disabled) {
429-
return;
430-
}
431-
427+
public clearInput(event: Event): void {
432428
const oldSelection = this.selection;
433429
this.clearSelection(true);
434430

435-
if(!this.collapsed){
431+
if (!this.collapsed) {
436432
this.focusSearchInput(true);
437433
}
438434
event.stopPropagation();
@@ -446,6 +442,23 @@ export class IgxSimpleComboComponent extends IgxComboBaseDirective implements Co
446442
this.comboInput.focus();
447443
}
448444

445+
/** @hidden @internal */
446+
public handleClear(event: Event): void {
447+
if (this.disabled) {
448+
return;
449+
}
450+
451+
this.clearInput(event);
452+
}
453+
454+
/** @hidden @internal */
455+
public handleClearKeyDown(event: KeyboardEvent): void {
456+
if (event.key === 'Enter' || event.key === ' ') {
457+
event.preventDefault();
458+
this.clearInput(event);
459+
}
460+
}
461+
449462
/** @hidden @internal */
450463
public handleOpened(): void {
451464
this.triggerCheck();

0 commit comments

Comments
 (0)