@procore/core-react 11.12.1 → 11.13.0-rc.0

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

@@ -2,15 +2,57 @@
   "ConfirmModalProps": {
     "name": "ConfirmModalProps",
     "properties": [
+      {
+        "name": "aria-describedby",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "description": "",
+        "descriptionHtml": "",
+        "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L39"
+      },
+      {
+        "name": "aria-details",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "description": "",
+        "descriptionHtml": "",
+        "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L40"
+      },
+      {
+        "name": "aria-label",
+        "required": false,
+        "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`.",
+        "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L50"
+      },
+      {
+        "name": "aria-labelledby",
+        "required": false,
+        "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`.",
+        "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L45"
+      },
       {
         "name": "children",
         "required": false,
         "type": "<span class=\"tsd-signature-type\">ReactNode</span>",
         "typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
-        "description": "Instead of using the default children, you can pass in your own.",
-        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Instead of using the default children, you can pass in your own.</p>\n</div></div>",
+        "description": "",
+        "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/579e2b7a4/packages/core-react/src/_utils/types.ts#L45"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -20,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/579e2b7a4/packages/core-react/src/_utils/types.ts#L50"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/_utils/types.ts#L47"
       },
       {
         "name": "headline",
@@ -30,7 +72,28 @@
         "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/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L56"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L117"
+      },
+      {
+        "name": "howToClose",
+        "required": false,
+        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalOptionalCloseStartegy</a><span class=\"tsd-signature-symbol\">[]</span>",
+        "typeDetail": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalOptionalCloseStartegy</a><span class=\"tsd-signature-symbol\">[]</span>",
+        "description": "This adds additional UI or UX to close. Escape key will always close a dialog, see `onClose`.",
+        "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/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L60"
+      },
+      {
+        "name": "id",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "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/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L64"
       },
       {
         "name": "open",
@@ -41,7 +104,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/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L25"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L82"
       },
       {
         "name": "placement",
@@ -52,7 +115,17 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Vertical placement of the modal</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/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L31"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L92"
+      },
+      {
+        "name": "role",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">&quot;dialog&quot;</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;dialog&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/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L86"
       },
       {
         "name": "style",
@@ -62,7 +135,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/579e2b7a4/packages/core-react/src/_utils/types.ts#L55"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "width",
@@ -72,7 +145,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/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L37"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L98"
       },
       {
         "name": "onClickOverlay",
@@ -82,7 +155,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/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L12"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L69"
       },
       {
         "name": "onClose",
@@ -92,7 +165,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/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L62"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L123"
       }
     ],
     "description": ""
@@ -109,53 +182,49 @@
         "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/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L82"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L147"
       }
     ],
     "description": ""
   },
-  "ModalCloseableHeaderProps": {
-    "name": "ModalCloseableHeaderProps",
+  "ModalCloseContextApi": {
+    "name": "ModalCloseContextApi",
     "properties": [
       {
-        "name": "children",
-        "required": false,
-        "type": "<span class=\"tsd-signature-type\">ReactNode</span>",
-        "typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
-        "description": "Instead of using the default children, you can pass in your own.",
-        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Instead of using the default children, you can pass in your own.</p>\n</div></div>",
-        "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/579e2b7a4/packages/core-react/src/_utils/types.ts#L45"
+        "name": "howToClose",
+        "required": true,
+        "type": "<span class=\"tsd-signature-type\">undefined</span><span class=\"tsd-signature-symbol\"> | </span><a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalOptionalCloseStartegy</a><span class=\"tsd-signature-symbol\">[]</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">undefined</span><span class=\"tsd-signature-symbol\"> | </span><a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalOptionalCloseStartegy</a><span class=\"tsd-signature-symbol\">[]</span>",
+        "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/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L30"
       },
       {
-        "name": "className",
-        "required": false,
-        "type": "<span class=\"tsd-signature-type\">string</span>",
-        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
-        "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/579e2b7a4/packages/core-react/src/_utils/types.ts#L50"
-      },
+        "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>",
+        "description": "",
+        "descriptionHtml": "",
+        "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L31"
+      }
+    ],
+    "description": ""
+  },
+  "ModalCloseableHeaderProps": {
+    "name": "ModalCloseableHeaderProps",
+    "properties": [
       {
         "name": "qa",
         "required": false,
         "type": "<span class=\"tsd-signature-symbol\">{ </span>closeButton<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> }</span>",
         "typeDetail": "<span class=\"tsd-signature-symbol\">{ </span>closeButton<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> }</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": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L73"
-      },
-      {
-        "name": "style",
-        "required": false,
-        "type": "<span class=\"tsd-signature-type\">CSSProperties</span>",
-        "typeDetail": "<span class=\"tsd-signature-type\">CSSProperties</span>",
-        "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/579e2b7a4/packages/core-react/src/_utils/types.ts#L55"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L35"
       },
       {
         "name": "onClose",
@@ -165,7 +234,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/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L69"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L134"
       }
     ],
     "description": ""
@@ -178,10 +247,10 @@
         "required": false,
         "type": "<span class=\"tsd-signature-type\">ReactNode</span>",
         "typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
-        "description": "Instead of using the default children, you can pass in your own.",
-        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Instead of using the default children, you can pass in your own.</p>\n</div></div>",
+        "description": "",
+        "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/579e2b7a4/packages/core-react/src/_utils/types.ts#L45"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -191,7 +260,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/579e2b7a4/packages/core-react/src/_utils/types.ts#L50"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/_utils/types.ts#L47"
       },
       {
         "name": "placement",
@@ -201,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/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L44"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L105"
       },
       {
         "name": "style",
@@ -211,7 +280,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/579e2b7a4/packages/core-react/src/_utils/types.ts#L55"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "width",
@@ -221,7 +290,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/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L48"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L109"
       }
     ],
     "description": ""
@@ -229,15 +298,57 @@
   "ModalProps": {
     "name": "ModalProps",
     "properties": [
+      {
+        "name": "aria-describedby",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "description": "",
+        "descriptionHtml": "",
+        "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L39"
+      },
+      {
+        "name": "aria-details",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "description": "",
+        "descriptionHtml": "",
+        "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L40"
+      },
+      {
+        "name": "aria-label",
+        "required": false,
+        "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`.",
+        "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L50"
+      },
+      {
+        "name": "aria-labelledby",
+        "required": false,
+        "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`.",
+        "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L45"
+      },
       {
         "name": "children",
         "required": false,
         "type": "<span class=\"tsd-signature-type\">ReactNode</span>",
         "typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
-        "description": "Instead of using the default children, you can pass in your own.",
-        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Instead of using the default children, you can pass in your own.</p>\n</div></div>",
+        "description": "",
+        "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/579e2b7a4/packages/core-react/src/_utils/types.ts#L45"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -247,7 +358,39 @@
         "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/579e2b7a4/packages/core-react/src/_utils/types.ts#L50"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/_utils/types.ts#L47"
+      },
+      {
+        "name": "howToClose",
+        "required": false,
+        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalOptionalCloseStartegy</a><span class=\"tsd-signature-symbol\">[]</span>",
+        "typeDetail": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ModalOptionalCloseStartegy</a><span class=\"tsd-signature-symbol\">[]</span>",
+        "description": "This adds additional UI or UX to close. Escape key will always close a dialog, see `onClose`.",
+        "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/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L60"
+      },
+      {
+        "name": "id",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "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/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L64"
+      },
+      {
+        "name": "onClose",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">ModalOnClose</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">ModalOnClose</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/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L76"
       },
       {
         "name": "open",
@@ -258,7 +401,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/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L25"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L82"
       },
       {
         "name": "placement",
@@ -269,7 +412,17 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Vertical placement of the modal</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/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L31"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L92"
+      },
+      {
+        "name": "role",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">&quot;dialog&quot;</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;dialog&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/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L86"
       },
       {
         "name": "style",
@@ -279,7 +432,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/579e2b7a4/packages/core-react/src/_utils/types.ts#L55"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "width",
@@ -289,7 +442,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/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L37"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L98"
       },
       {
         "name": "onClickOverlay",
@@ -299,17 +452,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/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L12"
-      },
-      {
-        "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\">KeyboardEvent</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-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
-        "description": "Dismiss onClick callback to enable focus management and Escape key to close",
-        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Dismiss onClick callback to enable focus management and Escape key to close</p>\n</div><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p>Moves focus into and cycles focus in the Modal, abd 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>",
-        "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/579e2b7a4/packages/core-react/src/Modal/Modal.types.ts#L19"
+        "sourceUrl": "https://github.com/procore/core/blob/fbd7c364a/packages/core-react/src/Modal/Modal.types.ts#L69"
       }
     ],
     "description": ""