@procore/core-react 12.44.0 → 12.46.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/0ec588e/packages/core-react/src/Panel/Panel.types.ts#L50"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Panel/Panel.types.ts#L50"
       }
     ],
     "description": ""
@@ -26,7 +26,7 @@
         "description": "",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>12.24.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/0ec588e/packages/core-react/src/Panel/Panel.types.ts#L57"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Panel/Panel.types.ts#L57"
       },
       {
         "name": "isScrolling",
@@ -36,7 +36,7 @@
         "description": "",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>12.11.2</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/0ec588e/packages/core-react/src/Panel/Panel.types.ts#L61"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Panel/Panel.types.ts#L61"
       },
       {
         "name": "setIsScrolling",
@@ -46,7 +46,7 @@
         "description": "",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>12.11.2</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/0ec588e/packages/core-react/src/Panel/Panel.types.ts#L65"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Panel/Panel.types.ts#L65"
       }
     ],
     "description": ""
@@ -54,6 +54,17 @@
   "PanelHeaderActionProps": {
     "name": "PanelHeaderActionProps",
     "properties": [
+      {
+        "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>Icon-only buttons must have an accessible name.\nAdd an <code>aria-label</code> or <code>aria-labelledby</code> prop to describe the button&#39;s purpose.</p>\n</dd></dl></div>",
+        "a11y": "Icon-only buttons must have an accessible name.\nAdd an `aria-label` or `aria-labelledby` prop to describe the button's purpose.\n",
+        "sourceFile": "packages/core-react/src/Button/Button.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Button/Button.types.ts#L20"
+      },
       {
         "name": "block",
         "required": false,
@@ -62,7 +73,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/0ec588e/packages/core-react/src/Button/Button.types.ts#L20"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Button/Button.types.ts#L25"
       },
       {
         "name": "icon",
@@ -72,7 +83,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/0ec588e/packages/core-react/src/Button/Button.types.ts#L26"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Button/Button.types.ts#L31"
       },
       {
         "name": "iconRight",
@@ -84,7 +95,7 @@
         "deprecated": "iconRight has been deprecated and will be removed in a future version\n",
         "deprecatedSince": "12.18.0",
         "sourceFile": "packages/core-react/src/Button/Button.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/0ec588e/packages/core-react/src/Button/Button.types.ts#L33"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Button/Button.types.ts#L38"
       },
       {
         "name": "loading",
@@ -94,7 +105,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/0ec588e/packages/core-react/src/Button/Button.types.ts#L38"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Button/Button.types.ts#L43"
       },
       {
         "name": "size",
@@ -104,7 +115,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/0ec588e/packages/core-react/src/Button/Button.types.ts#L43"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Button/Button.types.ts#L48"
       },
       {
         "name": "title",
@@ -114,7 +125,7 @@
         "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/0ec588e/packages/core-react/src/Panel/Panel.types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Panel/Panel.types.ts#L42"
       },
       {
         "name": "variant",
@@ -124,7 +135,7 @@
         "description": "The variant of the button.\n@ deprecated variant \"tertiaryContrast\" has been deprecated since 12.18.0\nand will be removed in a future version",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The variant of the button.\n@ deprecated variant &quot;tertiaryContrast&quot; has been deprecated since 12.18.0\nand will be removed in a future version</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/0ec588e/packages/core-react/src/Button/Button.types.ts#L50"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Button/Button.types.ts#L55"
       }
     ],
     "description": ""
@@ -140,7 +151,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/0ec588e/packages/core-react/src/Panel/Panel.types.ts#L30"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Panel/Panel.types.ts#L30"
       },
       {
         "name": "onClose",
@@ -150,7 +161,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/0ec588e/packages/core-react/src/Panel/Panel.types.ts#L34"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Panel/Panel.types.ts#L34"
       }
     ],
     "description": ""
@@ -167,7 +178,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p><code>role=&#39;region&#39;</code> should be labelled. It uses the panel&#39;s title as a label by default.\nThis is an optional prop to specify a custom label if needed.</p>\n</dd><dt>since</dt><dd><p>12.24.0</p>\n</dd></dl></div>",
         "a11y": "`role='region'` should be labelled. It uses the panel's title as a label by default.\nThis is an optional prop to specify a custom label if needed.",
         "sourceFile": "packages/core-react/src/Panel/Panel.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/0ec588e/packages/core-react/src/Panel/Panel.types.ts#L21"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Panel/Panel.types.ts#L21"
       }
     ],
     "description": ""
@@ -183,7 +194,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/0ec588e/packages/core-react/src/Panel/Panel.types.ts#L8"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Panel/Panel.types.ts#L8"
       },
       {
         "name": "title",
@@ -193,7 +204,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/0ec588e/packages/core-react/src/Panel/Panel.types.ts#L12"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Panel/Panel.types.ts#L12"
       }
     ],
     "description": ""
@@ -209,7 +220,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/0ec588e/packages/core-react/src/Section/Section.types.ts#L17"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Section/Section.types.ts#L17"
       },
       {
         "name": "assets",
@@ -219,7 +230,7 @@
         "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/0ec588e/packages/core-react/src/Section/Section.types.ts#L43"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Section/Section.types.ts#L43"
       },
       {
         "name": "banner",
@@ -229,7 +240,7 @@
         "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/0ec588e/packages/core-react/src/Section/Section.types.ts#L21"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Section/Section.types.ts#L21"
       },
       {
         "name": "children",
@@ -239,7 +250,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/0ec588e/packages/core-react/src/_utils/types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -249,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/0ec588e/packages/core-react/src/_utils/types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/_utils/types.ts#L47"
       },
       {
         "name": "expandId",
@@ -259,7 +270,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/0ec588e/packages/core-react/src/Section/Section.types.ts#L28"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Section/Section.types.ts#L28"
       },
       {
         "name": "heading",
@@ -269,7 +280,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/0ec588e/packages/core-react/src/Section/Section.types.ts#L33"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Section/Section.types.ts#L33"
       },
       {
         "name": "initialIsOpen",
@@ -279,7 +290,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/0ec588e/packages/core-react/src/Section/Section.types.ts#L38"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Section/Section.types.ts#L38"
       },
       {
         "name": "pills",
@@ -289,7 +300,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/0ec588e/packages/core-react/src/Section/Section.types.ts#L48"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Section/Section.types.ts#L48"
       },
       {
         "name": "style",
@@ -299,7 +310,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/0ec588e/packages/core-react/src/_utils/types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "subtext",
@@ -309,7 +320,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/0ec588e/packages/core-react/src/Section/Section.types.ts#L53"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Section/Section.types.ts#L53"
       }
     ],
     "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/0ec588e/packages/core-react/src/Pill/Pill.types.ts#L17"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/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```\n(event) => {}\n```",
         "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.</p>\n<pre><code>(event) =&gt; {}\n</code></pre>\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/0ec588e/packages/core-react/src/Pill/Pill.types.ts#L26"
+        "sourceUrl": "https://github.com/procore/core/blob/9e2406a/packages/core-react/src/Pill/Pill.types.ts#L26"
       }
     ],
     "description": ""