@procore/core-react 12.44.0 → 12.45.0

package/dist/_typedoc/Breadcrumbs/Breadcrumbs.types.json

@@ -10,7 +10,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/Breadcrumbs/Breadcrumbs.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/0ec588e/packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts#L33"
+        "sourceUrl": "https://github.com/procore/core/blob/46e67ee/packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts#L33"
       },
       {
         "name": "children",
@@ -20,7 +20,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/46e67ee/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -30,7 +30,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/46e67ee/packages/core-react/src/_utils/types.ts#L47"
       },
       {
         "name": "isLast",
@@ -40,7 +40,7 @@
         "description": "",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>11.6.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/0ec588e/packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts#L37"
+        "sourceUrl": "https://github.com/procore/core/blob/46e67ee/packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts#L37"
       },
       {
         "name": "style",
@@ -50,7 +50,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/46e67ee/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "variant",
@@ -61,7 +61,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>deprecated</dt><dd><p>Handled by parent prop. Use <code>Breadcrumb variant=&quot;list&quot;</code> with anchors INSIDE <code>Breadcumb.Crumb</code>.</p>\n</dd><dt>since</dt><dd><p>11.6.0</p>\n</dd></dl></div>",
         "deprecated": "Handled by parent prop. Use `Breadcrumb variant=\"list\"` with anchors INSIDE `Breadcumb.Crumb`.",
         "sourceFile": "packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/0ec588e/packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/46e67ee/packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts#L42"
       }
     ],
     "description": ""
@@ -77,7 +77,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/46e67ee/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -87,7 +87,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/46e67ee/packages/core-react/src/_utils/types.ts#L47"
       },
       {
         "name": "style",
@@ -97,7 +97,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/46e67ee/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "variant",
@@ -108,7 +108,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>a11y</dt><dd><p>Set <code>variant=&quot;list&quot;</code> to enable <code>ol</code> and <code>li</code> semantic markup with the crumbs. Add the hyperlinks <strong>inside</strong> each crumb as children.</p>\n</dd><dt>description</dt><dd><p>Enables the next version of semantic breacrumbs. Set <code>variant=&quot;list&quot;</code> and add the hyperlinks <strong>inside</strong> each crumb as children.</p>\n<p>BEFORE undefined | variant=&quot;nav&quot;, anchors outside crumb</p>\n<p>AFTER variant=&quot;list&quot;, anchors inside crumb</p>\n</dd><dt>since</dt><dd><p>11.33.0</p>\n</dd></dl></div>",
         "a11y": "Set `variant=\"list\"` to enable `ol` and `li` semantic markup with the crumbs. Add the hyperlinks **inside** each crumb as children.",
         "sourceFile": "packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/0ec588e/packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts#L26"
+        "sourceUrl": "https://github.com/procore/core/blob/46e67ee/packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts#L26"
       }
     ],
     "description": ""

package/dist/_typedoc/Button/Button.types.json

@@ -2,6 +2,17 @@
   "ButtonProps": {
     "name": "ButtonProps",
     "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/46e67ee/packages/core-react/src/Button/Button.types.ts#L20"
+      },
       {
         "name": "block",
         "required": false,
@@ -10,7 +21,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/46e67ee/packages/core-react/src/Button/Button.types.ts#L25"
       },
       {
         "name": "icon",
@@ -20,7 +31,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/46e67ee/packages/core-react/src/Button/Button.types.ts#L31"
       },
       {
         "name": "iconRight",
@@ -32,7 +43,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/46e67ee/packages/core-react/src/Button/Button.types.ts#L38"
       },
       {
         "name": "loading",
@@ -42,7 +53,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/46e67ee/packages/core-react/src/Button/Button.types.ts#L43"
       },
       {
         "name": "size",
@@ -52,7 +63,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/46e67ee/packages/core-react/src/Button/Button.types.ts#L48"
       },
       {
         "name": "variant",
@@ -62,7 +73,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/46e67ee/packages/core-react/src/Button/Button.types.ts#L55"
       }
     ],
     "description": ""
@@ -78,7 +89,7 @@
         "description": "Render a specific component for the link. This MUST return an anchor tag.\nThe component will receive props like onClick and className that\nMUST be added to the element.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Render a specific component for the link. This MUST return an anchor tag.\nThe component will receive props like onClick and className that\nMUST be added to the element.</p>\n</div><div><p>This prop is useful when working with links connected to a router, and\na component &#39;outside of core-react&#39; wants to render the <code>a</code> tag.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>example</dt><dd><p>const RoutedLink = (p) =&gt; &lt;a {...p} href=&quot;/test&quot; /&gt;\n<LinkButton as={RoutedLink}></p>\n</dd><dt>since</dt><dd><p>12.20.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#L74"
+        "sourceUrl": "https://github.com/procore/core/blob/46e67ee/packages/core-react/src/Button/Button.types.ts#L79"
       },
       {
         "name": "block",
@@ -88,7 +99,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/46e67ee/packages/core-react/src/Button/Button.types.ts#L25"
       },
       {
         "name": "icon",
@@ -98,7 +109,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/46e67ee/packages/core-react/src/Button/Button.types.ts#L31"
       },
       {
         "name": "iconRight",
@@ -110,7 +121,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/46e67ee/packages/core-react/src/Button/Button.types.ts#L38"
       },
       {
         "name": "role",
@@ -120,7 +131,7 @@
         "description": "Use role link when the link has destination. Use role button when it is used for POST.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Use role link when the link has destination. Use role button when it is used for POST.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>default</dt><dd><p>&#39;button&#39;</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#L81"
+        "sourceUrl": "https://github.com/procore/core/blob/46e67ee/packages/core-react/src/Button/Button.types.ts#L86"
       },
       {
         "name": "size",
@@ -130,7 +141,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/46e67ee/packages/core-react/src/Button/Button.types.ts#L48"
       },
       {
         "name": "variant",
@@ -140,7 +151,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/46e67ee/packages/core-react/src/Button/Button.types.ts#L55"
       }
     ],
     "description": ""