import {dispatchFakeEvent, dispatchMouseEvent} from '@angular/cdk/testing/private'; import {Component, QueryList, ViewChild, ViewChildren} from '@angular/core'; import {TestBed, fakeAsync, waitForAsync} from '@angular/core/testing'; import {By} from '@angular/platform-browser'; import {MatListItem, MatListModule} from './index'; describe('MatList', () => { beforeEach(waitForAsync(() => { TestBed.configureTestingModule({ imports: [ MatListModule, ListWithOneAnchorItem, ListWithOneItem, ListWithTwoLineItem, ListWithThreeLineItem, ListWithAvatar, ListWithItemWithCssClass, ListWithDynamicNumberOfLines, ListWithMultipleItems, NavListWithOneAnchorItem, NavListWithActivatedItem, ActionListWithoutType, ActionListWithType, ActionListWithDisabledList, ActionListWithDisabledItem, ListWithDisabledItems, StandaloneListItem, ], }); })); it('should apply an additional class to lists without lines', () => { const fixture = TestBed.createComponent(ListWithOneItem); const listItem = fixture.debugElement.query(By.css('mat-list-item'))!; fixture.detectChanges(); expect(listItem.nativeElement.classList).toContain('mat-mdc-list-item'); expect(listItem.nativeElement.classList).toContain('mdc-list-item'); expect(listItem.nativeElement.classList).toContain('mdc-list-item--with-one-line'); }); it('should apply a particular class to lists with two lines', () => { const fixture = TestBed.createComponent(ListWithTwoLineItem); fixture.detectChanges(); const listItems = fixture.debugElement.children[0].queryAll(By.css('mat-list-item')); expect(listItems[0].nativeElement.className).toContain('mdc-list-item--with-two-lines'); }); it('should apply a particular class to lists with three lines', () => { const fixture = TestBed.createComponent(ListWithThreeLineItem); fixture.detectChanges(); const listItems = fixture.debugElement.children[0].queryAll(By.css('mat-list-item')); expect(listItems[0].nativeElement.className).toContain('mdc-list-item--with-three-lines'); }); it('should apply a class to list items with avatars', () => { const fixture = TestBed.createComponent(ListWithAvatar); fixture.detectChanges(); const listItems = fixture.debugElement.children[0].queryAll(By.css('mat-list-item')); expect(listItems[0].nativeElement.className).toContain('mdc-list-item--with-leading-avatar'); expect(listItems[1].nativeElement.className).not.toContain( 'mdc-list-item--with-leading-avatar', ); }); it('should have a strong focus indicator configured for all list-items', () => { const fixture = TestBed.createComponent(ListWithThreeLineItem); fixture.detectChanges(); const listItems = fixture.debugElement.children[0] .queryAll(By.css('mat-list-item')) .map(debugEl => debugEl.nativeElement as HTMLElement); expect(listItems.every(i => i.querySelector('.mat-focus-indicator') !== null)) .withContext('Expected all list items to have a strong focus indicator element.') .toBe(true); }); it('should not clear custom classes provided by user', () => { const fixture = TestBed.createComponent(ListWithItemWithCssClass); fixture.detectChanges(); const listItems = fixture.debugElement.children[0].queryAll(By.css('mat-list-item')); expect(listItems[0].nativeElement.classList.contains('test-class')).toBe(true); }); it('should update classes if number of lines change', () => { const fixture = TestBed.createComponent(ListWithDynamicNumberOfLines); fixture.debugElement.componentInstance.showThirdLine = false; fixture.changeDetectorRef.markForCheck(); fixture.detectChanges(); const listItem = fixture.debugElement.children[0].query(By.css('mat-list-item'))!; expect(listItem.nativeElement.classList).toContain('mdc-list-item--with-two-lines'); expect(listItem.nativeElement.classList).toContain('mat-mdc-list-item'); expect(listItem.nativeElement.classList).toContain('mdc-list-item'); fixture.debugElement.componentInstance.showThirdLine = true; fixture.changeDetectorRef.markForCheck(); fixture.detectChanges(); expect(listItem.nativeElement.className).toContain('mdc-list-item--with-three-lines'); }); it('should not apply aria roles to mat-list', () => { const fixture = TestBed.createComponent(ListWithMultipleItems); fixture.detectChanges(); const list = fixture.debugElement.children[0]; const listItem = fixture.debugElement.children[0].query(By.css('mat-list-item'))!; expect(list.nativeElement.getAttribute('role')) .withContext('Expect mat-list no role') .toBeNull(); expect(listItem.nativeElement.getAttribute('role')) .withContext('Expect mat-list-item no role') .toBeNull(); }); it('should apply role="navigation" to mat-nav-list', () => { const fixture = TestBed.createComponent(NavListWithOneAnchorItem); fixture.detectChanges(); const list = fixture.debugElement.children[0]; expect(list.nativeElement.getAttribute('role')) .withContext('Expect mat-nav-list to have navigation role') .toBe('navigation'); }); it('should apply role="group" to mat-action-list', () => { const fixture = TestBed.createComponent(ActionListWithoutType); fixture.detectChanges(); const list = fixture.debugElement.children[0]; expect(list.nativeElement.getAttribute('role')) .withContext('Expect mat-action-list to have group role') .toBe('group'); }); it('should apply aria-current="page" to activated list items', () => { const fixture = TestBed.createComponent(NavListWithActivatedItem); fixture.detectChanges(); const items = fixture.componentInstance.listItems; expect(items.length) .withContext('expected list to have at least two items') .toBeGreaterThanOrEqual(2); const inactiveItem = items.get(0)!._elementRef.nativeElement; const activeItem = items.get(1)!._elementRef.nativeElement; expect(inactiveItem.hasAttribute('aria-current')).toBe(false); expect(activeItem.getAttribute('aria-current')).toBe('page'); }); it('should not show ripples for non-nav lists', fakeAsync(() => { const fixture = TestBed.createComponent(ListWithOneAnchorItem); fixture.detectChanges(); const items: QueryList = fixture.debugElement.componentInstance.listItems; expect(items.length).toBeGreaterThan(0); items.forEach(item => { dispatchMouseEvent(item._hostElement, 'mousedown'); expect(fixture.nativeElement.querySelector('.mat-ripple-element')).toBe(null); }); })); it('should allow disabling ripples for specific nav-list items', () => { const fixture = TestBed.createComponent(NavListWithOneAnchorItem); fixture.detectChanges(); const items = fixture.componentInstance.listItems; expect(items.length).toBeGreaterThan(0); // Ripples should be enabled by default, and can be disabled with a binding. items.forEach(item => expect(item.rippleDisabled).toBe(false)); fixture.componentInstance.disableItemRipple = true; fixture.changeDetectorRef.markForCheck(); fixture.detectChanges(); items.forEach(item => expect(item.rippleDisabled).toBe(true)); }); it('should create an action list', () => { const fixture = TestBed.createComponent(ActionListWithoutType); fixture.detectChanges(); const items = fixture.componentInstance.listItems; expect(items.length).toBeGreaterThan(0); }); it('should set the proper class on the action list host', () => { const fixture = TestBed.createComponent(ActionListWithoutType); fixture.detectChanges(); const host = fixture.nativeElement.querySelector('mat-action-list'); expect(host.classList).toContain('mat-mdc-action-list'); }); it('should enable ripples for action lists by default', () => { const fixture = TestBed.createComponent(ActionListWithoutType); fixture.detectChanges(); const items = fixture.componentInstance.listItems; expect(items.toArray().every(item => !item.rippleDisabled)).toBe(true); }); it('should allow disabling ripples for specific action list items', () => { const fixture = TestBed.createComponent(ActionListWithoutType); fixture.detectChanges(); const items = fixture.componentInstance.listItems.toArray(); expect(items.length).toBeGreaterThan(0); expect(items.every(item => !item.rippleDisabled)).toBe(true); fixture.componentInstance.disableItemRipple = true; fixture.changeDetectorRef.markForCheck(); fixture.detectChanges(); expect(items.every(item => item.rippleDisabled)).toBe(true); }); it('should set default type attribute to button for action list', () => { const fixture = TestBed.createComponent(ActionListWithoutType); fixture.detectChanges(); const listItemEl = fixture.debugElement.query(By.css('.mat-mdc-list-item'))!; expect(listItemEl.nativeElement.getAttribute('type')).toBe('button'); }); it('should not change type attribute if it is already specified', () => { const fixture = TestBed.createComponent(ActionListWithType); fixture.detectChanges(); const listItemEl = fixture.debugElement.query(By.css('.mat-mdc-list-item'))!; expect(listItemEl.nativeElement.getAttribute('type')).toBe('submit'); }); it('should allow disabling ripples for the whole nav-list', () => { const fixture = TestBed.createComponent(NavListWithOneAnchorItem); fixture.detectChanges(); const items = fixture.componentInstance.listItems; expect(items.length).toBeGreaterThan(0); // Ripples should be enabled by default, and can be disabled with a binding. items.forEach(item => expect(item.rippleDisabled).toBe(false)); fixture.componentInstance.disableListRipple = true; fixture.changeDetectorRef.markForCheck(); fixture.detectChanges(); items.forEach(item => expect(item.rippleDisabled).toBe(true)); }); it('should allow disabling ripples for the entire action list', () => { const fixture = TestBed.createComponent(ActionListWithoutType); fixture.detectChanges(); const items = fixture.componentInstance.listItems.toArray(); expect(items.length).toBeGreaterThan(0); expect(items.every(item => !item.rippleDisabled)).toBe(true); fixture.componentInstance.disableListRipple = true; fixture.changeDetectorRef.markForCheck(); fixture.detectChanges(); expect(items.every(item => item.rippleDisabled)).toBe(true); }); it('should disable item ripples when list ripples are disabled via the input in nav list', fakeAsync(() => { const fixture = TestBed.createComponent(NavListWithOneAnchorItem); fixture.detectChanges(); const rippleTarget = fixture.nativeElement.querySelector('.mat-mdc-list-item'); dispatchMouseEvent(rippleTarget, 'mousedown'); dispatchMouseEvent(rippleTarget, 'mouseup'); // Flush the ripple enter animation. dispatchFakeEvent(rippleTarget.querySelector('.mat-ripple-element')!, 'transitionend'); expect(rippleTarget.querySelectorAll('.mat-ripple-element').length) .withContext('Expected ripples to be enabled by default.') .toBe(1); // Flush the ripple exit animation. dispatchFakeEvent(rippleTarget.querySelector('.mat-ripple-element')!, 'transitionend'); expect(rippleTarget.querySelectorAll('.mat-ripple-element').length) .withContext('Expected ripples to go away.') .toBe(0); fixture.componentInstance.disableListRipple = true; fixture.changeDetectorRef.markForCheck(); fixture.detectChanges(); dispatchMouseEvent(rippleTarget, 'mousedown'); dispatchMouseEvent(rippleTarget, 'mouseup'); expect(rippleTarget.querySelectorAll('.mat-ripple-element').length) .withContext('Expected no ripples after list ripples are disabled.') .toBe(0); })); it('should disable item ripples when list ripples are disabled via the input in an action list', fakeAsync(() => { const fixture = TestBed.createComponent(ActionListWithoutType); fixture.detectChanges(); const rippleTarget = fixture.nativeElement.querySelector('.mat-mdc-list-item'); dispatchMouseEvent(rippleTarget, 'mousedown'); dispatchMouseEvent(rippleTarget, 'mouseup'); // Flush the ripple enter animation. dispatchFakeEvent(rippleTarget.querySelector('.mat-ripple-element')!, 'transitionend'); expect(rippleTarget.querySelectorAll('.mat-ripple-element').length) .withContext('Expected ripples to be enabled by default.') .toBe(1); // Flush the ripple exit animation. dispatchFakeEvent(rippleTarget.querySelector('.mat-ripple-element')!, 'transitionend'); expect(rippleTarget.querySelectorAll('.mat-ripple-element').length) .withContext('Expected ripples to go away.') .toBe(0); fixture.componentInstance.disableListRipple = true; fixture.changeDetectorRef.markForCheck(); fixture.detectChanges(); dispatchMouseEvent(rippleTarget, 'mousedown'); dispatchMouseEvent(rippleTarget, 'mouseup'); expect(rippleTarget.querySelectorAll('.mat-ripple-element').length) .withContext('Expected no ripples after list ripples are disabled.') .toBe(0); })); it('should be able to disable a single list item', () => { const fixture = TestBed.createComponent(ListWithDisabledItems); const listItems: HTMLElement[] = Array.from( fixture.nativeElement.querySelectorAll('mat-list-item'), ); fixture.detectChanges(); expect( listItems.map(item => { return item.classList.contains('mdc-list-item--disabled'); }), ).toEqual([false, false, false]); fixture.componentInstance.firstItemDisabled = true; fixture.changeDetectorRef.markForCheck(); fixture.detectChanges(); expect( listItems.map(item => { return item.classList.contains('mdc-list-item--disabled'); }), ).toEqual([true, false, false]); }); it('should be able to disable the entire list', () => { const fixture = TestBed.createComponent(ListWithDisabledItems); const listItems: HTMLElement[] = Array.from( fixture.nativeElement.querySelectorAll('mat-list-item'), ); fixture.detectChanges(); expect(listItems.every(item => item.classList.contains('mdc-list-item--disabled'))).toBe(false); fixture.componentInstance.listDisabled = true; fixture.changeDetectorRef.markForCheck(); fixture.detectChanges(); expect(listItems.every(item => item.classList.contains('mdc-list-item--disabled'))).toBe(true); }); it('should allow a list item outside of a list', () => { expect(() => { const fixture = TestBed.createComponent(StandaloneListItem); fixture.detectChanges(); }).not.toThrow(); }); it('should be able to disable and enable the entire action list', () => { const fixture = TestBed.createComponent(ActionListWithDisabledList); const listItems: HTMLElement[] = Array.from( fixture.nativeElement.querySelectorAll('[mat-list-item]'), ); fixture.detectChanges(); expect(listItems.every(listItem => listItem.hasAttribute('disabled'))).toBe(true); fixture.componentInstance.disableList = false; fixture.changeDetectorRef.markForCheck(); fixture.detectChanges(); expect(listItems.every(listItem => !listItem.hasAttribute('disabled'))).toBe(true); }); it('should be able to disable and enable button item', () => { const fixture = TestBed.createComponent(ActionListWithDisabledItem); const buttonItem: HTMLButtonElement = fixture.nativeElement.querySelector('[mat-list-item]'); fixture.detectChanges(); expect(buttonItem.hasAttribute('disabled')).toBe(true); fixture.componentInstance.buttonItem.disabled = false; fixture.changeDetectorRef.markForCheck(); fixture.detectChanges(); expect(buttonItem.hasAttribute('disabled')).toBe(false); }); }); class BaseTestList { items: any[] = [ {'name': 'Paprika', 'description': 'A seasoning'}, {'name': 'Pepper', 'description': 'Another seasoning'}, ]; showThirdLine: boolean = false; } @Component({ template: ` Paprika `, standalone: true, imports: [MatListModule], }) class ListWithOneAnchorItem extends BaseTestList { // This needs to be declared directly on the class; if declared on the BaseTestList superclass, // it doesn't get populated. @ViewChildren(MatListItem) listItems: QueryList; } @Component({ template: ` Paprika `, standalone: true, imports: [MatListModule], }) class NavListWithOneAnchorItem extends BaseTestList { @ViewChildren(MatListItem) listItems: QueryList; disableItemRipple: boolean = false; disableListRipple: boolean = false; } @Component({ template: ` @for (item of items; track item; let index = $index) { {{item.name}} } `, standalone: true, imports: [MatListModule], }) class NavListWithActivatedItem extends BaseTestList { @ViewChildren(MatListItem) listItems: QueryList; disableItemRipple: boolean = false; disableListRipple: boolean = false; /** Index of the activated list item in `this.items`. Set to -1 if no item is selected. */ activatedIndex = 1; } @Component({ template: ` `, standalone: true, imports: [MatListModule], }) class ActionListWithoutType extends BaseTestList { @ViewChildren(MatListItem) listItems: QueryList; disableListRipple = false; disableItemRipple = false; } @Component({ template: ` `, standalone: true, imports: [MatListModule], }) class ActionListWithType extends BaseTestList { @ViewChildren(MatListItem) listItems: QueryList; } @Component({ template: ` @for (item of items; track item) { } `, standalone: true, imports: [MatListModule], }) class ActionListWithDisabledList extends BaseTestList { disableList = true; } @Component({ template: ` `, standalone: true, imports: [MatListModule], }) class ActionListWithDisabledItem extends BaseTestList { @ViewChild(MatListItem) buttonItem: MatListItem; disableItem = true; } @Component({ template: ` Paprika `, standalone: true, imports: [MatListModule], }) class ListWithOneItem extends BaseTestList {} @Component({ template: ` @for (item of items; track item) {

{{item.name}}

{{item.description}}

}
`, standalone: true, imports: [MatListModule], }) class ListWithTwoLineItem extends BaseTestList {} @Component({ template: ` @for (item of items; track item) {

{{item.name}}

{{item.description}}

Some other text

}
`, standalone: true, imports: [MatListModule], }) class ListWithThreeLineItem extends BaseTestList {} @Component({ template: ` Paprika Pepper `, standalone: true, imports: [MatListModule], }) class ListWithAvatar extends BaseTestList {} @Component({ template: ` @for (item of items; track item) {

{{item.name}}

{{item.description}}

}
`, standalone: true, imports: [MatListModule], }) class ListWithItemWithCssClass extends BaseTestList {} @Component({ template: ` @for (item of items; track item) {

{{item.name}}

{{item.description}}

@if (showThirdLine) {

Some other text

}
}
`, standalone: true, imports: [MatListModule], }) class ListWithDynamicNumberOfLines extends BaseTestList {} @Component({ template: ` @for (item of items; track item) { {{item.name}} } `, standalone: true, imports: [MatListModule], }) class ListWithMultipleItems extends BaseTestList {} @Component({ template: ` One Two Three `, standalone: true, imports: [MatListModule], }) class ListWithDisabledItems { firstItemDisabled = false; listDisabled = false; } @Component({ template: ``, standalone: true, imports: [MatListModule], }) class StandaloneListItem {}