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

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

@@ -0,0 +1,28 @@
+{
+  "TypeaheadProps": {
+    "name": "TypeaheadProps",
+    "properties": [
+      {
+        "name": "data-qa",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "description": "",
+        "descriptionHtml": "",
+        "sourceFile": "packages/core-react/src/components/Typeahead/Typeahead.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Typeahead/Typeahead.types.ts#L12"
+      },
+      {
+        "name": "onChange",
+        "required": false,
+        "type": "Function",
+        "typeDetail": "on<wbr/>Change<span class=\"tsd-signature-symbol\">(</span>value<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">string</span>, event<span class=\"tsd-signature-symbol\">: </span><a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">TypeaheadChangeEvent</a><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
+        "description": "",
+        "descriptionHtml": "",
+        "sourceFile": "packages/core-react/src/components/Typeahead/Typeahead.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Typeahead/Typeahead.types.ts#L13"
+      }
+    ],
+    "description": ""
+  }
+}

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

@@ -0,0 +1,88 @@
+{
+  "TypographyProps": {
+    "name": "TypographyProps",
+    "properties": [
+      {
+        "name": "as",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">ComponentType</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">any</span><span class=\"tsd-signature-symbol\">&gt;</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">ComponentType</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">any</span><span class=\"tsd-signature-symbol\">&gt;</span>",
+        "description": "<span>\n Change the HTML tag. This{' '}\n <Link href=\"https://styled-components.com/docs/api#as-polymorphic-prop\">\n   prop is from styled-components\n </Link>\n .<em>WARNING</em>: If using TypeScript, it will not switch types and\n some props may error. You can add <Code>// @ts-expect-error</Code>.\n See{' '}\n <Link href=\"https://github.com/DefinitelyTyped/DefinitelyTyped/issues/30117\">\n   styled-components issue\n </Link>\n .\n</span>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<span>\n Change the HTML tag. This{' '}\n <Link href=\"https://styled-components.com/docs/api#as-polymorphic-prop\">\n   prop is from styled-components\n </Link>\n .<em>WARNING</em>: If using TypeScript, it will not switch types and\n some props may error. You can add <Code>// @ts-expect-error</Code>.\n See{' '}\n <Link href=\"https://github.com/DefinitelyTyped/DefinitelyTyped/issues/30117\">\n   styled-components issue\n </Link>\n .\n</span></div></div>",
+        "sourceFile": "packages/core-react/src/components/Typography/Typography.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Typography/Typography.types.ts#L33"
+      },
+      {
+        "name": "children",
+        "required": true,
+        "type": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">ReactNode</span>",
+        "description": "<span>\n When children are a string or multiple elements, they will be wrapped\n by a <Code>span</Code>. When it is a single element, classnames will\n be added to it instead\n</span>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<span>\n When children are a string or multiple elements, they will be wrapped\n by a <Code>span</Code>. When it is a single element, classnames will\n be added to it instead\n</span></div></div>",
+        "sourceFile": "packages/core-react/src/components/Typography/Typography.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Typography/Typography.types.ts#L16"
+      },
+      {
+        "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 Changes font color, can be any 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 Changes font color, can be any 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>default</dt><dd><p>&#39;gray15&#39;</p>\n</dd></dl></div>",
+        "sourceFile": "packages/core-react/src/components/Typography/Typography.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Typography/Typography.types.ts#L43"
+      },
+      {
+        "name": "intent",
+        "required": false,
+        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">Intent</a>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;h1&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;h2&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;h3&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;body&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;small&quot;</span>",
+        "description": "Changes the size of the font",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Changes the size of the font</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/components/Typography/Typography.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Typography/Typography.types.ts#L48"
+      },
+      {
+        "name": "italic",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "description": "Applies `font-style: italic` if enabled",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Applies <code>font-style: italic</code> if enabled</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/components/Typography/Typography.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Typography/Typography.types.ts#L53"
+      },
+      {
+        "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": "weight",
+        "required": false,
+        "type": "<a class=\"tsd-signature-type\" data-tsd-kind=\"Type alias\">Weight</a>",
+        "typeDetail": "<span class=\"tsd-signature-type\">&quot;regular&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;semibold&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;bold&quot;</span>",
+        "description": "Changes font weight if it is supported in the design system",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Changes font weight if it is supported in the design system</p>\n</div></div>",
+        "sourceFile": "packages/core-react/src/components/Typography/Typography.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/4be00958e/packages/core-react/src/components/Typography/Typography.types.ts#L58"
+      }
+    ],
+    "description": ""
+  }
+}