@touchcastllc/napster-companion-api-dev 2.0.0-alpha.5 → 2.0.0-alpha.7

package/lib/components/Avatar/controlsAutoHide.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Auto-hide for the control bar: it fades out a few seconds after the pointer
+ * leaves and returns when the pointer comes back.
+ *
+ * Keyboard focus counts as presence too (CA-841, WCAG 2.1.1 / 2.4.7). The bar
+ * is only faded (opacity), not removed, so its buttons stay in the tab order;
+ * without this a keyboard user tabbed onto buttons they could not see, and
+ * nothing but a mouse movement ever brought the bar back.
+ */
+export interface ControlsAutoHide {
+    isVisible(): boolean;
+    /**
+     * Start the countdown to hiding the bar. When the countdown ends the bar
+     * stays up if a control inside the widget still has focus; it is hidden
+     * later, after focus leaves.
+     */
+    scheduleHide(): void;
+    destroy(): void;
+}
+export interface ControlsAutoHideOptions {
+    /** Called whenever the bar becomes visible (`true`) or hidden (`false`). */
+    onChange: (visible: boolean) => void;
+    /** How long after the pointer or focus leaves before hiding. Default 5000. */
+    delayMs?: number;
+}
+export declare function createControlsAutoHide(root: HTMLElement, { onChange, delayMs }: ControlsAutoHideOptions): ControlsAutoHide;

package/lib/components/controls/createControlButton.d.ts

@@ -11,3 +11,12 @@
  * `:hover` or `:focus-visible`.
  */
 export declare function createControlButton(extraClass?: string): HTMLButtonElement;
+/**
+ * Puts a control's icon in its button, replacing whatever was there.
+ *
+ * The icon is decorative: the button's own `aria-label` is its name. Without
+ * `aria-hidden` assistive technology may announce the unlabelled graphic as
+ * well, and `focusable="false"` keeps legacy engines from adding the SVG to
+ * the tab order.
+ */
+export declare function setControlIcon(btn: HTMLElement, icon: SVGElement): void;