@meshmakers/shared-ui 3.4.1480 → 3.5.0

package/types/meshmakers-shared-ui-testing.d.ts

@@ -0,0 +1,41 @@
+import { ComponentFixture } from '@angular/core/testing';
+
+/** Options of {@link expectIconButtonsAccessible} / {@link findInaccessibleIconButtons}. */
+interface IconButtonA11yOptions {
+    /**
+     * Also require a tooltip (`title`) next to the accessible name — the Studio action guideline
+     * (§2.2) wants both: tooltip = label for sighted users, `aria-label` = label + target. Default `true`.
+     */
+    requireTooltip?: boolean;
+    /** CSS selector of elements to skip (e.g. third-party widgets the spec does not own). */
+    ignore?: string;
+    /**
+     * Also check Kendo's widget-internal buttons (dropdown arrows, spinners, pager selects — named by
+     * Kendo with `aria-label` only, not in the host's hands). Default `false`.
+     */
+    includeKendoInternals?: boolean;
+}
+type Root = ComponentFixture<unknown> | Element | Document;
+/**
+ * Icon-only buttons (an icon, no visible text) that miss an accessible name (`aria-label` /
+ * `aria-labelledby`) or — unless `requireTooltip: false` — a tooltip (`title`). Returns one
+ * message per offending button.
+ */
+declare function findInaccessibleIconButtons(root: Root, options?: IconButtonA11yOptions): string[];
+/**
+ * Fails (throws) when the rendered fixture / element contains an icon-only button without an
+ * accessible name and a tooltip (Studio action guideline §2.2, AB#5581). Runs `detectChanges()`
+ * on a fixture first.
+ *
+ * ```ts
+ * import { expectIconButtonsAccessible } from '@meshmakers/shared-ui/testing';
+ *
+ * it('names every icon-only button', () => {
+ *   expectIconButtonsAccessible(fixture);
+ * });
+ * ```
+ */
+declare function expectIconButtonsAccessible(root: Root, options?: IconButtonA11yOptions): void;
+
+export { expectIconButtonsAccessible, findInaccessibleIconButtons };
+export type { IconButtonA11yOptions };