@elliemae/ds-accessibility 3.1.4-rc.2 → 3.1.5-rc.1

package/dist/cjs/live-region/DSLiveRegion.js

@@ -31,7 +31,7 @@ var import_ds_utilities = require("@elliemae/ds-utilities");
 var import_styles = require("./styles");
 var import_propTypes = require("./propTypes");
 const DSLiveRegion = (0, import_react.memo)((props) => {
-  const [text, setText] = (0, import_react.useState)("");
+  const [text, setText] = (0, import_react.useState)(" ");
   (0, import_react.useEffect)(() => {
     if (props.methods && props.methods.current) {
       props.methods.current.read = setText;

package/dist/cjs/live-region/DSLiveRegion.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/live-region/DSLiveRegion.tsx", "../../../../../scripts/build/transpile/react-shim.js"],
-  "sourcesContent": ["import ReactDOM from 'react-dom';\nimport React, { memo, useEffect, useState } from 'react';\nimport { describe } from '@elliemae/ds-utilities';\nimport { StyledContainer } from './styles';\nimport { propTypes } from './propTypes';\nimport type { DSLiveRegionT } from './propTypes';\n\nconst DSLiveRegion = memo((props: DSLiveRegionT.Props): JSX.Element | null => {\n  const [text, setText] = useState('');\n\n  useEffect(() => {\n    if (props.methods && props.methods.current) {\n      props.methods.current.read = setText;\n    }\n  }, [props.methods]);\n\n  if (text === '') return null;\n\n  return ReactDOM.createPortal(\n    <StyledContainer aria-atomic id={props.id} role={props.role} aria-live={props['aria-live'] || 'polite'}>\n      {text}\n    </StyledContainer>,\n    props.portal?.current || document.body,\n  );\n});\n\nDSLiveRegion.propTypes = propTypes;\nDSLiveRegion.displayName = 'DSLiveRegion';\nconst DSLiveRegionWithSchema = describe(DSLiveRegion);\nDSLiveRegionWithSchema.propTypes = propTypes;\n\nexport { DSLiveRegion, DSLiveRegionWithSchema };\n", "import * as React from 'react';\nexport { React };\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADAvB,uBAAqB;AACrB,mBAAiD;AACjD,0BAAyB;AACzB,oBAAgC;AAChC,uBAA0B;AAG1B,MAAM,eAAe,uBAAK,CAAC,UAAmD;AAC5E,QAAM,CAAC,MAAM,WAAW,2BAAS,EAAE;AAEnC,8BAAU,MAAM;AACd,QAAI,MAAM,WAAW,MAAM,QAAQ,SAAS;AAC1C,YAAM,QAAQ,QAAQ,OAAO;AAAA,IAC/B;AAAA,EACF,GAAG,CAAC,MAAM,OAAO,CAAC;AAElB,MAAI,SAAS;AAAI,WAAO;AAExB,SAAO,yBAAS,aACd,mDAAC;AAAA,IAAgB,eAAW;AAAA,IAAC,IAAI,MAAM;AAAA,IAAI,MAAM,MAAM;AAAA,IAAM,aAAW,MAAM,gBAAgB;AAAA,KAC3F,IACH,GACA,MAAM,QAAQ,WAAW,SAAS,IACpC;AACF,CAAC;AAED,aAAa,YAAY;AACzB,aAAa,cAAc;AAC3B,MAAM,yBAAyB,kCAAS,YAAY;AACpD,uBAAuB,YAAY;",
+  "sourcesContent": ["import ReactDOM from 'react-dom';\nimport React, { memo, useEffect, useState } from 'react';\nimport { describe } from '@elliemae/ds-utilities';\nimport { StyledContainer } from './styles';\nimport { propTypes } from './propTypes';\nimport type { DSLiveRegionT } from './propTypes';\n\nconst DSLiveRegion = memo((props: DSLiveRegionT.Props): JSX.Element | null => {\n  const [text, setText] = useState(' ');\n\n  useEffect(() => {\n    if (props.methods && props.methods.current) {\n      props.methods.current.read = setText;\n    }\n  }, [props.methods]);\n\n  if (text === '') return null;\n\n  return ReactDOM.createPortal(\n    <StyledContainer aria-atomic id={props.id} role={props.role} aria-live={props['aria-live'] || 'polite'}>\n      {text}\n    </StyledContainer>,\n    props.portal?.current || document.body,\n  );\n});\n\nDSLiveRegion.propTypes = propTypes;\nDSLiveRegion.displayName = 'DSLiveRegion';\nconst DSLiveRegionWithSchema = describe(DSLiveRegion);\nDSLiveRegionWithSchema.propTypes = propTypes;\n\nexport { DSLiveRegion, DSLiveRegionWithSchema };\n", "import * as React from 'react';\nexport { React };\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADAvB,uBAAqB;AACrB,mBAAiD;AACjD,0BAAyB;AACzB,oBAAgC;AAChC,uBAA0B;AAG1B,MAAM,eAAe,uBAAK,CAAC,UAAmD;AAC5E,QAAM,CAAC,MAAM,WAAW,2BAAS,GAAG;AAEpC,8BAAU,MAAM;AACd,QAAI,MAAM,WAAW,MAAM,QAAQ,SAAS;AAC1C,YAAM,QAAQ,QAAQ,OAAO;AAAA,IAC/B;AAAA,EACF,GAAG,CAAC,MAAM,OAAO,CAAC;AAElB,MAAI,SAAS;AAAI,WAAO;AAExB,SAAO,yBAAS,aACd,mDAAC;AAAA,IAAgB,eAAW;AAAA,IAAC,IAAI,MAAM;AAAA,IAAI,MAAM,MAAM;AAAA,IAAM,aAAW,MAAM,gBAAgB;AAAA,KAC3F,IACH,GACA,MAAM,QAAQ,WAAW,SAAS,IACpC;AACF,CAAC;AAED,aAAa,YAAY;AACzB,aAAa,cAAc;AAC3B,MAAM,yBAAyB,kCAAS,YAAY;AACpD,uBAAuB,YAAY;",
   "names": []
 }

package/dist/cjs/live-region/index.js

@@ -18,5 +18,5 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var live_region_exports = {};
 module.exports = __toCommonJS(live_region_exports);
 var React = __toESM(require("react"));
-__reExport(live_region_exports, require("./DSLiveRegion"), module.exports);
+__reExport(live_region_exports, require("./useLiveRegion"), module.exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/live-region/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/live-region/index.ts", "../../../../../scripts/build/transpile/react-shim.js"],
-  "sourcesContent": ["export * from './DSLiveRegion';\n", "import * as React from 'react';\nexport { React };\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;AAAA;AAAA;ACAA,YAAuB;ADAvB,gCAAc,2BAAd;",
+  "sourcesContent": ["export * from './useLiveRegion';\n", "import * as React from 'react';\nexport { React };\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;AAAA;AAAA;ACAA,YAAuB;ADAvB,gCAAc,4BAAd;",
   "names": []
 }

package/dist/cjs/live-region/propTypes.js

@@ -24,12 +24,5 @@ __export(propTypes_exports, {
 });
 module.exports = __toCommonJS(propTypes_exports);
 var React = __toESM(require("react"));
-var import_ds_utilities = require("@elliemae/ds-utilities");
-const propTypes = {
-  methods: import_ds_utilities.PropTypes.object.description("Ref Object."),
-  portal: import_ds_utilities.PropTypes.node.description("Sets a custom portal").defaultValue("Body Element."),
-  ["aria-live"]: import_ds_utilities.PropTypes.oneOf(["assertive", "polite", "off"]).description("Selects your aria live mode."),
-  role: import_ds_utilities.PropTypes.oneOf(["log", "status", "alert", "progressbar", "marquee", "timer"]).description("Selects your specific role."),
-  id: import_ds_utilities.PropTypes.string.description("Unique id for the Live Region.")
-};
+const propTypes = {};
 //# sourceMappingURL=propTypes.js.map

package/dist/cjs/live-region/propTypes.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/live-region/propTypes.ts", "../../../../../scripts/build/transpile/react-shim.js"],
-  "sourcesContent": ["import { PropTypes } from '@elliemae/ds-utilities';\nimport type React from 'react';\n\nexport declare module DSLiveRegionT {\n  interface Methods {\n    read: React.Dispatch<React.SetStateAction<string>>;\n  }\n  export interface Props {\n    methods?: React.MutableRefObject<Methods>;\n    portal?: React.MutableRefObject<HTMLElement>;\n    ['aria-live']?: 'off' | 'assertive' | 'polite';\n    role?: 'log' | 'status' | 'alert' | 'progressbar' | 'marquee' | 'timer';\n    id?: string;\n  }\n}\n\nexport const propTypes = {\n  methods: PropTypes.object.description('Ref Object.'),\n  portal: PropTypes.node.description('Sets a custom portal').defaultValue('Body Element.'),\n  ['aria-live']: PropTypes.oneOf(['assertive', 'polite', 'off']).description('Selects your aria live mode.'),\n  role: PropTypes.oneOf(['log', 'status', 'alert', 'progressbar', 'marquee', 'timer']).description(\n    'Selects your specific role.',\n  ),\n  id: PropTypes.string.description('Unique id for the Live Region.'),\n};\n", "import * as React from 'react';\nexport { React };\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADAvB,0BAA0B;AAgBnB,MAAM,YAAY;AAAA,EACvB,SAAS,8BAAU,OAAO,YAAY,aAAa;AAAA,EACnD,QAAQ,8BAAU,KAAK,YAAY,sBAAsB,EAAE,aAAa,eAAe;AAAA,GACtF,cAAc,8BAAU,MAAM,CAAC,aAAa,UAAU,KAAK,CAAC,EAAE,YAAY,8BAA8B;AAAA,EACzG,MAAM,8BAAU,MAAM,CAAC,OAAO,UAAU,SAAS,eAAe,WAAW,OAAO,CAAC,EAAE,YACnF,6BACF;AAAA,EACA,IAAI,8BAAU,OAAO,YAAY,gCAAgC;AACnE;",
+  "sourcesContent": ["import type React from 'react';\n\nexport declare namespace UseLiveRegionT {\n  export interface Props {\n    id?: string;\n    portal?: React.MutableRefObject<HTMLElement>;\n  }\n}\n\nexport const propTypes = {};\n", "import * as React from 'react';\nexport { React };\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADShB,MAAM,YAAY,CAAC;",
   "names": []
 }

package/dist/cjs/live-region/useLiveRegion.js

@@ -0,0 +1,93 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var useLiveRegion_exports = {};
+__export(useLiveRegion_exports, {
+  UseLiveRegionWithSchema: () => UseLiveRegionWithSchema,
+  useLiveRegion: () => useLiveRegion
+});
+module.exports = __toCommonJS(useLiveRegion_exports);
+var React = __toESM(require("react"));
+var import_react_dom = __toESM(require("react-dom"));
+var import_react = __toESM(require("react"));
+var import_ds_utilities = require("@elliemae/ds-utilities");
+var import_uid = require("uid");
+var import_styles = require("./styles");
+var import_propTypes = require("./propTypes");
+const DSLiveRegion = (0, import_react.memo)((props) => {
+  const [internalMessage, setInternalMessage] = (0, import_react.useState)("");
+  const [unsafe_emulateAssertiveNVDA, setUnsafe_emulateAssertiveNVDA] = (0, import_react.useState)(false);
+  const [role, setRole] = (0, import_react.useState)(void 0);
+  const [ariaLive, setAriaLive] = (0, import_react.useState)("polite");
+  const { id, portal } = props || {};
+  const reset = (0, import_react.useCallback)(() => {
+    setInternalMessage("");
+    setUnsafe_emulateAssertiveNVDA(false);
+    setAriaLive("polite");
+    setRole(void 0);
+  }, []);
+  const configure = (0, import_react.useCallback)((message, options) => {
+    reset();
+    setTimeout(() => {
+      if (options?.unsafe_emulateAssertiveNVDA)
+        setUnsafe_emulateAssertiveNVDA(true);
+      setTimeout(() => {
+        if (options?.assertive || options?.unsafe_emulateAssertiveNVDA)
+          setAriaLive("assertive");
+        if (options?.unsafe_emulateAssertiveNVDA) {
+          setRole("alert");
+          setUnsafe_emulateAssertiveNVDA(false);
+        }
+        setInternalMessage(message);
+      });
+    });
+  }, [reset]);
+  (0, import_react.useEffect)(() => {
+    if (props.methods) {
+      props.methods.current.read = configure;
+    }
+  }, [configure, props.methods]);
+  if (unsafe_emulateAssertiveNVDA)
+    return null;
+  return import_react_dom.default.createPortal(/* @__PURE__ */ import_react.default.createElement(import_styles.StyledContainer, {
+    "aria-atomic": true,
+    id,
+    role,
+    "aria-live": ariaLive
+  }, internalMessage), portal?.current || document.body);
+});
+const useLiveRegion = (props) => {
+  const methods = (0, import_react.useRef)({});
+  const { id, portal } = props || {};
+  const instanceUID = (0, import_react.useMemo)(() => `ds-live-region-${(0, import_uid.uid)(5)}`, []);
+  const read = (0, import_react.useCallback)((message, options) => methods.current.read?.(message, options), []);
+  return (0, import_react.useMemo)(() => ({
+    LiveRegion: () => /* @__PURE__ */ import_react.default.createElement(DSLiveRegion, {
+      methods,
+      id: instanceUID || id,
+      portal
+    }),
+    read
+  }), [id, instanceUID, portal, read]);
+};
+useLiveRegion.displayName = "useLiveRegion";
+const UseLiveRegionWithSchema = (0, import_ds_utilities.describe)(useLiveRegion);
+UseLiveRegionWithSchema.propTypes = import_propTypes.propTypes;
+//# sourceMappingURL=useLiveRegion.js.map

package/dist/cjs/live-region/useLiveRegion.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/live-region/useLiveRegion.tsx", "../../../../../scripts/build/transpile/react-shim.js"],
+  "sourcesContent": ["import ReactDOM from 'react-dom';\nimport React, { memo, useEffect, useState, useCallback, useRef, useMemo } from 'react';\nimport { describe } from '@elliemae/ds-utilities';\nimport { uid } from 'uid';\nimport { StyledContainer } from './styles';\nimport { propTypes } from './propTypes';\nimport type { UseLiveRegionT } from './propTypes';\n\ninterface Options {\n  assertive?: boolean;\n  unsafe_emulateAssertiveNVDA?: boolean;\n}\ninterface Methods {\n  read?: (message: string, options: Options) => void;\n}\nexport interface Props {\n  methods?: React.MutableRefObject<Methods>;\n  id?: string;\n  portal?: React.MutableRefObject<HTMLElement>;\n}\n\nconst DSLiveRegion = memo((props: Props): JSX.Element | null => {\n  const [internalMessage, setInternalMessage] = useState<string>('');\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  const [unsafe_emulateAssertiveNVDA, setUnsafe_emulateAssertiveNVDA] = useState(false);\n  const [role, setRole] = useState<undefined | string>(undefined);\n  const [ariaLive, setAriaLive] = useState('polite');\n  const { id, portal } = props || {};\n\n  const reset = useCallback(() => {\n    setInternalMessage('');\n    setUnsafe_emulateAssertiveNVDA(false);\n    setAriaLive('polite');\n    setRole(undefined);\n  }, []);\n\n  const configure = useCallback(\n    (message: string, options: Options) => {\n      reset();\n      setTimeout(() => {\n        if (options?.unsafe_emulateAssertiveNVDA) setUnsafe_emulateAssertiveNVDA(true);\n        // eslint-disable-next-line max-nested-callbacks\n        setTimeout(() => {\n          if (options?.assertive || options?.unsafe_emulateAssertiveNVDA) setAriaLive('assertive');\n          if (options?.unsafe_emulateAssertiveNVDA) {\n            setRole('alert');\n            setUnsafe_emulateAssertiveNVDA(false);\n          }\n          setInternalMessage(message);\n        });\n      });\n    },\n    [reset],\n  );\n\n  useEffect(() => {\n    if (props.methods) {\n      props.methods.current.read = configure;\n    }\n  }, [configure, props.methods]);\n\n  if (unsafe_emulateAssertiveNVDA) return null;\n\n  return ReactDOM.createPortal(\n    <StyledContainer aria-atomic id={id} role={role} aria-live={ariaLive}>\n      {internalMessage}\n    </StyledContainer>,\n    portal?.current || document.body,\n  );\n});\n\nconst useLiveRegion = (props: UseLiveRegionT.Props) => {\n  const methods = useRef<Methods>({});\n\n  const { id, portal } = props || {};\n\n  const instanceUID = useMemo(() => `ds-live-region-${uid(5)}`, []);\n\n  const read = useCallback((message: string, options: Options) => methods.current.read?.(message, options), []);\n\n  return useMemo(\n    () => ({\n      LiveRegion: () => <DSLiveRegion methods={methods} id={instanceUID || id} portal={portal} />,\n      read,\n    }),\n    [id, instanceUID, portal, read],\n  );\n};\n\nuseLiveRegion.displayName = 'useLiveRegion';\nconst UseLiveRegionWithSchema = describe(useLiveRegion);\nUseLiveRegionWithSchema.propTypes = propTypes;\nexport { useLiveRegion, UseLiveRegionWithSchema };\n", "import * as React from 'react';\nexport { React };\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;ACAA,YAAuB;ADAvB,uBAAqB;AACrB,mBAA+E;AAC/E,0BAAyB;AACzB,iBAAoB;AACpB,oBAAgC;AAChC,uBAA0B;AAgB1B,MAAM,eAAe,uBAAK,CAAC,UAAqC;AAC9D,QAAM,CAAC,iBAAiB,sBAAsB,2BAAiB,EAAE;AAEjE,QAAM,CAAC,6BAA6B,kCAAkC,2BAAS,KAAK;AACpF,QAAM,CAAC,MAAM,WAAW,2BAA6B,MAAS;AAC9D,QAAM,CAAC,UAAU,eAAe,2BAAS,QAAQ;AACjD,QAAM,EAAE,IAAI,WAAW,SAAS,CAAC;AAEjC,QAAM,QAAQ,8BAAY,MAAM;AAC9B,uBAAmB,EAAE;AACrB,mCAA+B,KAAK;AACpC,gBAAY,QAAQ;AACpB,YAAQ,MAAS;AAAA,EACnB,GAAG,CAAC,CAAC;AAEL,QAAM,YAAY,8BAChB,CAAC,SAAiB,YAAqB;AACrC,UAAM;AACN,eAAW,MAAM;AACf,UAAI,SAAS;AAA6B,uCAA+B,IAAI;AAE7E,iBAAW,MAAM;AACf,YAAI,SAAS,aAAa,SAAS;AAA6B,sBAAY,WAAW;AACvF,YAAI,SAAS,6BAA6B;AACxC,kBAAQ,OAAO;AACf,yCAA+B,KAAK;AAAA,QACtC;AACA,2BAAmB,OAAO;AAAA,MAC5B,CAAC;AAAA,IACH,CAAC;AAAA,EACH,GACA,CAAC,KAAK,CACR;AAEA,8BAAU,MAAM;AACd,QAAI,MAAM,SAAS;AACjB,YAAM,QAAQ,QAAQ,OAAO;AAAA,IAC/B;AAAA,EACF,GAAG,CAAC,WAAW,MAAM,OAAO,CAAC;AAE7B,MAAI;AAA6B,WAAO;AAExC,SAAO,yBAAS,aACd,mDAAC;AAAA,IAAgB,eAAW;AAAA,IAAC;AAAA,IAAQ;AAAA,IAAY,aAAW;AAAA,KACzD,eACH,GACA,QAAQ,WAAW,SAAS,IAC9B;AACF,CAAC;AAED,MAAM,gBAAgB,CAAC,UAAgC;AACrD,QAAM,UAAU,yBAAgB,CAAC,CAAC;AAElC,QAAM,EAAE,IAAI,WAAW,SAAS,CAAC;AAEjC,QAAM,cAAc,0BAAQ,MAAM,kBAAkB,oBAAI,CAAC,KAAK,CAAC,CAAC;AAEhE,QAAM,OAAO,8BAAY,CAAC,SAAiB,YAAqB,QAAQ,QAAQ,OAAO,SAAS,OAAO,GAAG,CAAC,CAAC;AAE5G,SAAO,0BACL,MAAO;AAAA,IACL,YAAY,MAAM,mDAAC;AAAA,MAAa;AAAA,MAAkB,IAAI,eAAe;AAAA,MAAI;AAAA,KAAgB;AAAA,IACzF;AAAA,EACF,IACA,CAAC,IAAI,aAAa,QAAQ,IAAI,CAChC;AACF;AAEA,cAAc,cAAc;AAC5B,MAAM,0BAA0B,kCAAS,aAAa;AACtD,wBAAwB,YAAY;",
+  "names": []
+}

package/dist/esm/live-region/DSLiveRegion.js

@@ -5,7 +5,7 @@ import { describe } from "@elliemae/ds-utilities";
 import { StyledContainer } from "./styles";
 import { propTypes } from "./propTypes";
 const DSLiveRegion = memo((props) => {
-  const [text, setText] = useState("");
+  const [text, setText] = useState(" ");
   useEffect(() => {
     if (props.methods && props.methods.current) {
       props.methods.current.read = setText;

package/dist/esm/live-region/DSLiveRegion.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../../../scripts/build/transpile/react-shim.js", "../../../src/live-region/DSLiveRegion.tsx"],
-  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "import ReactDOM from 'react-dom';\nimport React, { memo, useEffect, useState } from 'react';\nimport { describe } from '@elliemae/ds-utilities';\nimport { StyledContainer } from './styles';\nimport { propTypes } from './propTypes';\nimport type { DSLiveRegionT } from './propTypes';\n\nconst DSLiveRegion = memo((props: DSLiveRegionT.Props): JSX.Element | null => {\n  const [text, setText] = useState('');\n\n  useEffect(() => {\n    if (props.methods && props.methods.current) {\n      props.methods.current.read = setText;\n    }\n  }, [props.methods]);\n\n  if (text === '') return null;\n\n  return ReactDOM.createPortal(\n    <StyledContainer aria-atomic id={props.id} role={props.role} aria-live={props['aria-live'] || 'polite'}>\n      {text}\n    </StyledContainer>,\n    props.portal?.current || document.body,\n  );\n});\n\nDSLiveRegion.propTypes = propTypes;\nDSLiveRegion.displayName = 'DSLiveRegion';\nconst DSLiveRegionWithSchema = describe(DSLiveRegion);\nDSLiveRegionWithSchema.propTypes = propTypes;\n\nexport { DSLiveRegion, DSLiveRegionWithSchema };\n"],
-  "mappings": "AAAA;ACAA;AACA;AACA;AACA;AACA;AAGA,MAAM,eAAe,KAAK,CAAC,UAAmD;AAC5E,QAAM,CAAC,MAAM,WAAW,SAAS,EAAE;AAEnC,YAAU,MAAM;AACd,QAAI,MAAM,WAAW,MAAM,QAAQ,SAAS;AAC1C,YAAM,QAAQ,QAAQ,OAAO;AAAA,IAC/B;AAAA,EACF,GAAG,CAAC,MAAM,OAAO,CAAC;AAElB,MAAI,SAAS;AAAI,WAAO;AAExB,SAAO,SAAS,aACd,qCAAC;AAAA,IAAgB,eAAW;AAAA,IAAC,IAAI,MAAM;AAAA,IAAI,MAAM,MAAM;AAAA,IAAM,aAAW,MAAM,gBAAgB;AAAA,KAC3F,IACH,GACA,MAAM,QAAQ,WAAW,SAAS,IACpC;AACF,CAAC;AAED,aAAa,YAAY;AACzB,aAAa,cAAc;AAC3B,MAAM,yBAAyB,SAAS,YAAY;AACpD,uBAAuB,YAAY;",
+  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "import ReactDOM from 'react-dom';\nimport React, { memo, useEffect, useState } from 'react';\nimport { describe } from '@elliemae/ds-utilities';\nimport { StyledContainer } from './styles';\nimport { propTypes } from './propTypes';\nimport type { DSLiveRegionT } from './propTypes';\n\nconst DSLiveRegion = memo((props: DSLiveRegionT.Props): JSX.Element | null => {\n  const [text, setText] = useState(' ');\n\n  useEffect(() => {\n    if (props.methods && props.methods.current) {\n      props.methods.current.read = setText;\n    }\n  }, [props.methods]);\n\n  if (text === '') return null;\n\n  return ReactDOM.createPortal(\n    <StyledContainer aria-atomic id={props.id} role={props.role} aria-live={props['aria-live'] || 'polite'}>\n      {text}\n    </StyledContainer>,\n    props.portal?.current || document.body,\n  );\n});\n\nDSLiveRegion.propTypes = propTypes;\nDSLiveRegion.displayName = 'DSLiveRegion';\nconst DSLiveRegionWithSchema = describe(DSLiveRegion);\nDSLiveRegionWithSchema.propTypes = propTypes;\n\nexport { DSLiveRegion, DSLiveRegionWithSchema };\n"],
+  "mappings": "AAAA;ACAA;AACA;AACA;AACA;AACA;AAGA,MAAM,eAAe,KAAK,CAAC,UAAmD;AAC5E,QAAM,CAAC,MAAM,WAAW,SAAS,GAAG;AAEpC,YAAU,MAAM;AACd,QAAI,MAAM,WAAW,MAAM,QAAQ,SAAS;AAC1C,YAAM,QAAQ,QAAQ,OAAO;AAAA,IAC/B;AAAA,EACF,GAAG,CAAC,MAAM,OAAO,CAAC;AAElB,MAAI,SAAS;AAAI,WAAO;AAExB,SAAO,SAAS,aACd,qCAAC;AAAA,IAAgB,eAAW;AAAA,IAAC,IAAI,MAAM;AAAA,IAAI,MAAM,MAAM;AAAA,IAAM,aAAW,MAAM,gBAAgB;AAAA,KAC3F,IACH,GACA,MAAM,QAAQ,WAAW,SAAS,IACpC;AACF,CAAC;AAED,aAAa,YAAY;AACzB,aAAa,cAAc;AAC3B,MAAM,yBAAyB,SAAS,YAAY;AACpD,uBAAuB,YAAY;",
   "names": []
 }

package/dist/esm/live-region/index.js

@@ -1,3 +1,3 @@
 import * as React from "react";
-export * from "./DSLiveRegion";
+export * from "./useLiveRegion";
 //# sourceMappingURL=index.js.map

package/dist/esm/live-region/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../../../scripts/build/transpile/react-shim.js", "../../../src/live-region/index.ts"],
-  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "export * from './DSLiveRegion';\n"],
+  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "export * from './useLiveRegion';\n"],
   "mappings": "AAAA;ACAA;",
   "names": []
 }

package/dist/esm/live-region/propTypes.js

@@ -1,12 +1,5 @@
 import * as React from "react";
-import { PropTypes } from "@elliemae/ds-utilities";
-const propTypes = {
-  methods: PropTypes.object.description("Ref Object."),
-  portal: PropTypes.node.description("Sets a custom portal").defaultValue("Body Element."),
-  ["aria-live"]: PropTypes.oneOf(["assertive", "polite", "off"]).description("Selects your aria live mode."),
-  role: PropTypes.oneOf(["log", "status", "alert", "progressbar", "marquee", "timer"]).description("Selects your specific role."),
-  id: PropTypes.string.description("Unique id for the Live Region.")
-};
+const propTypes = {};
 export {
   propTypes
 };

package/dist/esm/live-region/propTypes.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../../../scripts/build/transpile/react-shim.js", "../../../src/live-region/propTypes.ts"],
-  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "import { PropTypes } from '@elliemae/ds-utilities';\nimport type React from 'react';\n\nexport declare module DSLiveRegionT {\n  interface Methods {\n    read: React.Dispatch<React.SetStateAction<string>>;\n  }\n  export interface Props {\n    methods?: React.MutableRefObject<Methods>;\n    portal?: React.MutableRefObject<HTMLElement>;\n    ['aria-live']?: 'off' | 'assertive' | 'polite';\n    role?: 'log' | 'status' | 'alert' | 'progressbar' | 'marquee' | 'timer';\n    id?: string;\n  }\n}\n\nexport const propTypes = {\n  methods: PropTypes.object.description('Ref Object.'),\n  portal: PropTypes.node.description('Sets a custom portal').defaultValue('Body Element.'),\n  ['aria-live']: PropTypes.oneOf(['assertive', 'polite', 'off']).description('Selects your aria live mode.'),\n  role: PropTypes.oneOf(['log', 'status', 'alert', 'progressbar', 'marquee', 'timer']).description(\n    'Selects your specific role.',\n  ),\n  id: PropTypes.string.description('Unique id for the Live Region.'),\n};\n"],
-  "mappings": "AAAA;ACAA;AAgBO,MAAM,YAAY;AAAA,EACvB,SAAS,UAAU,OAAO,YAAY,aAAa;AAAA,EACnD,QAAQ,UAAU,KAAK,YAAY,sBAAsB,EAAE,aAAa,eAAe;AAAA,GACtF,cAAc,UAAU,MAAM,CAAC,aAAa,UAAU,KAAK,CAAC,EAAE,YAAY,8BAA8B;AAAA,EACzG,MAAM,UAAU,MAAM,CAAC,OAAO,UAAU,SAAS,eAAe,WAAW,OAAO,CAAC,EAAE,YACnF,6BACF;AAAA,EACA,IAAI,UAAU,OAAO,YAAY,gCAAgC;AACnE;",
+  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "import type React from 'react';\n\nexport declare namespace UseLiveRegionT {\n  export interface Props {\n    id?: string;\n    portal?: React.MutableRefObject<HTMLElement>;\n  }\n}\n\nexport const propTypes = {};\n"],
+  "mappings": "AAAA;ACSO,MAAM,YAAY,CAAC;",
   "names": []
 }

package/dist/esm/live-region/useLiveRegion.js

@@ -0,0 +1,71 @@
+import * as React from "react";
+import ReactDOM from "react-dom";
+import React2, { memo, useEffect, useState, useCallback, useRef, useMemo } from "react";
+import { describe } from "@elliemae/ds-utilities";
+import { uid } from "uid";
+import { StyledContainer } from "./styles";
+import { propTypes } from "./propTypes";
+const DSLiveRegion = memo((props) => {
+  const [internalMessage, setInternalMessage] = useState("");
+  const [unsafe_emulateAssertiveNVDA, setUnsafe_emulateAssertiveNVDA] = useState(false);
+  const [role, setRole] = useState(void 0);
+  const [ariaLive, setAriaLive] = useState("polite");
+  const { id, portal } = props || {};
+  const reset = useCallback(() => {
+    setInternalMessage("");
+    setUnsafe_emulateAssertiveNVDA(false);
+    setAriaLive("polite");
+    setRole(void 0);
+  }, []);
+  const configure = useCallback((message, options) => {
+    reset();
+    setTimeout(() => {
+      if (options?.unsafe_emulateAssertiveNVDA)
+        setUnsafe_emulateAssertiveNVDA(true);
+      setTimeout(() => {
+        if (options?.assertive || options?.unsafe_emulateAssertiveNVDA)
+          setAriaLive("assertive");
+        if (options?.unsafe_emulateAssertiveNVDA) {
+          setRole("alert");
+          setUnsafe_emulateAssertiveNVDA(false);
+        }
+        setInternalMessage(message);
+      });
+    });
+  }, [reset]);
+  useEffect(() => {
+    if (props.methods) {
+      props.methods.current.read = configure;
+    }
+  }, [configure, props.methods]);
+  if (unsafe_emulateAssertiveNVDA)
+    return null;
+  return ReactDOM.createPortal(/* @__PURE__ */ React2.createElement(StyledContainer, {
+    "aria-atomic": true,
+    id,
+    role,
+    "aria-live": ariaLive
+  }, internalMessage), portal?.current || document.body);
+});
+const useLiveRegion = (props) => {
+  const methods = useRef({});
+  const { id, portal } = props || {};
+  const instanceUID = useMemo(() => `ds-live-region-${uid(5)}`, []);
+  const read = useCallback((message, options) => methods.current.read?.(message, options), []);
+  return useMemo(() => ({
+    LiveRegion: () => /* @__PURE__ */ React2.createElement(DSLiveRegion, {
+      methods,
+      id: instanceUID || id,
+      portal
+    }),
+    read
+  }), [id, instanceUID, portal, read]);
+};
+useLiveRegion.displayName = "useLiveRegion";
+const UseLiveRegionWithSchema = describe(useLiveRegion);
+UseLiveRegionWithSchema.propTypes = propTypes;
+export {
+  UseLiveRegionWithSchema,
+  useLiveRegion
+};
+//# sourceMappingURL=useLiveRegion.js.map

package/dist/esm/live-region/useLiveRegion.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../../scripts/build/transpile/react-shim.js", "../../../src/live-region/useLiveRegion.tsx"],
+  "sourcesContent": ["import * as React from 'react';\nexport { React };\n", "import ReactDOM from 'react-dom';\nimport React, { memo, useEffect, useState, useCallback, useRef, useMemo } from 'react';\nimport { describe } from '@elliemae/ds-utilities';\nimport { uid } from 'uid';\nimport { StyledContainer } from './styles';\nimport { propTypes } from './propTypes';\nimport type { UseLiveRegionT } from './propTypes';\n\ninterface Options {\n  assertive?: boolean;\n  unsafe_emulateAssertiveNVDA?: boolean;\n}\ninterface Methods {\n  read?: (message: string, options: Options) => void;\n}\nexport interface Props {\n  methods?: React.MutableRefObject<Methods>;\n  id?: string;\n  portal?: React.MutableRefObject<HTMLElement>;\n}\n\nconst DSLiveRegion = memo((props: Props): JSX.Element | null => {\n  const [internalMessage, setInternalMessage] = useState<string>('');\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  const [unsafe_emulateAssertiveNVDA, setUnsafe_emulateAssertiveNVDA] = useState(false);\n  const [role, setRole] = useState<undefined | string>(undefined);\n  const [ariaLive, setAriaLive] = useState('polite');\n  const { id, portal } = props || {};\n\n  const reset = useCallback(() => {\n    setInternalMessage('');\n    setUnsafe_emulateAssertiveNVDA(false);\n    setAriaLive('polite');\n    setRole(undefined);\n  }, []);\n\n  const configure = useCallback(\n    (message: string, options: Options) => {\n      reset();\n      setTimeout(() => {\n        if (options?.unsafe_emulateAssertiveNVDA) setUnsafe_emulateAssertiveNVDA(true);\n        // eslint-disable-next-line max-nested-callbacks\n        setTimeout(() => {\n          if (options?.assertive || options?.unsafe_emulateAssertiveNVDA) setAriaLive('assertive');\n          if (options?.unsafe_emulateAssertiveNVDA) {\n            setRole('alert');\n            setUnsafe_emulateAssertiveNVDA(false);\n          }\n          setInternalMessage(message);\n        });\n      });\n    },\n    [reset],\n  );\n\n  useEffect(() => {\n    if (props.methods) {\n      props.methods.current.read = configure;\n    }\n  }, [configure, props.methods]);\n\n  if (unsafe_emulateAssertiveNVDA) return null;\n\n  return ReactDOM.createPortal(\n    <StyledContainer aria-atomic id={id} role={role} aria-live={ariaLive}>\n      {internalMessage}\n    </StyledContainer>,\n    portal?.current || document.body,\n  );\n});\n\nconst useLiveRegion = (props: UseLiveRegionT.Props) => {\n  const methods = useRef<Methods>({});\n\n  const { id, portal } = props || {};\n\n  const instanceUID = useMemo(() => `ds-live-region-${uid(5)}`, []);\n\n  const read = useCallback((message: string, options: Options) => methods.current.read?.(message, options), []);\n\n  return useMemo(\n    () => ({\n      LiveRegion: () => <DSLiveRegion methods={methods} id={instanceUID || id} portal={portal} />,\n      read,\n    }),\n    [id, instanceUID, portal, read],\n  );\n};\n\nuseLiveRegion.displayName = 'useLiveRegion';\nconst UseLiveRegionWithSchema = describe(useLiveRegion);\nUseLiveRegionWithSchema.propTypes = propTypes;\nexport { useLiveRegion, UseLiveRegionWithSchema };\n"],
+  "mappings": "AAAA;ACAA;AACA;AACA;AACA;AACA;AACA;AAgBA,MAAM,eAAe,KAAK,CAAC,UAAqC;AAC9D,QAAM,CAAC,iBAAiB,sBAAsB,SAAiB,EAAE;AAEjE,QAAM,CAAC,6BAA6B,kCAAkC,SAAS,KAAK;AACpF,QAAM,CAAC,MAAM,WAAW,SAA6B,MAAS;AAC9D,QAAM,CAAC,UAAU,eAAe,SAAS,QAAQ;AACjD,QAAM,EAAE,IAAI,WAAW,SAAS,CAAC;AAEjC,QAAM,QAAQ,YAAY,MAAM;AAC9B,uBAAmB,EAAE;AACrB,mCAA+B,KAAK;AACpC,gBAAY,QAAQ;AACpB,YAAQ,MAAS;AAAA,EACnB,GAAG,CAAC,CAAC;AAEL,QAAM,YAAY,YAChB,CAAC,SAAiB,YAAqB;AACrC,UAAM;AACN,eAAW,MAAM;AACf,UAAI,SAAS;AAA6B,uCAA+B,IAAI;AAE7E,iBAAW,MAAM;AACf,YAAI,SAAS,aAAa,SAAS;AAA6B,sBAAY,WAAW;AACvF,YAAI,SAAS,6BAA6B;AACxC,kBAAQ,OAAO;AACf,yCAA+B,KAAK;AAAA,QACtC;AACA,2BAAmB,OAAO;AAAA,MAC5B,CAAC;AAAA,IACH,CAAC;AAAA,EACH,GACA,CAAC,KAAK,CACR;AAEA,YAAU,MAAM;AACd,QAAI,MAAM,SAAS;AACjB,YAAM,QAAQ,QAAQ,OAAO;AAAA,IAC/B;AAAA,EACF,GAAG,CAAC,WAAW,MAAM,OAAO,CAAC;AAE7B,MAAI;AAA6B,WAAO;AAExC,SAAO,SAAS,aACd,qCAAC;AAAA,IAAgB,eAAW;AAAA,IAAC;AAAA,IAAQ;AAAA,IAAY,aAAW;AAAA,KACzD,eACH,GACA,QAAQ,WAAW,SAAS,IAC9B;AACF,CAAC;AAED,MAAM,gBAAgB,CAAC,UAAgC;AACrD,QAAM,UAAU,OAAgB,CAAC,CAAC;AAElC,QAAM,EAAE,IAAI,WAAW,SAAS,CAAC;AAEjC,QAAM,cAAc,QAAQ,MAAM,kBAAkB,IAAI,CAAC,KAAK,CAAC,CAAC;AAEhE,QAAM,OAAO,YAAY,CAAC,SAAiB,YAAqB,QAAQ,QAAQ,OAAO,SAAS,OAAO,GAAG,CAAC,CAAC;AAE5G,SAAO,QACL,MAAO;AAAA,IACL,YAAY,MAAM,qCAAC;AAAA,MAAa;AAAA,MAAkB,IAAI,eAAe;AAAA,MAAI;AAAA,KAAgB;AAAA,IACzF;AAAA,EACF,IACA,CAAC,IAAI,aAAa,QAAQ,IAAI,CAChC;AACF;AAEA,cAAc,cAAc;AAC5B,MAAM,0BAA0B,SAAS,aAAa;AACtD,wBAAwB,YAAY;",
+  "names": []
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-accessibility",
-  "version": "3.1.4-rc.2",
+  "version": "3.1.5-rc.1",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Accessibility",
   "files": [
@@ -51,8 +51,8 @@
     "indent": 4
   },
   "dependencies": {
-    "@elliemae/ds-system": "3.1.4-rc.2",
-    "@elliemae/ds-utilities": "3.1.4-rc.2"
+    "@elliemae/ds-system": "3.1.5-rc.1",
+    "@elliemae/ds-utilities": "3.1.5-rc.1"
   },
   "devDependencies": {
     "styled-components": "~5.3.3"