@procore/core-react 12.6.0 → 12.8.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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L39"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L45"
       },
       {
         "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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L40"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L46"
       },
       {
         "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>.</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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L50"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L56"
       },
       {
         "name": "aria-labelledby",
@@ -42,7 +42,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>.</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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L45"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L51"
       },
       {
         "name": "children",
@@ -52,7 +52,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/b1bd6be/packages/core-react/src/_utils/types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -62,7 +62,19 @@
         "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/b1bd6be/packages/core-react/src/_utils/types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/_utils/types.ts#L47"
+      },
+      {
+        "name": "compact",
+        "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>deprecated</dt><dd><p>@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY</p>\n</dd><dt>defaultvalue</dt><dd><p>false</p>\n</dd><dt>since</dt><dd><p>12.8.0</p>\n</dd></dl></div>",
+        "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/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L62"
       },
       {
         "name": "headline",
@@ -72,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L117"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L135"
       },
       {
         "name": "howToClose",
@@ -83,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L60"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L72"
       },
       {
         "name": "id",
@@ -93,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L64"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L76"
       },
       {
         "name": "open",
@@ -104,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L82"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L94"
       },
       {
         "name": "placement",
@@ -115,7 +127,7 @@
         "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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L92"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L104"
       },
       {
         "name": "role",
@@ -125,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L86"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L98"
       },
       {
         "name": "style",
@@ -135,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/b1bd6be/packages/core-react/src/_utils/types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "width",
@@ -145,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L98"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L110"
       },
       {
         "name": "onClickOverlay",
@@ -155,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L69"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L81"
       },
       {
         "name": "onClose",
@@ -165,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L123"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L141"
       }
     ],
     "description": ""
@@ -173,6 +185,18 @@
   "ModalBodyProps": {
     "name": "ModalBodyProps",
     "properties": [
+      {
+        "name": "compact",
+        "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>deprecated</dt><dd><p>@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY</p>\n</dd><dt>defaultvalue</dt><dd><p>false</p>\n</dd><dt>since</dt><dd><p>12.8.0</p>\n</dd></dl></div>",
+        "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/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L165"
+      },
       {
         "name": "noSideSpacing",
         "required": false,
@@ -182,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L147"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L171"
       }
     ],
     "description": ""
@@ -198,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L30"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L30"
       },
       {
         "name": "onClose",
@@ -208,7 +232,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L31"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L31"
       }
     ],
     "description": ""
@@ -216,6 +240,18 @@
   "ModalCloseableHeaderProps": {
     "name": "ModalCloseableHeaderProps",
     "properties": [
+      {
+        "name": "compact",
+        "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>deprecated</dt><dd><p>@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY</p>\n</dd><dt>defaultvalue</dt><dd><p>false</p>\n</dd><dt>since</dt><dd><p>12.8.0</p>\n</dd></dl></div>",
+        "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/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L40"
+      },
       {
         "name": "qa",
         "required": false,
@@ -224,7 +260,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L35"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L41"
       },
       {
         "name": "onClose",
@@ -234,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L134"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L152"
       }
     ],
     "description": ""
@@ -250,7 +286,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/b1bd6be/packages/core-react/src/_utils/types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -260,7 +296,19 @@
         "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/b1bd6be/packages/core-react/src/_utils/types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/_utils/types.ts#L47"
+      },
+      {
+        "name": "compact",
+        "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>deprecated</dt><dd><p>@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY</p>\n</dd><dt>defaultvalue</dt><dd><p>false</p>\n</dd><dt>since</dt><dd><p>12.8.0</p>\n</dd></dl></div>",
+        "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/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L119"
       },
       {
         "name": "placement",
@@ -270,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L105"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L123"
       },
       {
         "name": "style",
@@ -280,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/b1bd6be/packages/core-react/src/_utils/types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "width",
@@ -290,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L109"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L127"
       }
     ],
     "description": ""
@@ -306,7 +354,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L39"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L45"
       },
       {
         "name": "aria-details",
@@ -316,7 +364,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/Modal/Modal.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L40"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L46"
       },
       {
         "name": "aria-label",
@@ -327,7 +375,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>.</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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L50"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L56"
       },
       {
         "name": "aria-labelledby",
@@ -338,7 +386,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>.</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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L45"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L51"
       },
       {
         "name": "children",
@@ -348,7 +396,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/b1bd6be/packages/core-react/src/_utils/types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -358,7 +406,19 @@
         "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/b1bd6be/packages/core-react/src/_utils/types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/_utils/types.ts#L47"
+      },
+      {
+        "name": "compact",
+        "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>deprecated</dt><dd><p>@experimental Changes the UI of modal to work on mobile breakpoints, to be used on Helix Header ONLY</p>\n</dd><dt>defaultvalue</dt><dd><p>false</p>\n</dd><dt>since</dt><dd><p>12.8.0</p>\n</dd></dl></div>",
+        "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/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L62"
       },
       {
         "name": "howToClose",
@@ -369,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L60"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L72"
       },
       {
         "name": "id",
@@ -379,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L64"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L76"
       },
       {
         "name": "onClose",
@@ -390,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L76"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L88"
       },
       {
         "name": "open",
@@ -401,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L82"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L94"
       },
       {
         "name": "placement",
@@ -412,7 +472,7 @@
         "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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L92"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L104"
       },
       {
         "name": "role",
@@ -422,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L86"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L98"
       },
       {
         "name": "style",
@@ -432,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/b1bd6be/packages/core-react/src/_utils/types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "width",
@@ -442,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L98"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L110"
       },
       {
         "name": "onClickOverlay",
@@ -452,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/b1bd6be/packages/core-react/src/Modal/Modal.types.ts#L69"
+        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Modal/Modal.types.ts#L81"
       }
     ],
     "description": ""