@procore/core-react 12.8.0 → 12.9.0

package/dist/_typedoc/Panel/Panel.types.json

@@ -10,7 +10,7 @@
         "description": "Applies the gray secondary background color.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Applies the gray secondary background color.</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/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Panel/Panel.types.ts#L58"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Panel/Panel.types.ts#L58"
       }
     ],
     "description": ""
@@ -26,7 +26,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/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Panel/Panel.types.ts#L65"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Panel/Panel.types.ts#L65"
       },
       {
         "name": "setIsFooterSticky",
@@ -36,7 +36,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/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Panel/Panel.types.ts#L69"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Panel/Panel.types.ts#L69"
       }
     ],
     "description": ""
@@ -52,7 +52,7 @@
         "description": "Sets the button to be 100% of the width of its parent",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Sets the button to be 100% of the width of its parent</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/Button/Button.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Button/Button.types.ts#L18"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Button/Button.types.ts#L19"
       },
       {
         "name": "icon",
@@ -62,7 +62,7 @@
         "description": "string icons have been deprecated, please pass a component from `@procore/core-icons`\nThe icon to display on the left side of the label",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>string icons have been deprecated, please pass a component from <code>@procore/core-icons</code>\nThe icon to display on the left side of the label</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/Button/Button.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Button/Button.types.ts#L24"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Button/Button.types.ts#L25"
       },
       {
         "name": "iconRight",
@@ -72,7 +72,7 @@
         "description": "The icon to display on the right side of the label",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The icon to display on the right side of the label</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/Button/Button.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Button/Button.types.ts#L29"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Button/Button.types.ts#L30"
       },
       {
         "name": "loading",
@@ -82,7 +82,7 @@
         "description": "Shows the button spinner",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Shows the button spinner</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/Button/Button.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Button/Button.types.ts#L34"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Button/Button.types.ts#L35"
       },
       {
         "name": "size",
@@ -92,7 +92,7 @@
         "description": "The size of the button",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The size of the button</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/Button/Button.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Button/Button.types.ts#L39"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Button/Button.types.ts#L40"
       },
       {
         "name": "title",
@@ -102,17 +102,17 @@
         "description": "Tooltip/Overflow menu label text.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Tooltip/Overflow menu label text.</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/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Panel/Panel.types.ts#L50"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Panel/Panel.types.ts#L50"
       },
       {
         "name": "variant",
         "required": false,
         "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">ButtonVariant</a>",
-        "typeDetail": "<span class=\"tsd-signature-type\">&quot;primary&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;secondary&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;tertiary&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;tertiaryContrast&quot;</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;primary&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;secondary&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;tertiary&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;tertiaryContrast&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;UNSAFE_helixNav&quot;</span>",
         "description": "The variant of the button",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The variant of the button</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.27.2</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Button/Button.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Button/Button.types.ts#L44"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Button/Button.types.ts#L45"
       }
     ],
     "description": ""
@@ -128,7 +128,7 @@
         "description": "Controls visibility and behavior for the \"chevron-left\" icon on the left\nside of the title.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Controls visibility and behavior for the &quot;chevron-left&quot; icon on the left\nside of the title.</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/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Panel/Panel.types.ts#L24"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Panel/Panel.types.ts#L24"
       },
       {
         "name": "onClose",
@@ -138,7 +138,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/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Panel/Panel.types.ts#L28"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Panel/Panel.types.ts#L28"
       }
     ],
     "description": ""
@@ -159,7 +159,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/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Panel/Panel.types.ts#L9"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Panel/Panel.types.ts#L9"
       },
       {
         "name": "title",
@@ -169,7 +169,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/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Panel/Panel.types.ts#L13"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Panel/Panel.types.ts#L13"
       }
     ],
     "description": ""
@@ -185,7 +185,7 @@
         "description": "",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>description</dt><dd><p>Actions of Buttons and Dropdowns to render. If a function,\nthe open state is provided as <code>open</code> key</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Section/Section.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Section/Section.types.ts#L17"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Section/Section.types.ts#L17"
       },
       {
         "name": "assets",
@@ -195,7 +195,17 @@
         "description": "",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>description</dt><dd><p>Title assets</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Section/Section.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Section/Section.types.ts#L39"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Section/Section.types.ts#L43"
+      },
+      {
+        "name": "banner",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "description": "",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>12.9.0</p>\n</dd></dl></div>",
+        "sourceFile": "packages/core-react/src/Section/Section.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Section/Section.types.ts#L21"
       },
       {
         "name": "children",
@@ -205,7 +215,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/_utils/types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -215,7 +225,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/27e03fe/packages/core-react/src/_utils/types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/_utils/types.ts#L47"
       },
       {
         "name": "expandId",
@@ -225,7 +235,7 @@
         "description": "",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>description</dt><dd><p>Enable the expand and collapse accordion feature.\n Requires a unique ID across sections, unique within the provider (DetailPage.Card) and\n requires a heading on the section. Closed sections will not render its children.</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Section/Section.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Section/Section.types.ts#L24"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Section/Section.types.ts#L28"
       },
       {
         "name": "heading",
@@ -235,7 +245,7 @@
         "description": "",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>description</dt><dd><p>Heading text for the section</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Section/Section.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Section/Section.types.ts#L29"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Section/Section.types.ts#L33"
       },
       {
         "name": "initialIsOpen",
@@ -245,7 +255,7 @@
         "description": "",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>description</dt><dd><p>If expandable, start open or closed</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Section/Section.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Section/Section.types.ts#L34"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Section/Section.types.ts#L38"
       },
       {
         "name": "pills",
@@ -255,7 +265,7 @@
         "description": "",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>description</dt><dd><p>Title pills</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Section/Section.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Section/Section.types.ts#L44"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Section/Section.types.ts#L48"
       },
       {
         "name": "style",
@@ -265,7 +275,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/27e03fe/packages/core-react/src/_utils/types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "subtext",
@@ -275,7 +285,7 @@
         "description": "",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>description</dt><dd><p>Title subtext</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Section/Section.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Section/Section.types.ts#L49"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Section/Section.types.ts#L53"
       }
     ],
     "description": ""
@@ -291,7 +301,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/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Panel/Panel.types.ts#L35"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Panel/Panel.types.ts#L35"
       },
       {
         "name": "isVisible",
@@ -301,7 +311,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/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Panel/Panel.types.ts#L39"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Panel/Panel.types.ts#L39"
       },
       {
         "name": "overlay",
@@ -311,7 +321,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/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Panel/Panel.types.ts#L43"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Panel/Panel.types.ts#L43"
       }
     ],
     "description": ""

package/dist/_typedoc/Pill/Pill.types.json

@@ -11,7 +11,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Controls the border, background and color of the Pill</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>gray</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "defaultValue": "gray",
         "sourceFile": "packages/core-react/src/Pill/Pill.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Pill/Pill.types.ts#L17"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Pill/Pill.types.ts#L17"
       },
       {
         "name": "onClear",
@@ -21,7 +21,7 @@
         "description": "It is possible for this component to have an empty value\n(render placeholder). Enables the x icon.\n<CodeBlock>{'(event) => {}'}</CodeBlock>",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>It is possible for this component to have an empty value\n(render placeholder). Enables the x icon.\n<CodeBlock>{&#39;(event) =&gt; {}&#39;}</CodeBlock></p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>11.13.1</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Pill/Pill.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Pill/Pill.types.ts#L24"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Pill/Pill.types.ts#L24"
       }
     ],
     "description": ""