Skip to content
Open
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
52 changes: 52 additions & 0 deletions goldens/aria/menu/testing/index.api.md
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)

```
1 change: 1 addition & 0 deletions src/aria/config.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ ARIA_ENTRYPOINTS = [
"grid",
"listbox",
"menu",
"menu/testing",
"tabs",
"toolbar",
"tree",
Expand Down
40 changes: 40 additions & 0 deletions src/aria/menu/testing/BUILD.bazel
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",
],
)
9 changes: 9 additions & 0 deletions src/aria/menu/testing/index.ts
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';
25 changes: 25 additions & 0 deletions src/aria/menu/testing/menu-harness-filters.ts
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;
}
147 changes: 147 additions & 0 deletions src/aria/menu/testing/menu-harness.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
/**
* @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 {ComponentFixture, TestBed} from '@angular/core/testing';
import {HarnessLoader} from '@angular/cdk/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: ComponentFixture<MenuTestApp>;
let loader: HarnessLoader;

beforeEach(() => {
fixture = TestBed.createComponent(MenuTestApp);
fixture.detectChanges();
loader = TestbedHarnessEnvironment.loader(fixture);
});

it('should locate the menu harness', async () => {
await expectAsync(
loader.getHarness(MenuHarness.with({triggerText: 'Open Menu'})),
).toBeResolved();
});

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(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(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 {}
Loading
Loading