@procore/core-react 12.8.0 → 12.9.0

package/dist/_typedoc/Slider/Slider.types.json

@@ -10,7 +10,7 @@
         "description": "Whether or not to put the slider into a disabled state.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Whether or not to put the slider into a disabled state.</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/Slider/Slider.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Slider/Slider.types.ts#L8"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Slider/Slider.types.ts#L8"
       },
       {
         "name": "max",
@@ -21,7 +21,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The maximum value of the slider (right side)</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>100</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "defaultValue": "100",
         "sourceFile": "packages/core-react/src/Slider/Slider.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Slider/Slider.types.ts#L14"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Slider/Slider.types.ts#L14"
       },
       {
         "name": "min",
@@ -32,7 +32,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The minimum value of the slider (left side)</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>0</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "defaultValue": "0",
         "sourceFile": "packages/core-react/src/Slider/Slider.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Slider/Slider.types.ts#L20"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Slider/Slider.types.ts#L20"
       },
       {
         "name": "showLabel",
@@ -42,7 +42,7 @@
         "description": "Whether or not to show value labels below the slider increments.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Whether or not to show value labels below the slider increments.</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/Slider/Slider.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Slider/Slider.types.ts#L25"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Slider/Slider.types.ts#L25"
       },
       {
         "name": "step",
@@ -53,7 +53,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The distance between each stopping point on the Slider.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>1</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "defaultValue": "1",
         "sourceFile": "packages/core-react/src/Slider/Slider.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Slider/Slider.types.ts#L31"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Slider/Slider.types.ts#L31"
       },
       {
         "name": "value",
@@ -64,7 +64,7 @@
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The currently set value of the Slider.\nDefaults to the middle between min and max.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>defaultvalue</dt><dd><p>(max &lt; min) ? min : min + (max - min)/2;</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "defaultValue": "(max < min) ? min : min + (max - min)/2;",
         "sourceFile": "packages/core-react/src/Slider/Slider.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Slider/Slider.types.ts#L38"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Slider/Slider.types.ts#L38"
       }
     ],
     "description": ""

package/dist/_typedoc/Spinner/Spinner.types.json

@@ -10,7 +10,7 @@
         "description": "Spinner option to be centered.\nUse this prop if you need to center the spinner regardless of the height of its children.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Spinner option to be centered.\nUse this prop if you need to center the spinner regardless of the height of its children.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>11.3.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Spinner/Spinner.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Spinner/Spinner.types.ts#L47"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Spinner/Spinner.types.ts#L47"
       },
       {
         "name": "children",
@@ -20,7 +20,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",
@@ -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/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": "color",
@@ -40,7 +40,7 @@
         "description": "<span>\n Spinner color, one of the{' '}\n <Link to=\"/web/style/colors/#hsl-palette\">HSL Palette</Link> css\n strings\n</span>",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<span>\n Spinner color, one of the{' '}\n <Link to=\"/web/style/colors/#hsl-palette\">HSL Palette</Link> css\n strings\n</span></div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
         "sourceFile": "packages/core-react/src/Spinner/Spinner.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Spinner/Spinner.types.ts#L17"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Spinner/Spinner.types.ts#L17"
       },
       {
         "name": "label",
@@ -50,7 +50,7 @@
         "description": "The spinner label, only displayed when used as an overlay",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The spinner label, only displayed when used as an 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/Spinner/Spinner.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Spinner/Spinner.types.ts#L22"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Spinner/Spinner.types.ts#L22"
       },
       {
         "name": "loading",
@@ -60,7 +60,7 @@
         "description": "The spinner will show if loading is true",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The spinner will show if loading is true</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/Spinner/Spinner.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Spinner/Spinner.types.ts#L28"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Spinner/Spinner.types.ts#L28"
       },
       {
         "name": "size",
@@ -70,7 +70,7 @@
         "description": "The size of the spinner",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The size of the 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/Spinner/Spinner.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Spinner/Spinner.types.ts#L34"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Spinner/Spinner.types.ts#L34"
       },
       {
         "name": "style",
@@ -80,7 +80,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": "variant",
@@ -92,7 +92,7 @@
         "deprecated": "\"variant\" prop will be removed in a future version.\nUse \"color\" prop instead to set a spinner's color.",
         "deprecatedSince": "11",
         "sourceFile": "packages/core-react/src/Spinner/Spinner.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/27e03fe/packages/core-react/src/Spinner/Spinner.types.ts#L41"
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/Spinner/Spinner.types.ts#L41"
       }
     ],
     "description": ""

package/dist/_typedoc/SplitViewCard/SplitViewCard.types.json

@@ -0,0 +1,134 @@
+{
+  "SplitViewCardContextAPI": {
+    "name": "SplitViewCardContextAPI",
+    "properties": [
+      {
+        "name": "isClosable",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "description": "Indicates whether the SplitViewCard can be closed",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Indicates whether the SplitViewCard can be closed</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/SplitViewCard/SplitViewCard.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/SplitViewCard/SplitViewCard.types.ts#L22"
+      },
+      {
+        "name": "isScrolling",
+        "required": true,
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "description": "Indicates whether the user is actively scrolling within the SplitViewCard.Body",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Indicates whether the user is actively scrolling within the SplitViewCard.Body</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>12.9.0</p>\n</dd></dl></div>",
+        "sourceFile": "packages/core-react/src/SplitViewCard/SplitViewCard.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/SplitViewCard/SplitViewCard.types.ts#L27"
+      },
+      {
+        "name": "open",
+        "required": true,
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "description": "If aside card is opened or not",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>If aside card is opened or not</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>12.9.0</p>\n</dd></dl></div>",
+        "sourceFile": "packages/core-react/src/SplitViewCard/SplitViewCard.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/SplitViewCard/SplitViewCard.types.ts#L8"
+      },
+      {
+        "name": "onClose",
+        "required": true,
+        "type": "Function",
+        "typeDetail": "on<wbr/>Close<span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
+        "description": "Close aside card",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Close aside card</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>12.9.0</p>\n</dd></dl></div>",
+        "sourceFile": "packages/core-react/src/SplitViewCard/SplitViewCard.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/SplitViewCard/SplitViewCard.types.ts#L18"
+      },
+      {
+        "name": "onOpen",
+        "required": true,
+        "type": "Function",
+        "typeDetail": "on<wbr/>Open<span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
+        "description": "Open aside card",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Open aside card</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>12.9.0</p>\n</dd></dl></div>",
+        "sourceFile": "packages/core-react/src/SplitViewCard/SplitViewCard.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/SplitViewCard/SplitViewCard.types.ts#L13"
+      },
+      {
+        "name": "setIsScrolling",
+        "required": true,
+        "type": "Function",
+        "typeDetail": "set<wbr/>Is<wbr/>Scrolling<span class=\"tsd-signature-symbol\">(</span>isScrolling<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">boolean</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
+        "description": "Callback to update the isScrolling flag",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback to update the isScrolling flag</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>12.9.0</p>\n</dd></dl></div>",
+        "sourceFile": "packages/core-react/src/SplitViewCard/SplitViewCard.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/SplitViewCard/SplitViewCard.types.ts#L33"
+      }
+    ],
+    "description": ""
+  },
+  "SplitViewCardProps": {
+    "name": "SplitViewCardProps",
+    "properties": [
+      {
+        "name": "children",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "description": "",
+        "descriptionHtml": "",
+        "sourceFile": "packages/core-react/src/_utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/_utils/types.ts#L42"
+      },
+      {
+        "name": "className",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "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/7049bfa/packages/core-react/src/_utils/types.ts#L47"
+      },
+      {
+        "name": "isClosable",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "description": "Indicates whether the SplitViewCard can be closed",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Indicates whether the SplitViewCard can be closed</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/SplitViewCard/SplitViewCard.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/SplitViewCard/SplitViewCard.types.ts#L40"
+      },
+      {
+        "name": "isInitiallyOpen",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "description": "If aside card is initially opened or not",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>If aside card is initially opened or not</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>12.9.0</p>\n</dd></dl></div>",
+        "sourceFile": "packages/core-react/src/SplitViewCard/SplitViewCard.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/SplitViewCard/SplitViewCard.types.ts#L45"
+      },
+      {
+        "name": "style",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">CSSProperties</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">CSSProperties</span>",
+        "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/7049bfa/packages/core-react/src/_utils/types.ts#L52"
+      },
+      {
+        "name": "onClose",
+        "required": false,
+        "type": "Function",
+        "typeDetail": "on<wbr/>Close<span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
+        "description": "Callback for custom close event",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback for custom close event</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>12.9.0</p>\n</dd></dl></div>",
+        "sourceFile": "packages/core-react/src/SplitViewCard/SplitViewCard.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/7049bfa/packages/core-react/src/SplitViewCard/SplitViewCard.types.ts#L50"
+      }
+    ],
+    "description": ""
+  }
+}

package/dist/_typedoc/Switch/Switch.types.json

@@ -10,7 +10,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",
@@ -20,7 +20,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": "style",
@@ -30,7 +30,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"
       }
     ],
     "description": ""