@versini/ui-liveregion 3.0.2 → 3.1.1

package/dist/index.d.ts

@@ -1,12 +1,87 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { LiveRegionTypes } from '@versini/ui-types';
-
-/**
- * The `LiveRegion` component abstracts the logic for
- * rendering live region content that consistently announces
- * across assistive technologies (e.g. JAWS, VoiceOver,
- * NVDA).
- */
-declare function LiveRegion({ children, className, politeness: politenessProp, role, announcementDelay, clearAnnouncementDelay, onAnnouncementClear, visible, ...otherProps }: LiveRegionTypes.Props): react_jsx_runtime.JSX.Element;
-
-export { LiveRegion };
+import { JSX } from 'react/jsx-runtime';
+
+/**
+ * The `LiveRegion` component abstracts the logic for
+ * rendering live region content that consistently announces
+ * across assistive technologies (e.g. JAWS, VoiceOver,
+ * NVDA).
+ */
+export declare function LiveRegion({ children, className, politeness: politenessProp, role, announcementDelay, clearAnnouncementDelay, onAnnouncementClear, visible, ...otherProps }: LiveRegionTypes.Props): JSX.Element;
+
+declare namespace LiveRegionTypes {
+    	type SetTimeoutResult = ReturnType<typeof setTimeout> | null;
+    	type Action =
+    		| Record<string, never>
+    		| {
+        				type: "SET_ANNOUNCEMENT" | "CLEAR_ANNOUNCEMENT";
+        				payload?: string | React.ReactNode;
+        		  };
+
+    	type State = {
+        		announcement: string | React.ReactNode;
+        	};
+
+    	type PolitenessByRole = {
+        		[key: string]: any;
+        	};
+
+    	type ClearAnnouncementProps = {
+        		dispatch: React.Dispatch<Action>;
+        		onAnnouncementClear?: () => void;
+        	};
+
+    	type AnnounceProps = {
+        		children: React.ReactNode;
+        		clearAnnouncementTimeoutRef: React.MutableRefObject<SetTimeoutResult>;
+        		dispatch: React.Dispatch<Action>;
+        		clearAnnouncementDelay?: number;
+        		onAnnouncementClear?: () => void;
+        	};
+
+    	type ConditionallyDelayAnnouncementProps = {
+        		announcementTimeoutRef: React.MutableRefObject<SetTimeoutResult>;
+        		children: React.ReactNode;
+        		clearAnnouncementTimeoutRef: React.MutableRefObject<SetTimeoutResult>;
+        		dispatch: React.Dispatch<Action>;
+        		announcementDelay?: number;
+        		clearAnnouncementDelay?: number;
+        		onAnnouncementClear?: () => void;
+        	};
+
+    	type Props = {
+        		/**
+         		 * The content to be announced by the live region.
+         		 */
+        		children: React.ReactNode;
+        		/**
+         		 * The number of milliseconds to wait before announcing the content.
+         		 */
+        		announcementDelay?: number;
+        		/**
+         		 * The `className` to apply to the live region.
+         		 */
+        		className?: string;
+        		/**
+         		 * The number of milliseconds to wait before clearing the announcement.
+         		 */
+        		clearAnnouncementDelay?: number;
+        		/**
+         		 * A callback to be invoked when the announcement is cleared.
+         		 */
+        		onAnnouncementClear?: () => void;
+        		/**
+         		 * The `aria-live` politeness level to apply to the live region.
+         		 */
+        		politeness?: "polite" | "assertive" | "off" | null | undefined;
+        		/**
+         		 * The `role` to apply to the live region.
+         		 */
+        		role?: "alert" | "status" | null | undefined;
+        		/**
+         		 * Whether or not the live region should be visible.
+         		 */
+        		visible?: boolean;
+        	};
+}
+
+export { }

package/dist/index.js

@@ -1,17 +1,257 @@
-import { LiveRegion as o } from "./components/LiveRegion/LiveRegion.js";
 /*!
-  @versini/ui-liveregion v3.0.2
+  @versini/ui-liveregion v3.1.1
   © 2025 gizmette.com
 */
 try {
-  window.__VERSINI_UI_LIVEREGION__ || (window.__VERSINI_UI_LIVEREGION__ = {
-    version: "3.0.2",
-    buildTime: "10/17/2025 12:52 PM EDT",
-    homepage: "https://github.com/aversini/ui-components",
-    license: "MIT"
-  });
-} catch {
+  if (!window.__VERSINI_UI_LIVEREGION__) {
+    window.__VERSINI_UI_LIVEREGION__ = {
+      version: "3.1.1",
+      buildTime: "11/30/2025 06:52 PM EST",
+      homepage: "https://github.com/aversini/ui-components",
+      license: "MIT",
+    };
+  }
+} catch (error) {
+  // nothing to declare officer
 }
-export {
-  o as LiveRegion
+
+import { jsx } from "react/jsx-runtime";
+import clsx from "clsx";
+import { useEffect, useReducer, useRef } from "react";
+
+;// CONCATENATED MODULE: external "react/jsx-runtime"
+
+;// CONCATENATED MODULE: external "clsx"
+
+;// CONCATENATED MODULE: external "react"
+
+;// CONCATENATED MODULE: ./src/components/LiveRegion/constants.ts
+const ACTION_SET_ANNOUNCEMENT = "SET_ANNOUNCEMENT";
+const ACTION_CLEAR_ANNOUNCEMENT = "CLEAR_ANNOUNCEMENT";
+/**
+ * The default politeness value for each role.
+ *
+ * @enum {String}
+ */ const DEFAULT_POLITENESS_BY_ROLE = {
+    alert: null,
+    alertdialog: null,
+    log: "polite",
+    marquee: null,
+    progressbar: null,
+    status: "polite",
+    timer: "assertive"
 };
+/**
+ * All supported `LiveRegion` roles.
+ *
+ * @enum {String}
+ * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques#Live_Region_Roles
+ */ const ROLES = (/* unused pure expression or super */ null && ({
+    /**
+	 * A message with important, and usually time-sensitive
+	 * information.
+	 *
+	 * Default politeness is `null` (does not add the
+	 * `aria-live` attribute).
+	 *
+	 * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Alert_Role
+	 * @see https://www.w3.org/TR/2009/WD-wai-aria-20091215/roles#alert
+	 */ ALERT: "alert",
+    /**
+	 * A type of dialog that contains an alert message, where
+	 * initial focus goes to the dialog or an element
+	 * within it.
+	 *
+	 * Authors SHOULD use aria-describedby on an alertdialog
+	 * to point to the alert message element in the
+	 * dialog.
+	 *
+	 * Default politeness is `null` (does not add the
+	 * `aria-live` attribute).
+	 *
+	 * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_alertdialog_role
+	 * @see https://www.w3.org/TR/2009/WD-wai-aria-20091215/roles#alertdialog
+	 */ ALERTDIALOG: "alertdialog",
+    /**
+	 * A type of live region where new information is added in
+	 * meaningful order and old information may
+	 * disappear.
+	 *
+	 * Default politeness is `"polite"`.
+	 *
+	 * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_log_role
+	 * @see https://www.w3.org/TR/2009/WD-wai-aria-20091215/roles#log
+	 */ LOG: "log",
+    /**
+	 * A type of live region where non-essential information
+	 * changes frequently. The primary difference
+	 * between a marquee and a log is that logs usually have
+	 * a meaningful order or sequence of important
+	 * content changes.
+	 *
+	 * Default politeness is `null` (does not add the
+	 * `aria-live` attribute).
+	 */ MARQUEE: "marquee",
+    /**
+	 * An element that displays the progress status for tasks
+	 * that take a long time.
+	 *
+	 * Default politeness is `null` (does not add the
+	 * `aria-live` attribute).
+	 *
+	 * @see https://www.w3.org/TR/2009/WD-wai-aria-20091215/roles#progressbar
+	 */ PROGRESSBAR: "progressbar",
+    /**
+	 * A container whose content is advisory information for
+	 * the user but is not important enough to justify
+	 * an alert.
+	 *
+	 * Default politeness is `"polite"`.
+	 *
+	 * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_status_role
+	 * @see https://www.w3.org/TR/2009/WD-wai-aria-20091215/roles#status
+	 */ STATUS: "status",
+    /**
+	 * A numerical counter which indicates an amount of
+	 * elapsed time from a start point, or the time remaining
+	 * until an end point.
+	 *
+	 * Default politeness is `"assertive"`.
+	 *
+	 * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/ARIA_timer_role
+	 * @see https://www.w3.org/TR/2009/WD-wai-aria-20091215/roles#timer
+	 */ TIMER: "timer"
+}));
+
+;// CONCATENATED MODULE: ./src/components/LiveRegion/reducer.ts
+
+const reducer = (state, action)=>{
+    switch(action?.type){
+        case ACTION_SET_ANNOUNCEMENT:
+            return {
+                ...state,
+                announcement: action.payload
+            };
+        case ACTION_CLEAR_ANNOUNCEMENT:
+            return {
+                ...state,
+                announcement: null
+            };
+        default:
+            return state;
+    }
+};
+
+;// CONCATENATED MODULE: ./src/components/LiveRegion/utilities.ts
+
+/**
+ * Removes the content from the live region.
+ */ const clearAnnouncement = ({ onAnnouncementClear, dispatch })=>{
+    dispatch({
+        type: ACTION_CLEAR_ANNOUNCEMENT
+    });
+    if (typeof onAnnouncementClear === "function") {
+        onAnnouncementClear();
+    }
+};
+/**
+ * Announce the content of "children".
+ */ const announce = ({ children, clearAnnouncementDelay, clearAnnouncementTimeoutRef, onAnnouncementClear, dispatch })=>{
+    clearTimeout(clearAnnouncementTimeoutRef.current);
+    if (children !== null) {
+        dispatch({
+            type: ACTION_SET_ANNOUNCEMENT,
+            payload: children
+        });
+    }
+    if (clearAnnouncementDelay) {
+        clearAnnouncementTimeoutRef.current = setTimeout(()=>clearAnnouncement({
+                onAnnouncementClear,
+                dispatch
+            }), clearAnnouncementDelay);
+    }
+};
+/**
+ * Inserts the content into the live region with some
+ * delay if the announcementDelay prop is supplied.
+ * Otherwise inserts the content immediately.
+ */ const conditionallyDelayAnnouncement = ({ children, announcementTimeoutRef, announcementDelay, clearAnnouncementDelay, clearAnnouncementTimeoutRef, onAnnouncementClear, dispatch })=>{
+    clearTimeout(announcementTimeoutRef.current);
+    if (announcementDelay) {
+        announcementTimeoutRef.current = setTimeout(announce, announcementDelay, {
+            children,
+            clearAnnouncementDelay,
+            clearAnnouncementTimeoutRef,
+            onAnnouncementClear,
+            dispatch
+        });
+    } else {
+        announce({
+            children,
+            clearAnnouncementDelay,
+            clearAnnouncementTimeoutRef,
+            onAnnouncementClear,
+            dispatch
+        });
+    }
+};
+
+;// CONCATENATED MODULE: ./src/components/LiveRegion/LiveRegion.tsx
+
+
+
+
+
+
+/**
+ * The `LiveRegion` component abstracts the logic for
+ * rendering live region content that consistently announces
+ * across assistive technologies (e.g. JAWS, VoiceOver,
+ * NVDA).
+ */ function LiveRegion({ children, className, politeness: politenessProp, role = null, announcementDelay, clearAnnouncementDelay, onAnnouncementClear, visible, ...otherProps }) {
+    const announcementTimeoutRef = useRef(null);
+    const clearAnnouncementTimeoutRef = useRef(null);
+    const [state, dispatch] = useReducer(reducer, {
+        announcement: null
+    });
+    let politeness = politenessProp;
+    /**
+	 * We check `undefined` since it is our default,
+	 * and we want to honor when the user supplies `null`.
+	 */ if (typeof politeness === "undefined") {
+        politeness = role ? DEFAULT_POLITENESS_BY_ROLE[role] : "assertive";
+    }
+    useEffect(()=>{
+        conditionallyDelayAnnouncement({
+            announcementTimeoutRef,
+            announcementDelay,
+            children,
+            clearAnnouncementDelay,
+            clearAnnouncementTimeoutRef,
+            onAnnouncementClear,
+            dispatch
+        });
+    }, [
+        children,
+        announcementDelay,
+        clearAnnouncementDelay,
+        onAnnouncementClear
+    ]);
+    const generatedClassName = clsx(className, {
+        "sr-only": !visible
+    });
+    return /*#__PURE__*/ jsx("div", {
+        "aria-live": politeness,
+        ...role && {
+            role: role
+        },
+        className: generatedClassName,
+        ...otherProps,
+        children: state.announcement
+    });
+}
+
+;// CONCATENATED MODULE: ./src/components/index.ts
+/* v8 ignore next 1 */ 
+
+export { LiveRegion };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@versini/ui-liveregion",
-	"version": "3.0.2",
+	"version": "3.1.1",
 	"license": "MIT",
 	"author": "Arno Versini",
 	"publishConfig": {
@@ -20,13 +20,13 @@
 	],
 	"scripts": {
 		"build:check": "tsc",
-		"build:js": "vite build",
-		"build:types": "tsup",
-		"build": "npm-run-all --serial clean build:check build:js build:types",
+		"build:js": "rslib build",
+		"build:types": "echo 'Types now built with rslib'",
+		"build": "npm-run-all --serial clean build:check build:js",
 		"clean": "rimraf dist tmp",
-		"dev:js": "vite build --watch --mode development",
-		"dev:types": "tsup --watch src",
-		"dev": "npm-run-all clean --parallel dev:js dev:types",
+		"dev:js": "rslib build --watch",
+		"dev:types": "echo 'Types now watched with rslib'",
+		"dev": "rslib build --watch",
 		"lint": "biome lint src",
 		"lint:fix": "biome check src --write --no-errors-on-unmatched",
 		"prettier": "biome check --write --no-errors-on-unmatched",
@@ -38,10 +38,10 @@
 	},
 	"devDependencies": {
 		"@testing-library/jest-dom": "6.9.1",
-		"@versini/ui-types": "6.0.2"
+		"@versini/ui-types": "7.0.0"
 	},
 	"sideEffects": [
 		"**/*.css"
 	],
-	"gitHead": "67e049c9b2e46e8f52509bf6198ca0cdaf5d970a"
+	"gitHead": "4795cf3239cceaf83dde13addc5254caa12dee6f"
 }

package/dist/components/LiveRegion/LiveRegion.js

@@ -1,121 +0,0 @@
-import { jsx as O } from "react/jsx-runtime";
-import C from "clsx";
-import { useRef as i, useReducer as L, useEffect as g } from "react";
-const c = "SET_ANNOUNCEMENT", E = "CLEAR_ANNOUNCEMENT", v = {
-  alert: null,
-  alertdialog: null,
-  log: "polite",
-  marquee: null,
-  progressbar: null,
-  status: "polite",
-  timer: "assertive"
-}, y = (t, e) => {
-  switch (e?.type) {
-    case c:
-      return {
-        ...t,
-        announcement: e.payload
-      };
-    case E:
-      return {
-        ...t,
-        announcement: null
-      };
-    default:
-      return t;
-  }
-}, R = ({
-  onAnnouncementClear: t,
-  dispatch: e
-}) => {
-  e({
-    type: E
-  }), typeof t == "function" && t();
-}, N = ({
-  children: t,
-  clearAnnouncementDelay: e,
-  clearAnnouncementTimeoutRef: o,
-  onAnnouncementClear: s,
-  dispatch: u
-}) => {
-  clearTimeout(o.current), t !== null && u({
-    type: c,
-    payload: t
-  }), e && (o.current = setTimeout(
-    () => R({
-      onAnnouncementClear: s,
-      dispatch: u
-    }),
-    e
-  ));
-}, U = ({
-  children: t,
-  announcementTimeoutRef: e,
-  announcementDelay: o,
-  clearAnnouncementDelay: s,
-  clearAnnouncementTimeoutRef: u,
-  onAnnouncementClear: r,
-  dispatch: l
-}) => {
-  clearTimeout(e.current), o ? e.current = setTimeout(N, o, {
-    children: t,
-    clearAnnouncementDelay: s,
-    clearAnnouncementTimeoutRef: u,
-    onAnnouncementClear: r,
-    dispatch: l
-  }) : N({
-    children: t,
-    clearAnnouncementDelay: s,
-    clearAnnouncementTimeoutRef: u,
-    onAnnouncementClear: r,
-    dispatch: l
-  });
-};
-function x({
-  children: t,
-  className: e,
-  politeness: o,
-  role: s = null,
-  announcementDelay: u,
-  clearAnnouncementDelay: r,
-  onAnnouncementClear: l,
-  visible: f,
-  ...a
-}) {
-  const p = i(null), T = i(null), [m, _] = L(y, {
-    announcement: null
-  });
-  let n = o;
-  typeof n > "u" && (n = s ? v[s] : "assertive"), g(() => {
-    U({
-      announcementTimeoutRef: p,
-      announcementDelay: u,
-      children: t,
-      clearAnnouncementDelay: r,
-      clearAnnouncementTimeoutRef: T,
-      onAnnouncementClear: l,
-      dispatch: _
-    });
-  }, [
-    t,
-    u,
-    r,
-    l
-  ]);
-  const d = C(e, {
-    "sr-only": !f
-  });
-  return /* @__PURE__ */ O(
-    "div",
-    {
-      "aria-live": n,
-      ...s && { role: s },
-      className: d,
-      ...a,
-      children: m.announcement
-    }
-  );
-}
-export {
-  x as LiveRegion
-};