-
Notifications
You must be signed in to change notification settings - Fork 6.8k
feat(aria/menu): introduce menu harness #33067
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
+408
−0
Merged
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| ## API Report File for "@angular/aria_menu_testing" | ||
|
|
||
| > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). | ||
|
|
||
| ```ts | ||
|
|
||
| import { BaseHarnessFilters } from '@angular/cdk/testing'; | ||
| import { ComponentHarness } from '@angular/cdk/testing'; | ||
| import { HarnessPredicate } from '@angular/cdk/testing'; | ||
| import { TestElement } from '@angular/cdk/testing'; | ||
|
|
||
| // @public | ||
| export class MenuHarness extends ComponentHarness { | ||
| close(): Promise<void>; | ||
| getItems(filters?: MenuItemHarnessFilters): Promise<MenuItemHarness[]>; | ||
| _getTrigger(): Promise<TestElement | null>; | ||
| // (undocumented) | ||
| static hostSelector: string; | ||
| isOpen(): Promise<boolean>; | ||
| open(): Promise<void>; | ||
| // (undocumented) | ||
| static with(options?: MenuHarnessFilters): HarnessPredicate<MenuHarness>; | ||
| } | ||
|
|
||
| // @public | ||
| export interface MenuHarnessFilters extends BaseHarnessFilters { | ||
| triggerText?: string | RegExp; | ||
| } | ||
|
|
||
| // @public | ||
| export class MenuItemHarness extends ComponentHarness { | ||
| click(): Promise<void>; | ||
| getSubmenu(): Promise<MenuHarness | null>; | ||
| getText(): Promise<string>; | ||
| // (undocumented) | ||
| static hostSelector: string; | ||
| isDisabled(): Promise<boolean>; | ||
| isExpanded(): Promise<boolean>; | ||
| // (undocumented) | ||
| static with(options?: MenuItemHarnessFilters): HarnessPredicate<MenuItemHarness>; | ||
| } | ||
|
|
||
| // @public | ||
| export interface MenuItemHarnessFilters extends BaseHarnessFilters { | ||
| disabled?: boolean; | ||
| expanded?: boolean; | ||
| text?: string | RegExp; | ||
| } | ||
|
|
||
| // (No @packageDocumentation comment for this package) | ||
|
|
||
| ``` |
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -5,6 +5,7 @@ ARIA_ENTRYPOINTS = [ | |
| "grid", | ||
| "listbox", | ||
| "menu", | ||
| "menu/testing", | ||
| "tabs", | ||
| "toolbar", | ||
| "tree", | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| load("//tools:defaults.bzl", "ng_project", "ng_web_test_suite", "ts_project") | ||
|
|
||
| package(default_visibility = ["//visibility:public"]) | ||
|
|
||
| ts_project( | ||
| name = "testing", | ||
| srcs = glob( | ||
| ["**/*.ts"], | ||
| exclude = ["**/*.spec.ts"], | ||
| ), | ||
| deps = [ | ||
| "//src/cdk/testing", | ||
| ], | ||
| ) | ||
|
|
||
| filegroup( | ||
| name = "source-files", | ||
| srcs = glob(["**/*.ts"]), | ||
| ) | ||
|
|
||
| ng_project( | ||
| name = "unit_tests_lib", | ||
| testonly = True, | ||
| srcs = glob(["**/*.spec.ts"]), | ||
| deps = [ | ||
| ":testing", | ||
| "//:node_modules/@angular/core", | ||
| "//:node_modules/@angular/platform-browser", | ||
| "//src/aria/menu", | ||
| "//src/cdk/testing", | ||
| "//src/cdk/testing/testbed", | ||
| ], | ||
| ) | ||
|
|
||
| ng_web_test_suite( | ||
| name = "unit_tests", | ||
| deps = [ | ||
| ":unit_tests_lib", | ||
| ], | ||
| ) |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| /** | ||
| * @license | ||
| * Copyright Google LLC All Rights Reserved. | ||
| * | ||
| * Use of this source code is governed by an MIT-style license that can be | ||
| * found in the LICENSE file at https://angular.dev/license | ||
| */ | ||
|
|
||
| export * from './public-api'; |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| /** | ||
| * @license | ||
| * Copyright Google LLC All Rights Reserved. | ||
| * | ||
| * Use of this source code is governed by an MIT-style license that can be | ||
| * found in the LICENSE file at https://angular.dev/license | ||
| */ | ||
|
|
||
| import {BaseHarnessFilters} from '@angular/cdk/testing'; | ||
|
|
||
| /** Filters for locating a `MenuHarness`. */ | ||
| export interface MenuHarnessFilters extends BaseHarnessFilters { | ||
| /** Only find instances whose trigger text matches the given value. */ | ||
| triggerText?: string | RegExp; | ||
| } | ||
|
|
||
| /** Filters for locating a `MenuItemHarness`. */ | ||
| export interface MenuItemHarnessFilters extends BaseHarnessFilters { | ||
| /** Only find instances whose text matches the given value. */ | ||
| text?: string | RegExp; | ||
| /** Only find instances whose disabled state matches the given value. */ | ||
| disabled?: boolean; | ||
| /** Only find instances whose expanded state matches the given value. */ | ||
| expanded?: boolean; | ||
| } |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| /** | ||
| * @license | ||
| * Copyright Google LLC All Rights Reserved. | ||
| * | ||
| * Use of this source code is governed by an MIT-style license that can be | ||
| * found in the LICENSE file at https://angular.dev/license | ||
| */ | ||
|
|
||
| import {Component} from '@angular/core'; | ||
| import {TestBed} from '@angular/core/testing'; | ||
| import {TestbedHarnessEnvironment} from '@angular/cdk/testing/testbed'; | ||
| import {Menu} from '../menu'; | ||
| import {MenuContent} from '../menu-content'; | ||
| import {MenuItem} from '../menu-item'; | ||
| import {MenuTrigger} from '../menu-trigger'; | ||
| import {MenuBar} from '../menu-bar'; | ||
| import {MenuItemHarness, MenuHarness} from './menu-harness'; | ||
|
|
||
| describe('Aria Menu Harness', () => { | ||
| let fixture: any; | ||
| let loader: any; | ||
|
|
||
| beforeEach(() => { | ||
| TestBed.configureTestingModule({ | ||
|
ok7sai marked this conversation as resolved.
Outdated
|
||
| imports: [Menu, MenuItem, MenuTrigger, MenuBar, MenuContent, MenuTestApp], | ||
| }); | ||
|
|
||
| fixture = TestBed.createComponent(MenuTestApp); | ||
| fixture.detectChanges(); | ||
| loader = TestbedHarnessEnvironment.loader(fixture); | ||
| }); | ||
|
|
||
| it('should locate the menu harness', async () => { | ||
| const menu = await loader.getHarness(MenuHarness.with({triggerText: 'Open Menu'})); | ||
| expect(menu).toBeTruthy(); | ||
| }); | ||
|
|
||
| it('should verify that the menu is initially closed', async () => { | ||
| const menu = await loader.getHarness(MenuHarness.with({triggerText: 'Open Menu'})); | ||
| expect(await menu.isOpen()).toBe(false); | ||
| }); | ||
|
|
||
| it('should open the menu', async () => { | ||
| const menu = await loader.getHarness(MenuHarness.with({triggerText: 'Open Menu'})); | ||
| await menu.open(); | ||
| fixture.detectChanges(); | ||
|
|
||
| expect(await menu.isOpen()).toBe(true); | ||
| }); | ||
|
|
||
| it('should close the menu', async () => { | ||
| const menu = await loader.getHarness(MenuHarness.with({triggerText: 'Open Menu'})); | ||
| await menu.open(); | ||
| fixture.detectChanges(); | ||
|
|
||
| await menu.close(); | ||
| fixture.detectChanges(); | ||
| expect(await menu.isOpen()).toBe(false); | ||
| }); | ||
|
|
||
| it('should get all items inside an open menu', async () => { | ||
| const menu = await loader.getHarness(MenuHarness.with({triggerText: 'Open Menu'})); | ||
| await menu.open(); | ||
| fixture.detectChanges(); | ||
|
|
||
| const items = await menu.getItems(); | ||
| expect(items.length).toBe(3); | ||
| expect(await items[0].getText()).toBe('Item 1'); | ||
| }); | ||
|
|
||
| it('should filter menu items by their disabled state', async () => { | ||
| const menu = await loader.getHarness(MenuHarness.with({triggerText: 'Open Menu'})); | ||
| await menu.open(); | ||
| fixture.detectChanges(); | ||
|
|
||
| const disabledItems = await loader.getAllHarnesses(MenuItemHarness.with({disabled: true})); | ||
| expect(disabledItems.length).toBe(1); | ||
| expect(await disabledItems[0].getText()).toBe('Item 2'); | ||
| }); | ||
|
|
||
| it('should locate and interact with nested submenus', async () => { | ||
| const main = await loader.getHarness(MenuHarness.with({triggerText: 'Open Menu'})); | ||
| await main.open(); | ||
| fixture.detectChanges(); | ||
|
|
||
| const subItem = await loader.getHarness(MenuItemHarness.with({text: 'Submenu'})); | ||
| await subItem.click(); | ||
| fixture.detectChanges(); | ||
|
|
||
| const submenu = await subItem.getSubmenu(); | ||
| expect(submenu).toBeTruthy(); | ||
| expect(await submenu!.isOpen()).toBe(true); | ||
| }); | ||
|
|
||
| it('should read items within a nested submenu', async () => { | ||
| const main = await loader.getHarness(MenuHarness.with({triggerText: 'Open Menu'})); | ||
| await main.open(); | ||
| fixture.detectChanges(); | ||
|
|
||
| const subItem = await loader.getHarness(MenuItemHarness.with({text: 'Submenu'})); | ||
| await subItem.click(); | ||
| fixture.detectChanges(); | ||
|
|
||
| const submenu = await subItem.getSubmenu(); | ||
| const subItems = await submenu!.getItems(); | ||
| expect(subItems.length).toBe(1); | ||
| expect(await subItems[0].getText()).toBe('Nested Item'); | ||
| }); | ||
|
|
||
| it('should confirm persistent horizontal menu bars are always open', async () => { | ||
| const menubar = await loader.getHarness(MenuHarness.with({selector: '[ngMenuBar]'})); | ||
| expect(menubar).toBeTruthy(); | ||
|
ok7sai marked this conversation as resolved.
Outdated
|
||
| expect(await menubar.isOpen()).toBe(true); | ||
| }); | ||
|
|
||
| it('should read items from a persistent horizontal menu bar', async () => { | ||
| const menubar = await loader.getHarness(MenuHarness.with({selector: '[ngMenuBar]'})); | ||
| const items = await menubar.getItems(); | ||
|
|
||
| expect(items.length).toBe(2); | ||
| expect(await items[0].getText()).toBe('File'); | ||
| expect(await items[1].getText()).toBe('Edit'); | ||
| }); | ||
| }); | ||
|
|
||
| @Component({ | ||
| template: ` | ||
| <button ngMenuTrigger [menu]="testMenu">Open Menu</button> | ||
|
|
||
| <div ngMenu #testMenu="ngMenu"> | ||
| <ng-template ngMenuContent> | ||
| <div ngMenuItem value="Item 1">Item 1</div> | ||
| <div ngMenuItem value="Item 2" [disabled]="true">Item 2</div> | ||
| <div ngMenuItem value="Submenu" [submenu]="nestedMenu">Submenu</div> | ||
| </ng-template> | ||
| </div> | ||
|
|
||
| <div ngMenu #nestedMenu="ngMenu"> | ||
| <ng-template ngMenuContent> | ||
| <div ngMenuItem value="Nested Item">Nested Item</div> | ||
| </ng-template> | ||
| </div> | ||
|
|
||
| <div ngMenuBar> | ||
| <div ngMenuItem value="File">File</div> | ||
| <div ngMenuItem value="Edit">Edit</div> | ||
| </div> | ||
| `, | ||
| imports: [Menu, MenuItem, MenuTrigger, MenuBar, MenuContent], | ||
| }) | ||
| class MenuTestApp {} | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.