@procore/core-react 12.41.0 → 12.43.0

package/dist/_typedoc/Modal/Modal.types.json

@@ -10,7 +10,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L46"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L46"
       },
       {
         "name": "aria-details",
@@ -20,7 +20,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L47"
       },
       {
         "name": "aria-label",
@@ -31,7 +31,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p><code>role=&#39;dialog&#39;</code> MUST be labelled. Prefer <code>aria-labelledby</code> over <code>aria-label</code>.\nIf using an <code>aria-label</code> instead of a node, be sure give the modal an <code>id</code> so\nother regions can reference it.</p>\n</dd><dt>since</dt><dd><p>11.12.0</p>\n</dd></dl></div>",
         "a11y": "`role='dialog'` MUST be labelled. Prefer `aria-labelledby` over `aria-label`.\nIf using an `aria-label` instead of a node, be sure give the modal an `id` so\nother regions can reference it.",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L59"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L59"
       },
       {
         "name": "aria-labelledby",
@@ -42,7 +42,18 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p>Automatially created when using <code>Modal.Heading</code>. The <code>role=&#39;dialog&#39;</code> MUST be labelled. Prefer <code>aria-labelledby</code> over <code>aria-label</code>.</p>\n</dd><dt>since</dt><dd><p>11.12.0</p>\n</dd></dl></div>",
         "a11y": "Automatially created when using `Modal.Heading`. The `role='dialog'` MUST be labelled. Prefer `aria-labelledby` over `aria-label`.",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L52"
+      },
+      {
+        "name": "aria-modal",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "description": "",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p>Recommended to use. When using alertdialog should be a <code>aria-modal</code> because of their urgent nature. <strong>Cannot open nested modals.</strong></p>\n</dd><dt>since</dt><dd><p>12.42.0</p>\n</dd></dl></div>",
+        "a11y": "Recommended to use. When using alertdialog should be a `aria-modal` because of their urgent nature. **Cannot open nested modals.**",
+        "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L169"
       },
       {
         "name": "children",
@@ -52,7 +63,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/_utils/types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -62,7 +73,7 @@
         "description": "Additional classNames",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div></div>",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/_utils/types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L47"
       },
       {
         "name": "compact",
@@ -74,7 +85,7 @@
         "defaultValue": "false",
         "deprecated": "@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L65"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L71"
       },
       {
         "name": "headline",
@@ -84,7 +95,7 @@
         "description": "Headline message",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Headline message</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L140"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L147"
       },
       {
         "name": "howToClose",
@@ -95,7 +106,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>This adds additional UI or UX to close. Escape key will always close a dialog, see <code>onClose</code>.</p>\n</div><div><p>NOTE &#39;footer-button&#39;: Footer Cancel button still requires at least a rendered self closing <code>Modal.FooterButtons</code>.</p>\n<p>NOTE &#39;x&#39;: The X button still requires a rendered <code>Modal.Header</code> component.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>[]</p>\n</dd><dt>since</dt><dd><p>11.12.0</p>\n</dd></dl></div>",
         "defaultValue": "[]",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L75"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L81"
       },
       {
         "name": "id",
@@ -105,7 +116,18 @@
         "description": "Aligns with `role` and `ref` location.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Aligns with <code>role</code> and <code>ref</code> location.</p>\n</div></div>",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L79"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L85"
+      },
+      {
+        "name": "onClose",
+        "required": false,
+        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalOnClose</a><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">HTMLButtonElement</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&gt;</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\"> =&gt; </span><span class=\"tsd-signature-type\">void</span><span class=\"tsd-signature-symbol\">)</span>",
+        "typeDetail": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalOnClose</a><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">HTMLButtonElement</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&gt;</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\"> =&gt; </span><span class=\"tsd-signature-type\">void</span><span class=\"tsd-signature-symbol\">)</span>",
+        "description": "Callback when the ConfirmModal is dismissed.",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback when the ConfirmModal is dismissed.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p><strong>Accessible pattern (recommended):</strong> Use with <code>role=&quot;dialog&quot;</code> and <code>howToClose={[&#39;x&#39;]}</code>.\nThis enables focus management, Escape key support, and proper dialog semantics.\nThe callback signature is <code>(event, how) =&gt; void</code>.</p>\n<p><strong>Legacy pattern:</strong> <code>(event: MouseEvent&lt;HTMLButtonElement&gt;) =&gt; void</code> — only handles X button click,\nno focus management or Escape key support.</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
+        "a11y": "**Accessible pattern (recommended):** Use with `role=\"dialog\"` and `howToClose={['x']}`.\nThis enables focus management, Escape key support, and proper dialog semantics.\nThe callback signature is `(event, how) => void`.\n\n**Legacy pattern:** `(event: MouseEvent<HTMLButtonElement>) => void` — only handles X button click,\nno focus management or Escape key support.\n",
+        "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L161"
       },
       {
         "name": "open",
@@ -116,7 +138,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Modal open state</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>false</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "defaultValue": "false",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L97"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L104"
       },
       {
         "name": "placement",
@@ -127,17 +149,17 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Vertical placement of the modal.\nPositioning modal at the top ensures that variable height modal won&#39;t shift position during content loading,\nproviding a more stable user experience.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>center</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "defaultValue": "center",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L109"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L116"
       },
       {
         "name": "role",
         "required": false,
-        "type": "<span class=\"tsd-signature-type\">&quot;dialog&quot;</span>",
-        "typeDetail": "<span class=\"tsd-signature-type\">&quot;dialog&quot;</span>",
+        "type": "<span class=\"tsd-signature-type\">&quot;dialog&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;alertdialog&quot;</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;dialog&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;alertdialog&quot;</span>",
         "description": "Enable dialog props. REQUIRES `onClose` to enable Escape key and focus management. MUST be labelled, prefer `aria-labelledby` over `aria-label`.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Enable dialog props. REQUIRES <code>onClose</code> to enable Escape key and focus management. MUST be labelled, prefer <code>aria-labelledby</code> over <code>aria-label</code>.</p>\n</div></div>",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L101"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L108"
       },
       {
         "name": "style",
@@ -147,7 +169,7 @@
         "description": "Additional CSS styles",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/_utils/types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "width",
@@ -157,27 +179,17 @@
         "description": "Sets a width on the container and uses next centering.\nFuture will default to `md`",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Sets a width on the container and uses next centering.\nFuture will default to <code>md</code></p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L115"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L122"
       },
       {
         "name": "onClickOverlay",
         "required": false,
         "type": "Function",
         "typeDetail": "on<wbr/>Click<wbr/>Overlay<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">HTMLDivElement</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&gt;</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
-        "description": "Callback for clicking the overlay",
-        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback for clicking the overlay</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
-        "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L84"
-      },
-      {
-        "name": "onClose",
-        "required": false,
-        "type": "Function",
-        "typeDetail": "on<wbr/>Close<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">HTMLButtonElement</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&gt;</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
-        "description": "The dismiss onClick callback",
-        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The dismiss onClick callback</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
+        "description": "",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>deprecated</dt><dd><p>Use <code>howToClose={[&#39;scrim&#39;]}</code> with <code>onClose</code> instead.</p>\n</dd><dt>deprecatedsince</dt><dd><p>12.41.0</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L146"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L91"
       }
     ],
     "description": ""
@@ -195,7 +207,7 @@
         "defaultValue": "false",
         "deprecated": "@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L170"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L195"
       },
       {
         "name": "noSideSpacing",
@@ -206,7 +218,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Removes left, right paddings from the modal body when true</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>false</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "defaultValue": "false",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L176"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L201"
       }
     ],
     "description": ""
@@ -222,17 +234,17 @@
         "description": "Escape key will always close a dialog. This adds additional UI or UX to close.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Escape key will always close a dialog. This adds additional UI or UX to close.</p>\n</div></div>",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L30"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L30"
       },
       {
         "name": "onClose",
         "required": true,
-        "type": "<span class=\"tsd-signature-type\">undefined</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">ModalOnClose</span>",
-        "typeDetail": "<span class=\"tsd-signature-type\">undefined</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">ModalOnClose</span>",
+        "type": "<span class=\"tsd-signature-type\">undefined</span><span class=\"tsd-signature-symbol\"> | </span><a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalOnClose</a>",
+        "typeDetail": "<span class=\"tsd-signature-type\">undefined</span><span class=\"tsd-signature-symbol\"> | </span><a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalOnClose</a>",
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L31"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L31"
       }
     ],
     "description": ""
@@ -250,7 +262,7 @@
         "defaultValue": "false",
         "deprecated": "@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L41"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L41"
       },
       {
         "name": "qa",
@@ -260,7 +272,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L42"
       },
       {
         "name": "onClose",
@@ -268,9 +280,9 @@
         "type": "Function",
         "typeDetail": "on<wbr/>Close<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">HTMLButtonElement</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&gt;</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
         "description": "",
-        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>deprecated</dt><dd><p>Use <code>Modal onClose</code> with <code>howToClose={[&#39;x&#39;]}</code> instead.</p>\n</dd><dt>deprecatedsince</dt><dd><p>12.41.0</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L157"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L182"
       }
     ],
     "description": ""
@@ -286,7 +298,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/_utils/types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -296,7 +308,7 @@
         "description": "Additional classNames",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div></div>",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/_utils/types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L47"
       },
       {
         "name": "compact",
@@ -308,7 +320,7 @@
         "defaultValue": "false",
         "deprecated": "@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L124"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L131"
       },
       {
         "name": "placement",
@@ -318,7 +330,7 @@
         "description": "",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L128"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L135"
       },
       {
         "name": "style",
@@ -328,7 +340,7 @@
         "description": "Additional CSS styles",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/_utils/types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "width",
@@ -338,7 +350,7 @@
         "description": "",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L132"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L139"
       }
     ],
     "description": ""
@@ -354,7 +366,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L46"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L46"
       },
       {
         "name": "aria-details",
@@ -364,7 +376,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L47"
       },
       {
         "name": "aria-label",
@@ -375,7 +387,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p><code>role=&#39;dialog&#39;</code> MUST be labelled. Prefer <code>aria-labelledby</code> over <code>aria-label</code>.\nIf using an <code>aria-label</code> instead of a node, be sure give the modal an <code>id</code> so\nother regions can reference it.</p>\n</dd><dt>since</dt><dd><p>11.12.0</p>\n</dd></dl></div>",
         "a11y": "`role='dialog'` MUST be labelled. Prefer `aria-labelledby` over `aria-label`.\nIf using an `aria-label` instead of a node, be sure give the modal an `id` so\nother regions can reference it.",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L59"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L59"
       },
       {
         "name": "aria-labelledby",
@@ -386,7 +398,18 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p>Automatially created when using <code>Modal.Heading</code>. The <code>role=&#39;dialog&#39;</code> MUST be labelled. Prefer <code>aria-labelledby</code> over <code>aria-label</code>.</p>\n</dd><dt>since</dt><dd><p>11.12.0</p>\n</dd></dl></div>",
         "a11y": "Automatially created when using `Modal.Heading`. The `role='dialog'` MUST be labelled. Prefer `aria-labelledby` over `aria-label`.",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L52"
+      },
+      {
+        "name": "aria-modal",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "description": "",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p>Should be used for a single true modal. Cannot open nested modals.</p>\n</dd><dt>experimental</dt><dd><p>Core-React does not support multiple or nested <code>aria-modal</code>s for Tearsheets, Modals, or ConfirmModals.</p>\n</dd><dt>since</dt><dd><p>12.42.0</p>\n</dd></dl></div>",
+        "a11y": "Should be used for a single true modal. Cannot open nested modals.",
+        "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L65"
       },
       {
         "name": "children",
@@ -396,7 +419,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/_utils/types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -406,7 +429,7 @@
         "description": "Additional classNames",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div></div>",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/_utils/types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L47"
       },
       {
         "name": "compact",
@@ -418,7 +441,7 @@
         "defaultValue": "false",
         "deprecated": "@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L65"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L71"
       },
       {
         "name": "howToClose",
@@ -429,7 +452,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>This adds additional UI or UX to close. Escape key will always close a dialog, see <code>onClose</code>.</p>\n</div><div><p>NOTE &#39;footer-button&#39;: Footer Cancel button still requires at least a rendered self closing <code>Modal.FooterButtons</code>.</p>\n<p>NOTE &#39;x&#39;: The X button still requires a rendered <code>Modal.Header</code> component.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>[]</p>\n</dd><dt>since</dt><dd><p>11.12.0</p>\n</dd></dl></div>",
         "defaultValue": "[]",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L75"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L81"
       },
       {
         "name": "id",
@@ -439,18 +462,18 @@
         "description": "Aligns with `role` and `ref` location.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Aligns with <code>role</code> and <code>ref</code> location.</p>\n</div></div>",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L79"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L85"
       },
       {
         "name": "onClose",
         "required": false,
-        "type": "<span class=\"tsd-signature-type\">ModalOnClose</span>",
-        "typeDetail": "<span class=\"tsd-signature-type\">ModalOnClose</span>",
+        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalOnClose</a>",
+        "typeDetail": "<span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">React.MouseEvent</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">HTMLDivElement</span><span class=\"tsd-signature-symbol\">&gt;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">React.MouseEvent</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">HTMLButtonElement</span><span class=\"tsd-signature-symbol\">&gt;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">React.KeyboardEvent</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">HTMLElement</span><span class=\"tsd-signature-symbol\">&gt;</span>, how<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">ModalCloseStragety</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\"> =&gt; </span><span class=\"tsd-signature-type\">void</span><span class=\"tsd-signature-symbol\">)</span>",
         "description": "When a user closes the Modal by some approved `howToClose` method or the Escape key. This also opts-in to dialog focus management.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>When a user closes the Modal by some approved <code>howToClose</code> method or the Escape key. This also opts-in to dialog focus management.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p>Future default! Moves focus into and cycles focus in the Modal, and returning focus\nto the trigger when closed. Also enables the Escape key to close the Modal.</p>\n</dd><dt>since</dt><dd><p>11.6.0</p>\n</dd></dl></div>",
         "a11y": "Future default! Moves focus into and cycles focus in the Modal, and returning focus\nto the trigger when closed. Also enables the Escape key to close the Modal.",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L91"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L98"
       },
       {
         "name": "open",
@@ -461,7 +484,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Modal open state</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>false</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "defaultValue": "false",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L97"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L104"
       },
       {
         "name": "placement",
@@ -472,17 +495,17 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Vertical placement of the modal.\nPositioning modal at the top ensures that variable height modal won&#39;t shift position during content loading,\nproviding a more stable user experience.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>center</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "defaultValue": "center",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L109"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L116"
       },
       {
         "name": "role",
         "required": false,
-        "type": "<span class=\"tsd-signature-type\">&quot;dialog&quot;</span>",
-        "typeDetail": "<span class=\"tsd-signature-type\">&quot;dialog&quot;</span>",
+        "type": "<span class=\"tsd-signature-type\">&quot;dialog&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;alertdialog&quot;</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;dialog&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;alertdialog&quot;</span>",
         "description": "Enable dialog props. REQUIRES `onClose` to enable Escape key and focus management. MUST be labelled, prefer `aria-labelledby` over `aria-label`.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Enable dialog props. REQUIRES <code>onClose</code> to enable Escape key and focus management. MUST be labelled, prefer <code>aria-labelledby</code> over <code>aria-label</code>.</p>\n</div></div>",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L101"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L108"
       },
       {
         "name": "style",
@@ -492,7 +515,7 @@
         "description": "Additional CSS styles",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div></div>",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/_utils/types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "width",
@@ -502,21 +525,26 @@
         "description": "Sets a width on the container and uses next centering.\nFuture will default to `md`",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Sets a width on the container and uses next centering.\nFuture will default to <code>md</code></p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L115"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L122"
       },
       {
         "name": "onClickOverlay",
         "required": false,
         "type": "Function",
         "typeDetail": "on<wbr/>Click<wbr/>Overlay<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">HTMLDivElement</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">MouseEvent</span><span class=\"tsd-signature-symbol\">&gt;</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
-        "description": "Callback for clicking the overlay",
-        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback for clicking the overlay</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
+        "description": "",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>deprecated</dt><dd><p>Use <code>howToClose={[&#39;scrim&#39;]}</code> with <code>onClose</code> instead.</p>\n</dd><dt>deprecatedsince</dt><dd><p>12.41.0</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/aa49c09/packages/core-react/src/Modal/Modal.types.ts#L84"
+        "sourceUrl": "https://github.com/procore/core/blob/a16208b/packages/core-react/src/Modal/Modal.types.ts#L91"
       }
     ],
     "description": ""
   },
+  "ModalOnClose": {
+    "name": "ModalOnClose",
+    "properties": [],
+    "description": ""
+  },
   "ModalOptionalCloseStartegy": {
     "name": "ModalOptionalCloseStartegy",
     "properties": [],