@procore/core-react 12.25.1 → 12.26.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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L45"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L46"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L47"
       },
       {
         "name": "aria-label",
@@ -28,10 +28,10 @@
         "type": "<span class=\"tsd-signature-type\">string</span>",
         "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
         "description": "",
-        "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>.</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`.",
+        "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L56"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L59"
       },
       {
         "name": "aria-labelledby",
@@ -39,10 +39,10 @@
         "type": "<span class=\"tsd-signature-type\">string</span>",
         "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
         "description": "",
-        "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>.</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`.",
+        "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L51"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L52"
       },
       {
         "name": "children",
@@ -52,7 +52,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/18f5833/packages/core-react/src/_utils/types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -62,7 +62,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/18f5833/packages/core-react/src/_utils/types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/_utils/types.ts#L47"
       },
       {
         "name": "compact",
@@ -74,7 +74,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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L62"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L65"
       },
       {
         "name": "headline",
@@ -84,7 +84,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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L137"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L140"
       },
       {
         "name": "howToClose",
@@ -95,7 +95,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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L72"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L75"
       },
       {
         "name": "id",
@@ -105,7 +105,7 @@
         "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L76"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L79"
       },
       {
         "name": "open",
@@ -116,7 +116,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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L94"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L97"
       },
       {
         "name": "placement",
@@ -127,7 +127,7 @@
         "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L106"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L109"
       },
       {
         "name": "role",
@@ -137,7 +137,7 @@
         "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L98"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L101"
       },
       {
         "name": "style",
@@ -147,7 +147,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/18f5833/packages/core-react/src/_utils/types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "width",
@@ -157,7 +157,7 @@
         "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L112"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L115"
       },
       {
         "name": "onClickOverlay",
@@ -167,7 +167,7 @@
         "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L81"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L84"
       },
       {
         "name": "onClose",
@@ -177,7 +177,7 @@
         "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>",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/18f5833/packages/core-react/src/Modal/Modal.types.ts#L143"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L146"
       }
     ],
     "description": ""
@@ -195,7 +195,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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L167"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L170"
       },
       {
         "name": "noSideSpacing",
@@ -206,7 +206,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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L173"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L176"
       }
     ],
     "description": ""
@@ -222,7 +222,7 @@
         "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L30"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L30"
       },
       {
         "name": "onClose",
@@ -232,7 +232,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/18f5833/packages/core-react/src/Modal/Modal.types.ts#L31"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L31"
       }
     ],
     "description": ""
@@ -250,7 +250,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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L40"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L41"
       },
       {
         "name": "qa",
@@ -260,7 +260,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/18f5833/packages/core-react/src/Modal/Modal.types.ts#L41"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L42"
       },
       {
         "name": "onClose",
@@ -270,7 +270,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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L154"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L157"
       }
     ],
     "description": ""
@@ -286,7 +286,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/18f5833/packages/core-react/src/_utils/types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -296,7 +296,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/18f5833/packages/core-react/src/_utils/types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/_utils/types.ts#L47"
       },
       {
         "name": "compact",
@@ -308,7 +308,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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L121"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L124"
       },
       {
         "name": "placement",
@@ -318,7 +318,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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L125"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L128"
       },
       {
         "name": "style",
@@ -328,7 +328,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/18f5833/packages/core-react/src/_utils/types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "width",
@@ -338,7 +338,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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L129"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L132"
       }
     ],
     "description": ""
@@ -354,7 +354,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/18f5833/packages/core-react/src/Modal/Modal.types.ts#L45"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L46"
       },
       {
         "name": "aria-details",
@@ -364,7 +364,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/18f5833/packages/core-react/src/Modal/Modal.types.ts#L46"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L47"
       },
       {
         "name": "aria-label",
@@ -372,10 +372,10 @@
         "type": "<span class=\"tsd-signature-type\">string</span>",
         "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
         "description": "",
-        "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>.</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`.",
+        "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L56"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L59"
       },
       {
         "name": "aria-labelledby",
@@ -383,10 +383,10 @@
         "type": "<span class=\"tsd-signature-type\">string</span>",
         "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
         "description": "",
-        "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>.</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`.",
+        "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L51"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L52"
       },
       {
         "name": "children",
@@ -396,7 +396,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/18f5833/packages/core-react/src/_utils/types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -406,7 +406,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/18f5833/packages/core-react/src/_utils/types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/_utils/types.ts#L47"
       },
       {
         "name": "compact",
@@ -418,7 +418,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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L62"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L65"
       },
       {
         "name": "howToClose",
@@ -429,7 +429,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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L72"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L75"
       },
       {
         "name": "id",
@@ -439,7 +439,7 @@
         "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L76"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L79"
       },
       {
         "name": "onClose",
@@ -450,7 +450,7 @@
         "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L88"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L91"
       },
       {
         "name": "open",
@@ -461,7 +461,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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L94"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L97"
       },
       {
         "name": "placement",
@@ -472,7 +472,7 @@
         "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L106"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L109"
       },
       {
         "name": "role",
@@ -482,7 +482,7 @@
         "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L98"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L101"
       },
       {
         "name": "style",
@@ -492,7 +492,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/18f5833/packages/core-react/src/_utils/types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "width",
@@ -502,7 +502,7 @@
         "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L112"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L115"
       },
       {
         "name": "onClickOverlay",
@@ -512,7 +512,7 @@
         "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/18f5833/packages/core-react/src/Modal/Modal.types.ts#L81"
+        "sourceUrl": "https://github.com/procore/core/blob/e73c468/packages/core-react/src/Modal/Modal.types.ts#L84"
       }
     ],
     "description": ""