@procore/core-react 11.32.0 → 11.33.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/78223f7/packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts#L22"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/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/78223f7/packages/core-react/src/_utils/types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/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/78223f7/packages/core-react/src/_utils/types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/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/78223f7/packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts#L26"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/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/78223f7/packages/core-react/src/_utils/types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "variant",
@@ -58,9 +58,10 @@
         "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Enumeration\">BreadcrumbVariants</a>",
         "typeDetail": "<span class=\"tsd-signature-type\">any</span>",
         "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>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>deprecated</dt><dd><p>Handled by parent prop.</p>\n</dd><dt>since</dt><dd><p>11.6.0</p>\n</dd></dl></div>",
+        "deprecated": "Handled by parent prop.",
         "sourceFile": "packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/78223f7/packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts#L30"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts#L42"
       }
     ],
     "description": ""
@@ -76,7 +77,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "packages/core-react/src/_utils/types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/78223f7/packages/core-react/src/_utils/types.ts#L42"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/_utils/types.ts#L42"
       },
       {
         "name": "className",
@@ -86,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/78223f7/packages/core-react/src/_utils/types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/_utils/types.ts#L47"
       },
       {
         "name": "style",
@@ -96,17 +97,18 @@
         "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/78223f7/packages/core-react/src/_utils/types.ts#L52"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/_utils/types.ts#L52"
       },
       {
         "name": "variant",
         "required": false,
-        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Enumeration\">BreadcrumbVariants</a>",
-        "typeDetail": "<span class=\"tsd-signature-type\">any</span>",
+        "type": "<span class=\"tsd-signature-type\">&quot;list&quot;</span><span class=\"tsd-signature-symbol\"> | </span><a class=\"tsd-signature-type\" data-tsd-kind=\"Enumeration\">BreadcrumbVariants</a>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;list&quot;</span><span class=\"tsd-signature-symbol\"> | </span><a class=\"tsd-signature-type\" data-tsd-kind=\"Enumeration\">BreadcrumbVariants</a>",
         "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>",
+        "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/78223f7/packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts#L15"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/Breadcrumbs/Breadcrumbs.types.ts#L26"
       }
     ],
     "description": ""

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

@@ -10,7 +10,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/78223f7/packages/core-react/src/Button/Button.types.ts#L18"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/Button/Button.types.ts#L18"
       },
       {
         "name": "icon",
@@ -20,7 +20,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/78223f7/packages/core-react/src/Button/Button.types.ts#L24"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/Button/Button.types.ts#L24"
       },
       {
         "name": "iconRight",
@@ -30,7 +30,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/78223f7/packages/core-react/src/Button/Button.types.ts#L29"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/Button/Button.types.ts#L29"
       },
       {
         "name": "loading",
@@ -40,7 +40,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/78223f7/packages/core-react/src/Button/Button.types.ts#L34"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/Button/Button.types.ts#L34"
       },
       {
         "name": "size",
@@ -50,7 +50,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/78223f7/packages/core-react/src/Button/Button.types.ts#L39"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/Button/Button.types.ts#L39"
       },
       {
         "name": "variant",
@@ -60,7 +60,7 @@
         "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/78223f7/packages/core-react/src/Button/Button.types.ts#L44"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/Button/Button.types.ts#L44"
       }
     ],
     "description": ""
@@ -76,7 +76,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/78223f7/packages/core-react/src/Button/Button.types.ts#L18"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/Button/Button.types.ts#L18"
       },
       {
         "name": "icon",
@@ -86,7 +86,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/78223f7/packages/core-react/src/Button/Button.types.ts#L24"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/Button/Button.types.ts#L24"
       },
       {
         "name": "iconRight",
@@ -96,7 +96,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/78223f7/packages/core-react/src/Button/Button.types.ts#L29"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/Button/Button.types.ts#L29"
       },
       {
         "name": "role",
@@ -106,7 +106,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/78223f7/packages/core-react/src/Button/Button.types.ts#L57"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/Button/Button.types.ts#L57"
       },
       {
         "name": "size",
@@ -116,7 +116,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/78223f7/packages/core-react/src/Button/Button.types.ts#L39"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/Button/Button.types.ts#L39"
       },
       {
         "name": "variant",
@@ -126,7 +126,7 @@
         "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/78223f7/packages/core-react/src/Button/Button.types.ts#L44"
+        "sourceUrl": "https://github.com/procore/core/blob/8dc9447/packages/core-react/src/Button/Button.types.ts#L44"
       }
     ],
     "description": ""