@procore/core-react 10.20.0-rc.93 → 10.20.0

package/dist/typedoc/components/Slider/Slider.types.json

@@ -0,0 +1,68 @@
+{
+  "SliderProps": {
+    "name": "SliderProps",
+    "properties": [
+      {
+        "name": "disabled",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "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></div>",
+        "sourceFile": "packages/core-react/src/components/Slider/Slider.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Slider/Slider.types.ts#L7"
+      },
+      {
+        "name": "max",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">number</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">number</span>",
+        "description": "The maximum value of the slider (right side)",
+        "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></dl></div>",
+        "sourceFile": "packages/core-react/src/components/Slider/Slider.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Slider/Slider.types.ts#L12"
+      },
+      {
+        "name": "min",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">number</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">number</span>",
+        "description": "The minimum value of the slider (left side)",
+        "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></dl></div>",
+        "sourceFile": "packages/core-react/src/components/Slider/Slider.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Slider/Slider.types.ts#L17"
+      },
+      {
+        "name": "showLabel",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "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></div>",
+        "sourceFile": "packages/core-react/src/components/Slider/Slider.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Slider/Slider.types.ts#L21"
+      },
+      {
+        "name": "step",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">number</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">number</span>",
+        "description": "The distance between each stopping point on the Slider.",
+        "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></dl></div>",
+        "sourceFile": "packages/core-react/src/components/Slider/Slider.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Slider/Slider.types.ts#L26"
+      },
+      {
+        "name": "value",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">number</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">number</span>",
+        "description": "The currently set value of the Slider.\nDefaults to the middle between min and max.",
+        "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></dl></div>",
+        "sourceFile": "packages/core-react/src/components/Slider/Slider.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Slider/Slider.types.ts#L32"
+      }
+    ],
+    "description": ""
+  }
+}

package/dist/typedoc/components/Spinner/Spinner.types.json

@@ -0,0 +1,89 @@
+{
+  "SpinnerProps": {
+    "name": "SpinnerProps",
+    "properties": [
+      {
+        "name": "children",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "description": "Instead of using the default children, you can pass in your own.",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Instead of using the default children, you can pass in your own.</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/utils/types.ts#L40"
+      },
+      {
+        "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/4be00958e/packages/core-react/src/utils/types.ts#L45"
+      },
+      {
+        "name": "color",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">Color</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">Color</span>",
+        "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></div>",
+        "sourceFile": "packages/core-react/src/components/Spinner/Spinner.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Spinner/Spinner.types.ts#L16"
+      },
+      {
+        "name": "label",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "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></div>",
+        "sourceFile": "packages/core-react/src/components/Spinner/Spinner.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Spinner/Spinner.types.ts#L20"
+      },
+      {
+        "name": "loading",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "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></div>",
+        "sourceFile": "packages/core-react/src/components/Spinner/Spinner.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Spinner/Spinner.types.ts#L25"
+      },
+      {
+        "name": "size",
+        "required": false,
+        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">SpinnerSize</a>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;xs&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;sm&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;md&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;lg&quot;</span>",
+        "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></div>",
+        "sourceFile": "packages/core-react/src/components/Spinner/Spinner.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Spinner/Spinner.types.ts#L30"
+      },
+      {
+        "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/4be00958e/packages/core-react/src/utils/types.ts#L50"
+      },
+      {
+        "name": "variant",
+        "required": false,
+        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">SpinnerVariant</a>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;light&quot;</span>",
+        "description": "",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><dl class=\"tsd-comment-tags\"><dt>deprecated</dt><dd><p>&quot;variant&quot; prop will be removed in a future version. Use &quot;color&quot; prop instead to set a spinner&#39;s color.</p>\n</dd></dl></div>",
+        "deprecated": "\"variant\" prop will be removed in a future version. Use \"color\" prop instead to set a spinner's color.\n",
+        "sourceFile": "packages/core-react/src/components/Spinner/Spinner.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Spinner/Spinner.types.ts#L34"
+      }
+    ],
+    "description": ""
+  }
+}

package/dist/typedoc/components/Switch/Switch.types.json

@@ -0,0 +1,38 @@
+{
+  "SwitchProps": {
+    "name": "SwitchProps",
+    "properties": [
+      {
+        "name": "children",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "description": "Instead of using the default children, you can pass in your own.",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Instead of using the default children, you can pass in your own.</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/utils/types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/utils/types.ts#L40"
+      },
+      {
+        "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/4be00958e/packages/core-react/src/utils/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/4be00958e/packages/core-react/src/utils/types.ts#L50"
+      }
+    ],
+    "description": ""
+  }
+}