@loadsmart/miranda-wc 1.48.1 → 1.49.0

package/dist/controllers/focus-manager/focus-manager.controller.d.ts

@@ -0,0 +1,89 @@
+import type { ReactiveControllerHost, ReactiveController } from 'lit';
+export declare const SEARCH_BUFFER_TIMEOUT = 500;
+export type FocusManagerControllerHost = ReactiveControllerHost & HTMLElement;
+export type FocusManagerControllerOptions = {
+    query: string | string[];
+    focusOnType?: boolean;
+    getInteractiveElement?: (host: FocusManagerControllerHost) => HTMLElement;
+};
+export type PositionalFocus = 'first' | 'last' | 'previous' | 'next';
+/**
+ * Check if `keyboardEventKey` is a character, and more specifically, anything
+ * other than a space, tab, or newline.
+ */
+export declare function isPrintableCharacter(keyboardEventKey: string): boolean;
+/**
+ * Manages **virtual/visual** focus, for a11y purposes.
+ */
+export declare class FocusManagerController implements ReactiveController {
+    #private;
+    host: FocusManagerControllerHost;
+    activeDescendant: string | null;
+    /**
+     * Keys (printable characters) the user typed on the watched host.
+     * The expectation is that the user wants to focus/select something.
+     */
+    quickSearchBuffer: string;
+    /**
+     * Timeout to clear the buffer.
+     */
+    quickSearchBufferTimeout?: number | null;
+    /**
+     * Query to get virtually focusable elements inside the `host`.
+     */
+    query: string;
+    /**
+     * When user types printable characters, should the focus move to the next `queried` item whose label
+     * starts with `quickSearchBuffer`, if such an item exists (otherwise, focus does not move)?
+     */
+    focusOnType: boolean;
+    /**
+     * Get the element that will receive the `aria-activedescendant` attribute. This is necessary when the
+     * host element is not the one directly hosting the focusable elements.
+     * If no override is provided, the `host` element itself is used.
+     *
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-activedescendant MDN, aria-activedescendant}
+     */
+    getInteractiveElement: (host: FocusManagerControllerHost) => HTMLElement;
+    constructor(host: FocusManagerControllerHost, options: FocusManagerControllerOptions);
+    hostConnected(): void;
+    hostDisconnected(): void;
+    /**
+     * Get the list of elements matching the given `options.query`.
+     */
+    get queried(): HTMLElement[];
+    /**
+     * Get the currently focused element, based on `activeDescendant`.
+     */
+    get focused(): HTMLElement | null;
+    /**
+     * If none of the options are selected, the first option receives focus; otherwise, the
+     * focus moves to the next option.
+     * If we are at the end of the `queried` array, the focus moves to the first option.
+     */
+    focusNext(): void;
+    /**
+     * If none of the options are selected, the last option receives focus; otherwise, the
+     * focus moves to the next option.
+     * If we are at the start of the `queried` array, the focus moves to the last option.
+     */
+    focusPrevious(): void;
+    /**
+     * Focus the first element in `queried`.
+     */
+    focusFirst(): void;
+    /**
+     * Focus the last element in `queried`.
+     */
+    focusLast(): void;
+    /**
+     * Focus the given element or the element at the given index or position, based on `queried`.
+     */
+    focus(where: number | HTMLElement | PositionalFocus): void;
+    /**
+     * Remove the visual focus (`.is-focused` class) from the currently focused element and
+     * clear the `activeDescendant` attribute.
+     */
+    clear(): void;
+}
+//# sourceMappingURL=focus-manager.controller.d.ts.map

package/dist/controllers/focus-manager/focus-manager.controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"focus-manager.controller.d.ts","sourceRoot":"","sources":["../../../src/controllers/focus-manager/focus-manager.controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,KAAK,CAAC;AAGtE,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC,MAAM,MAAM,0BAA0B,GAAG,sBAAsB,GAAG,WAAW,CAAC;AAE9E,MAAM,MAAM,6BAA6B,GAAG;IAC3C,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,qBAAqB,CAAC,EAAE,CAAC,IAAI,EAAE,0BAA0B,KAAK,WAAW,CAAC;CAC1E,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;AAWrE;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAOtE;AAED;;GAEG;AACH,qBAAa,sBAAuB,YAAW,kBAAkB;;IAChE,IAAI,EAAE,0BAA0B,CAAC;IAEjC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAQ;IAEvC;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;;;;OAMG;IACH,qBAAqB,EAAE,CAAC,IAAI,EAAE,0BAA0B,KAAK,WAAW,CAAC;gBAGxE,IAAI,EAAE,0BAA0B,EAChC,OAAO,EAAE,6BAA6B;IAevC,aAAa;IAWb,gBAAgB;IAIhB;;OAEG;IACH,IAAI,OAAO,IAAI,WAAW,EAAE,CAE3B;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,WAAW,GAAG,IAAI,CAMhC;IAED;;;;OAIG;IACH,SAAS;IAIT;;;;OAIG;IACH,aAAa;IAIb;;OAEG;IACH,UAAU;IAIV;;OAEG;IACH,SAAS;IAIT;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,GAAG,eAAe;IAUnD;;;OAGG;IACH,KAAK;CAyKL"}

package/dist/controllers/focus-manager/index.d.ts

@@ -0,0 +1,3 @@
+export { FocusManagerController } from './focus-manager.controller';
+export type { PositionalFocus, FocusManagerControllerHost, FocusManagerControllerOptions, } from './focus-manager.controller';
+//# sourceMappingURL=index.d.ts.map

package/dist/controllers/focus-manager/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/controllers/focus-manager/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AACpE,YAAY,EACX,eAAe,EACf,0BAA0B,EAC1B,6BAA6B,GAC7B,MAAM,4BAA4B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@loadsmart/miranda-wc",
-	"version": "1.48.1",
+	"version": "1.49.0",
 	"description": "Miranda Web Components component library",
 	"main": "dist/index.js",
 	"type": "module",