@ni/nimble-components 31.1.1 → 31.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/all-components-bundle.js +1 -1
- package/dist/all-components-bundle.js.map +1 -1
- package/dist/all-components-bundle.min.js.map +1 -1
- package/dist/esm/combobox/testing/combobox.pageobject.js +3 -3
- package/dist/esm/combobox/testing/combobox.pageobject.js.map +1 -1
- package/dist/esm/menu-button/testing/menu-button.pageobject.js +2 -2
- package/dist/esm/menu-button/testing/menu-button.pageobject.js.map +1 -1
- package/dist/esm/utilities/testing/component.d.ts +1 -10
- package/dist/esm/utilities/testing/component.js +7 -23
- package/dist/esm/utilities/testing/component.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { keyEnter, keyArrowDown, keyArrowUp } from '@microsoft/fast-web-utilities';
|
|
2
2
|
import { listOptionTag } from '../../list-option';
|
|
3
3
|
import { waitForUpdatesAsync } from '../../testing/async-helpers';
|
|
4
|
-
import {
|
|
4
|
+
import { waitForEvent, waitAnimationFrame } from '../../utilities/testing/component';
|
|
5
5
|
/**
|
|
6
6
|
* Page object for the `nimble-combobox` component to provide consistent ways
|
|
7
7
|
* of querying and interacting with the component during tests.
|
|
@@ -9,7 +9,7 @@ import { createEventListener, waitAnimationFrame } from '../../utilities/testing
|
|
|
9
9
|
export class ComboboxPageObject {
|
|
10
10
|
constructor(comboboxElement) {
|
|
11
11
|
this.comboboxElement = comboboxElement;
|
|
12
|
-
this.regionLoadedListener =
|
|
12
|
+
this.regionLoadedListener = waitForEvent(this.comboboxElement, 'loaded');
|
|
13
13
|
}
|
|
14
14
|
/**
|
|
15
15
|
* Gets the selectable options in the drop-down. Does not include options that are disabled or filtered out.
|
|
@@ -166,7 +166,7 @@ export class ComboboxPageObject {
|
|
|
166
166
|
return (this.comboboxElement.shadowRoot?.querySelector('.no-results-label') !== null);
|
|
167
167
|
}
|
|
168
168
|
async waitForAnchoredRegionLoaded() {
|
|
169
|
-
await this.regionLoadedListener
|
|
169
|
+
await this.regionLoadedListener;
|
|
170
170
|
}
|
|
171
171
|
}
|
|
172
172
|
//# sourceMappingURL=combobox.pageobject.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"combobox.pageobject.js","sourceRoot":"","sources":["../../../../src/combobox/testing/combobox.pageobject.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EACR,YAAY,EACZ,UAAU,EACb,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EACH,
|
|
1
|
+
{"version":3,"file":"combobox.pageobject.js","sourceRoot":"","sources":["../../../../src/combobox/testing/combobox.pageobject.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EACR,YAAY,EACZ,UAAU,EACb,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EACH,YAAY,EACZ,kBAAkB,EACrB,MAAM,mCAAmC,CAAC;AAE3C;;;GAGG;AACH,MAAM,OAAO,kBAAkB;IAM3B,YAAsC,eAAyB;QAAzB,oBAAe,GAAf,eAAe,CAAU;QAL9C,yBAAoB,GAAG,YAAY,CAChD,IAAI,CAAC,eAAe,EACpB,QAAQ,CACX,CAAC;IAEgE,CAAC;IAEnE;;OAEG;IACI,kBAAkB;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,WAAW,CAAC,IAAY;QACjC,MAAM,IAAI,CAAC,2BAA2B,EAAE,CAAC;QACzC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACxB,IAAI,CAAC,aAAa,EAAE,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,IAAY,EAAE,QAAQ,GAAG,KAAK;QAC9C,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;QAC1C,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,OAAO,EAAE;YACvC,IAAI,EAAE,IAAI;YACV,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,YAAY;SAC9D,CAAC,CAAC;QACH,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACI,aAAa;QAChB,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,mBAAmB;QAC5B,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,MAAM,IAAI,CAAC,2BAA2B,EAAE,CAAC;QACzC,MAAM,mBAAmB,EAAE,CAAC;QAC5B,MAAM,kBAAkB,EAAE,CAAC,CAAC,mEAAmE;IACnG,CAAC;IAED;;;;OAIG;IACI,mBAAmB;QACtB,IAAI,CAAC,eAAe,CAAC,cAAe,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,iCAAiC;QAC1C,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,MAAM,IAAI,CAAC,2BAA2B,EAAE,CAAC;QACzC,MAAM,kBAAkB,EAAE,CAAC,CAAC,mEAAmE;IACnG,CAAC;IAED;;OAEG;IACI,uBAAuB;QAC1B,OAAO,IAAI,CAAC,eAAe,CAAC,cAAe,CAAC,OAAO,CAAC;IACxD,CAAC;IAED;;OAEG;IACI,wBAAwB;QAC3B,OAAO,IAAI,CAAC,eAAe,CAAC,cAAe,CAAC,QAAQ,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,UAAU;QACb,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,aAAa;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,iBAAiB;QACpB,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc;QACvB,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;QACxE,MAAM,mBAAmB,EAAE,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,aAAa;QACtB,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;QACvE,MAAM,mBAAmB,EAAE,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,aAAa,CAAC,KAAa,EAAE,KAAa;QACnD,IAAI,CAAC,eAAe,CAAC,kBAAkB,CACnC,YAAY,EACZ,IAAI,aAAa,WAAW,KAAK,KAAK,KAAK,KAAK,aAAa,GAAG,CACnE,CAAC;QACF,MAAM,mBAAmB,EAAE,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS;QAClB,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;QAC1D,MAAM,mBAAmB,EAAE,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,aAAa;QAChB,IAAI,CAAC,eAAe,CAAC,aAAa,CAC9B,IAAI,aAAa,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAClD,CAAC;IACN,CAAC;IAED;;OAEG;IACI,iBAAiB;QACpB,IAAI,CAAC,eAAe,CAAC,aAAa,CAC9B,IAAI,aAAa,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC,CACtD,CAAC;IACN,CAAC;IAED;;OAEG;IACI,eAAe;QAClB,IAAI,CAAC,eAAe,CAAC,aAAa,CAC9B,IAAI,aAAa,CAAC,SAAS,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CACpD,CAAC;IACN,CAAC;IAED;;OAEG;IACI,cAAc;QACjB,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YACrC,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,eAAe,CAAC,aAAa,EAAE,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,uBAAuB;QAC1B,OAAO,CACH,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,aAAa,CAC1C,mBAAmB,CACtB,KAAK,IAAI,CACb,CAAC;IACN,CAAC;IAEO,KAAK,CAAC,2BAA2B;QACrC,MAAM,IAAI,CAAC,oBAAoB,CAAC;IACpC,CAAC;CACJ","sourcesContent":["import {\n keyEnter,\n keyArrowDown,\n keyArrowUp\n} from '@microsoft/fast-web-utilities';\nimport type { Combobox } from '..';\nimport { listOptionTag } from '../../list-option';\nimport { waitForUpdatesAsync } from '../../testing/async-helpers';\nimport {\n waitForEvent,\n waitAnimationFrame\n} from '../../utilities/testing/component';\n\n/**\n * Page object for the `nimble-combobox` component to provide consistent ways\n * of querying and interacting with the component during tests.\n */\nexport class ComboboxPageObject {\n private readonly regionLoadedListener = waitForEvent(\n this.comboboxElement,\n 'loaded'\n );\n\n public constructor(protected readonly comboboxElement: Combobox) {}\n\n /**\n * Gets the selectable options in the drop-down. Does not include options that are disabled or filtered out.\n */\n public getFilteredOptions(): string[] {\n return this.comboboxElement.filteredOptions.map(x => x.text);\n }\n\n /**\n * Sets the input text and commits the value by pressing Enter. Will emit a 'change' event.\n */\n public async commitValue(text: string): Promise<void> {\n await this.waitForAnchoredRegionLoaded();\n this.setInputText(text);\n this.pressEnterKey();\n }\n\n /**\n * @internal\n *\n * The Selection API currently isn't supported properly or consistently in shadow DOM,\n * so unfortunately our delete API has to be passed the post-deletion text.\n */\n public setInputText(text: string, asDelete = false): void {\n this.comboboxElement.control.value = text;\n const inputEvent = new InputEvent('input', {\n data: text,\n inputType: asDelete ? 'deleteContentForward' : 'insertText'\n });\n this.comboboxElement.control.dispatchEvent(inputEvent);\n }\n\n /**\n * @internal\n *\n * Either opens or closes the dropdown depending on its current state\n */\n public clickCombobox(): void {\n this.comboboxElement.click();\n }\n\n /**\n * @internal\n */\n public async clickAndWaitForOpen(): Promise<void> {\n this.clickCombobox();\n await this.waitForAnchoredRegionLoaded();\n await waitForUpdatesAsync();\n await waitAnimationFrame(); // necessary because scrolling is queued with requestAnimationFrame\n }\n\n /**\n * @internal\n *\n * Either opens or closes the dropdown depending on its current state\n */\n public clickDropdownButton(): void {\n this.comboboxElement.dropdownButton!.control.click();\n }\n\n /**\n * @internal\n */\n public async clickDropdownButtonAndWaitForOpen(): Promise<void> {\n this.clickDropdownButton();\n await this.waitForAnchoredRegionLoaded();\n await waitAnimationFrame(); // necessary because scrolling is queued with requestAnimationFrame\n }\n\n /**\n * @internal\n */\n public isDropdownButtonChecked(): boolean {\n return this.comboboxElement.dropdownButton!.checked;\n }\n\n /**\n * @internal\n */\n public isDropdownButtonDisabled(): boolean {\n return this.comboboxElement.dropdownButton!.disabled;\n }\n\n /**\n * @internal\n *\n * Either opens or closes the dropdown depending on its current state\n */\n public clickInput(): void {\n this.comboboxElement.control.click();\n }\n\n /**\n * @internal\n */\n public getInputTitle(): string | null {\n return this.comboboxElement.control.getAttribute('title');\n }\n\n /**\n * @internal\n */\n public getInputAriaLabel(): string | null {\n return this.comboboxElement.control.getAttribute('aria-label');\n }\n\n /**\n * @internal\n */\n public async mouseoverInput(): Promise<void> {\n this.comboboxElement.control.dispatchEvent(new MouseEvent('mouseover'));\n await waitForUpdatesAsync();\n }\n\n /**\n * @internal\n */\n public async mouseoutInput(): Promise<void> {\n this.comboboxElement.control.dispatchEvent(new MouseEvent('mouseout'));\n await waitForUpdatesAsync();\n }\n\n /**\n * @internal\n */\n public async prependOption(value: string, label: string): Promise<void> {\n this.comboboxElement.insertAdjacentHTML(\n 'afterbegin',\n `<${listOptionTag} value=\"${value}\">${label}</${listOptionTag}>`\n );\n await waitForUpdatesAsync();\n }\n\n /**\n * @internal\n */\n public async clickAway(): Promise<void> {\n this.comboboxElement.dispatchEvent(new Event('focusout'));\n await waitForUpdatesAsync();\n }\n\n /**\n * @internal\n */\n public pressEnterKey(): void {\n this.comboboxElement.dispatchEvent(\n new KeyboardEvent('keydown', { key: keyEnter })\n );\n }\n\n /**\n * @internal\n */\n public pressArrowDownKey(): void {\n this.comboboxElement.dispatchEvent(\n new KeyboardEvent('keydown', { key: keyArrowDown })\n );\n }\n\n /**\n * @internal\n */\n public pressArrowUpKey(): void {\n this.comboboxElement.dispatchEvent(\n new KeyboardEvent('keydown', { key: keyArrowUp })\n );\n }\n\n /**\n * @internal\n */\n public hideAllOptions(): void {\n this.comboboxElement.options.forEach(o => {\n o.hidden = true;\n });\n this.comboboxElement.filterOptions();\n }\n\n /**\n * @internal\n */\n public isNoResultsLabelVisible(): boolean {\n return (\n this.comboboxElement.shadowRoot?.querySelector(\n '.no-results-label'\n ) !== null\n );\n }\n\n private async waitForAnchoredRegionLoaded(): Promise<void> {\n await this.regionLoadedListener;\n }\n}\n"]}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { keyArrowDown, keyArrowUp, keyEnter, keyEscape, keySpace } from '@microsoft/fast-web-utilities';
|
|
2
|
-
import {
|
|
2
|
+
import { waitForEvent } from '../../utilities/testing/component';
|
|
3
3
|
/**
|
|
4
4
|
* Page object for `nimble-menu-button` component to provide consistent ways
|
|
5
5
|
* of querying and interacting with the component during tests.
|
|
@@ -25,7 +25,7 @@ export class MenuButtonPageObject {
|
|
|
25
25
|
if (this.isOpen()) {
|
|
26
26
|
return;
|
|
27
27
|
}
|
|
28
|
-
const toggleEventPromise =
|
|
28
|
+
const toggleEventPromise = waitForEvent(this.menuButtonElement, 'toggle');
|
|
29
29
|
this.clickMenuButton();
|
|
30
30
|
await toggleEventPromise;
|
|
31
31
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"menu-button.pageobject.js","sourceRoot":"","sources":["../../../../src/menu-button/testing/menu-button.pageobject.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,SAAS,EACT,QAAQ,EACX,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"menu-button.pageobject.js","sourceRoot":"","sources":["../../../../src/menu-button/testing/menu-button.pageobject.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,SAAS,EACT,QAAQ,EACX,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAEjE;;;;;;GAMG;AACH,MAAM,OAAO,oBAAoB;IAC7B,YAAsC,iBAA6B;QAA7B,sBAAiB,GAAjB,iBAAiB,CAAY;IAAG,CAAC;IAEvE;;OAEG;IACI,MAAM;QACT,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ;QACjB,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YAChB,OAAO;QACX,CAAC;QAED,MAAM,kBAAkB,GAAG,YAAY,CACnC,IAAI,CAAC,iBAAiB,EACtB,QAAQ,CACX,CAAC;QACF,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,MAAM,kBAAkB,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,mBAAmB;QACtB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC7D,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE;YACvC,GAAG,EAAE,SAAS;SACjB,CAAC,CAAC;QACH,IAAI,CAAC,iBAAiB,CAAC,MAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,YAAY;QACf,OAAO,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC5D,CAAC;IAED;;OAEG;IACI,SAAS;QACZ,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,aAAa,KAAK,IAAI,CAAC;IACrE,CAAC;IAED;;;OAGG;IACI,eAAe;QAClB,gFAAgF;QAChF,0EAA0E;QAC1E,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,CAAC,iBAAiB,CAAC,YAAa,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,aAAa;QAChB,gHAAgH;QAChH,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,UAAU,EAAE;YACxC,GAAG,EAAE,QAAQ;SAChB,CAAC,CAAC;QACH,IAAI,CAAC,iBAAiB,CAAC,YAAa,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACI,aAAa;QAChB,gHAAgH;QAChH,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,UAAU,EAAE;YACxC,GAAG,EAAE,QAAQ;SAChB,CAAC,CAAC;QACH,IAAI,CAAC,iBAAiB,CAAC,YAAa,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACI,eAAe;QAClB,gHAAgH;QAChH,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE;YACvC,GAAG,EAAE,UAAU;SAClB,CAAC,CAAC;QACH,IAAI,CAAC,iBAAiB,CAAC,YAAa,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,iBAAiB;QACpB,gHAAgH;QAChH,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE;YACvC,GAAG,EAAE,YAAY;SACpB,CAAC,CAAC;QACH,IAAI,CAAC,iBAAiB,CAAC,YAAa,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,QAAQ;QACX,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,KAAY;QAC7B,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;CACJ","sourcesContent":["import {\n keyArrowDown,\n keyArrowUp,\n keyEnter,\n keyEscape,\n keySpace\n} from '@microsoft/fast-web-utilities';\nimport type { MenuButton } from '..';\nimport { waitForEvent } from '../../utilities/testing/component';\n\n/**\n * Page object for `nimble-menu-button` component to provide consistent ways\n * of querying and interacting with the component during tests.\n *\n * This page object is intended to be used to interact with a `nimble-menu-button`,\n * not the menu slotted into the button or the menu items.\n */\nexport class MenuButtonPageObject {\n public constructor(protected readonly menuButtonElement: MenuButton) {}\n\n /**\n * @returns Whether or not the menu is open.\n */\n public isOpen(): boolean {\n return this.menuButtonElement.open;\n }\n\n /**\n * Opens the menu.\n * @returns A promise that resolves when the menu opens.\n */\n public async openMenu(): Promise<void> {\n if (this.isOpen()) {\n return;\n }\n\n const toggleEventPromise = waitForEvent(\n this.menuButtonElement,\n 'toggle'\n );\n this.clickMenuButton();\n await toggleEventPromise;\n }\n\n /**\n * Closes the menu by pressing Escape.\n * Throws an error if the menu is not open.\n */\n public closeMenuWithEscape(): void {\n if (!this.isOpen()) {\n throw new Error('Cannot close menu when it is not open');\n }\n\n const event = new KeyboardEvent('keydown', {\n key: keyEscape\n });\n this.menuButtonElement.region!.dispatchEvent(event);\n }\n\n /**\n * Gets the text in the menu button.\n * @returns The trimmed text that is slotted into the menu button.\n */\n public getLabelText(): string {\n return this.menuButtonElement.textContent?.trim() ?? '';\n }\n\n /**\n * @returns Whether or not the menu button is focused.\n */\n public isFocused(): boolean {\n return this.menuButtonElement.shadowRoot?.activeElement !== null;\n }\n\n /**\n * @internal\n * Focuses and clicks the menu button.\n */\n public clickMenuButton(): void {\n // Focus the menu button before calling click() because ordinarily a mouse click\n // would bring focus to the button, but calling click() directly does not.\n this.menuButtonElement.focus();\n this.menuButtonElement.toggleButton!.control.click();\n }\n\n /**\n * @internal\n * Presses the Enter key on the menu button.\n */\n public pressEnterKey(): void {\n // Focus the menu button before dispatching the event because a key event only makes sense on a focused element.\n this.menuButtonElement.focus();\n const event = new KeyboardEvent('keypress', {\n key: keyEnter\n });\n this.menuButtonElement.toggleButton!.control.dispatchEvent(event);\n }\n\n /**\n * @internal\n * Presses the Space key on the menu button.\n */\n public pressSpaceKey(): void {\n // Focus the menu button before dispatching the event because a key event only makes sense on a focused element.\n this.menuButtonElement.focus();\n const event = new KeyboardEvent('keypress', {\n key: keySpace\n });\n this.menuButtonElement.toggleButton!.control.dispatchEvent(event);\n }\n\n /**\n * @internal\n * Presses the Arrow Up key on the menu button.\n */\n public pressArrowUpKey(): void {\n // Focus the menu button before dispatching the event because a key event only makes sense on a focused element.\n this.menuButtonElement.focus();\n const event = new KeyboardEvent('keydown', {\n key: keyArrowUp\n });\n this.menuButtonElement.toggleButton!.dispatchEvent(event);\n }\n\n /**\n * @internal\n * Presses the Arrow Down key on the menu button.\n */\n public pressArrowDownKey(): void {\n // Focus the menu button before dispatching the event because a key event only makes sense on a focused element.\n this.menuButtonElement.focus();\n const event = new KeyboardEvent('keydown', {\n key: keyArrowDown\n });\n this.menuButtonElement.toggleButton!.dispatchEvent(event);\n }\n\n /**\n * @internal\n */\n public getTitle(): string {\n return this.menuButtonElement.title;\n }\n\n /**\n * @internal\n */\n public dispatchEvent(event: Event): void {\n this.menuButtonElement.dispatchEvent(event);\n }\n}\n"]}
|
|
@@ -1,19 +1,10 @@
|
|
|
1
|
-
/// <reference types="jasmine" />
|
|
2
1
|
export declare function clickElement(element: HTMLElement): Promise<void>;
|
|
3
2
|
export declare function sendKeyDownEvent(target: HTMLElement, key: string, init?: KeyboardEventInit): Promise<KeyboardEvent>;
|
|
4
3
|
export declare function sendKeyDownEvents(target: HTMLElement, keySequence: string[], init?: KeyboardEventInit[]): Promise<KeyboardEvent[]>;
|
|
5
4
|
/** A helper function to abstract turning waiting for an event to fire into a promise.
|
|
6
5
|
* The returned promise should be resolved prior to completing a test.
|
|
7
6
|
*/
|
|
8
|
-
export declare function
|
|
9
|
-
/** A helper function to abstract adding an event listener, spying
|
|
10
|
-
* on the event being called, and removing the event listener. The returned promise
|
|
11
|
-
* should be resolved prior to completing a test.
|
|
12
|
-
*/
|
|
13
|
-
export declare function createEventListener(element: HTMLElement, eventName: string): {
|
|
14
|
-
promise: Promise<void>;
|
|
15
|
-
spy: jasmine.Spy;
|
|
16
|
-
};
|
|
7
|
+
export declare function waitForEvent<T extends Event>(element: HTMLElement, eventName: string, callback?: (evt: T) => void): Promise<void>;
|
|
17
8
|
/**
|
|
18
9
|
* Waits for a requested animation frame to occur.
|
|
19
10
|
*/
|
|
@@ -30,33 +30,17 @@ export async function sendKeyDownEvents(target, keySequence, init) {
|
|
|
30
30
|
/** A helper function to abstract turning waiting for an event to fire into a promise.
|
|
31
31
|
* The returned promise should be resolved prior to completing a test.
|
|
32
32
|
*/
|
|
33
|
-
export async function
|
|
33
|
+
export async function waitForEvent(element, eventName, callback) {
|
|
34
34
|
return new Promise(resolve => {
|
|
35
|
-
const handler = () => {
|
|
36
|
-
|
|
35
|
+
const handler = ((evt) => {
|
|
36
|
+
callback?.(evt);
|
|
37
37
|
resolve();
|
|
38
|
-
};
|
|
39
|
-
element.addEventListener(eventName, handler
|
|
38
|
+
});
|
|
39
|
+
element.addEventListener(eventName, handler, {
|
|
40
|
+
once: true
|
|
41
|
+
});
|
|
40
42
|
});
|
|
41
43
|
}
|
|
42
|
-
/** A helper function to abstract adding an event listener, spying
|
|
43
|
-
* on the event being called, and removing the event listener. The returned promise
|
|
44
|
-
* should be resolved prior to completing a test.
|
|
45
|
-
*/
|
|
46
|
-
export function createEventListener(element, eventName) {
|
|
47
|
-
const spy = jasmine.createSpy();
|
|
48
|
-
return {
|
|
49
|
-
promise: new Promise(resolve => {
|
|
50
|
-
const handler = (...args) => {
|
|
51
|
-
element.removeEventListener(eventName, handler);
|
|
52
|
-
spy(...args);
|
|
53
|
-
resolve();
|
|
54
|
-
};
|
|
55
|
-
element.addEventListener(eventName, handler);
|
|
56
|
-
}),
|
|
57
|
-
spy
|
|
58
|
-
};
|
|
59
|
-
}
|
|
60
44
|
/**
|
|
61
45
|
* Waits for a requested animation frame to occur.
|
|
62
46
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"component.js","sourceRoot":"","sources":["../../../../src/utilities/testing/component.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAoB;IACnD,OAAO,CAAC,KAAK,EAAE,CAAC;IAChB,MAAM,mBAAmB,EAAE,CAAC;AAChC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAClC,MAAmB,EACnB,GAAW,EACX,IAAwB;IAExB,OAAO,CACH,MAAM,iBAAiB,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CACpE,CAAC,CAAC,CAAE,CAAC;AACV,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACnC,MAAmB,EACnB,WAAqB,EACrB,IAA0B;IAE1B,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,MAAM,EAAE,CAAC;QAC7C,MAAM,IAAI,KAAK,CACX,+DAA+D,CAClE,CAAC;IACN,CAAC;IACD,MAAM,MAAM,GAAoB,EAAE,CAAC;IACnC,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC;QAC/C,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE;YACvC,GAAG;YACH,UAAU,EAAE,IAAI;YAChB,OAAO,EAAE,IAAI;YACb,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC;SACnB,CAAC,CAAC;QACH,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC5B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IACD,MAAM,mBAAmB,EAAE,CAAC;IAC5B,OAAO,MAAM,CAAC;AAClB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,
|
|
1
|
+
{"version":3,"file":"component.js","sourceRoot":"","sources":["../../../../src/utilities/testing/component.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAoB;IACnD,OAAO,CAAC,KAAK,EAAE,CAAC;IAChB,MAAM,mBAAmB,EAAE,CAAC;AAChC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAClC,MAAmB,EACnB,GAAW,EACX,IAAwB;IAExB,OAAO,CACH,MAAM,iBAAiB,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CACpE,CAAC,CAAC,CAAE,CAAC;AACV,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACnC,MAAmB,EACnB,WAAqB,EACrB,IAA0B;IAE1B,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,MAAM,EAAE,CAAC;QAC7C,MAAM,IAAI,KAAK,CACX,+DAA+D,CAClE,CAAC;IACN,CAAC;IACD,MAAM,MAAM,GAAoB,EAAE,CAAC;IACnC,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC;QAC/C,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,SAAS,EAAE;YACvC,GAAG;YACH,UAAU,EAAE,IAAI;YAChB,OAAO,EAAE,IAAI;YACb,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC;SACnB,CAAC,CAAC;QACH,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC5B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IACD,MAAM,mBAAmB,EAAE,CAAC;IAC5B,OAAO,MAAM,CAAC;AAClB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAC9B,OAAoB,EACpB,SAAiB,EACjB,QAA2B;IAE3B,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;QACzB,MAAM,OAAO,GAAG,CAAC,CAAC,GAAM,EAAQ,EAAE;YAC9B,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC;YAChB,OAAO,EAAE,CAAC;QACd,CAAC,CAAkB,CAAC;QACpB,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,OAAO,EAAE;YACzC,IAAI,EAAE,IAAI;SACb,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB;IACpC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;QACzB,qBAAqB,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACP,CAAC","sourcesContent":["import { waitForUpdatesAsync } from '../../testing/async-helpers';\n\nexport async function clickElement(element: HTMLElement): Promise<void> {\n element.click();\n await waitForUpdatesAsync();\n}\n\nexport async function sendKeyDownEvent(\n target: HTMLElement,\n key: string,\n init?: KeyboardEventInit\n): Promise<KeyboardEvent> {\n return (\n await sendKeyDownEvents(target, [key], init ? [init] : undefined)\n )[0]!;\n}\n\nexport async function sendKeyDownEvents(\n target: HTMLElement,\n keySequence: string[],\n init?: KeyboardEventInit[]\n): Promise<KeyboardEvent[]> {\n if (keySequence.length === 0) {\n throw new Error('The key sequence must have at least one key.');\n }\n if (init && init.length !== keySequence.length) {\n throw new Error(\n 'The length of the key sequence and the init array must match.'\n );\n }\n const events: KeyboardEvent[] = [];\n for (const [index, key] of keySequence.entries()) {\n const event = new KeyboardEvent('keydown', {\n key,\n cancelable: true,\n bubbles: true,\n ...init?.[index]\n });\n target.dispatchEvent(event);\n events.push(event);\n }\n await waitForUpdatesAsync();\n return events;\n}\n\n/** A helper function to abstract turning waiting for an event to fire into a promise.\n * The returned promise should be resolved prior to completing a test.\n */\nexport async function waitForEvent<T extends Event>(\n element: HTMLElement,\n eventName: string,\n callback?: (evt: T) => void\n): Promise<void> {\n return new Promise(resolve => {\n const handler = ((evt: T): void => {\n callback?.(evt);\n resolve();\n }) as EventListener;\n element.addEventListener(eventName, handler, {\n once: true\n });\n });\n}\n\n/**\n * Waits for a requested animation frame to occur.\n */\nexport async function waitAnimationFrame(): Promise<void> {\n return new Promise(resolve => {\n requestAnimationFrame(() => resolve());\n });\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ni/nimble-components",
|
|
3
|
-
"version": "31.1.
|
|
3
|
+
"version": "31.1.2",
|
|
4
4
|
"description": "Styled web components for the NI Nimble Design System",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "npm run generate-icons && npm run generate-workers && npm run build-components && npm run bundle-components && npm run generate-scss",
|