@procore/core-react 10.25.1-rc.14959 → 10.26.0

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

@@ -1,28 +0,0 @@
-{
-  "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": "<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/components/Typeahead/Typeahead.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/ee7d41693/packages/core-react/src/components/Typeahead/Typeahead.types.ts#L15"
-      },
-      {
-        "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": "<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/components/Typeahead/Typeahead.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/ee7d41693/packages/core-react/src/components/Typeahead/Typeahead.types.ts#L19"
-      }
-    ],
-    "description": ""
-  }
-}

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

@@ -1,88 +0,0 @@
-{
-  "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><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
-        "sourceFile": "packages/core-react/src/components/Typography/Typography.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/ee7d41693/packages/core-react/src/components/Typography/Typography.types.ts#L35"
-      },
-      {
-        "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><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
-        "sourceFile": "packages/core-react/src/components/Typography/Typography.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/ee7d41693/packages/core-react/src/components/Typography/Typography.types.ts#L17"
-      },
-      {
-        "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/ee7d41693/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><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
-        "sourceFile": "packages/core-react/src/components/Typography/Typography.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/ee7d41693/packages/core-react/src/components/Typography/Typography.types.ts#L46"
-      },
-      {
-        "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><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
-        "sourceFile": "packages/core-react/src/components/Typography/Typography.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/ee7d41693/packages/core-react/src/components/Typography/Typography.types.ts#L52"
-      },
-      {
-        "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><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
-        "sourceFile": "packages/core-react/src/components/Typography/Typography.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/ee7d41693/packages/core-react/src/components/Typography/Typography.types.ts#L58"
-      },
-      {
-        "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/ee7d41693/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><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
-        "sourceFile": "packages/core-react/src/components/Typography/Typography.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/ee7d41693/packages/core-react/src/components/Typography/Typography.types.ts#L64"
-      }
-    ],
-    "description": ""
-  }
-}

package/dist/typedoc/deprecations.json

@@ -1 +0,0 @@
-[{"interface":"AvatarIconProps","property":"icon","deprecatedSince":"10.20.0","message":"\n\nThe `string` type icon has been deprecated and will be removed in the future.\nPlease use a React icon component from the `@procore/core-icons/dist` package.\n\n**Before**\n\n```\n<Avatar>\n  <Avatar.Icon icon=\"building\" />\n</Avatar>\n```\n\n**After**\n\n```\n<Avatar>\n  <Avatar.Icon icon={<Building />} />\n</Avatar>\n```\n"},{"interface":"AvatarProps","property":"size","deprecatedSince":"10.20.0","message":"\n\nSize \"xl\" has been deprecated and will be removed in a future version.\nPlease use \"lg\" instead of \"xl\".\n\n**Before**\n\n`<Avatar size=\"xl\" />`\n\n**After**\n\n`<Avatar size=\"lg\" />`\n"},{"interface":"BannerIconProps","property":"icon","deprecatedSince":"","message":"String type is deprecated. Please pass an SVG icon instance."},{"interface":"CardProps","property":"level","deprecatedSince":"10.20.0","message":"\n\nThe `level` prop has been deprecated and will be removed in a future version.\nPlease use the `shadowStrength` prop instead.\n\n**Before**\n\n<Card level={20} />\n\n**After**\n\n<Card shadowStrength={2} />\n"},{"interface":"GridProps","property":"icon","deprecatedSince":"","message":"String icon variant is deprecated, use the React components\ndirectly from the `@procore/core-icons/dist` package"},{"interface":"FileTreeProps","property":"icon","deprecatedSince":"","message":"String icon variant is deprecated, use the React components\ndirectly from the `@procore/core-icons/dist` package"},{"interface":"FieldRichTextComponentProps","property":"initialValue","deprecatedSince":"10.20.0","message":"\n`initialValue` has been deprecated and will be removed in a future version.\nPlease use the `value` prop instead\n\nThe first value passed into `value` prop will be the `TextEditor` initial\nvalue. Changing the value will update the text of the `TextEditor`.\nThe editor should be controlled via the combination of `value`\nand `onChange` props.\n\n**Before**\n\n`<TextEditor initialValue=\"Hello World\" />`\n\n**After**\n\n`<TextEditor value=\"Hello World\" />`\n"},{"interface":"FieldRichTextProps","property":"initialValue","deprecatedSince":"10.20.0","message":"\n`initialValue` has been deprecated and will be removed in a future version.\nPlease use the `value` prop instead\n\nThe first value passed into `value` prop will be the `TextEditor` initial\nvalue. Changing the value will update the text of the `TextEditor`.\nThe editor should be controlled via the combination of `value`\nand `onChange` props.\n\n**Before**\n\n`<TextEditor initialValue=\"Hello World\" />`\n\n**After**\n\n`<TextEditor value=\"Hello World\" />`\n"},{"interface":"FieldTextAreaComponentProps","property":"variant","deprecatedSince":"10.20.0","message":"\nThe `variant` prop has been deprecated and will be removed in a future version.\nPlease use the `error` boolean prop instead.\n\n**Before**\n\n`<TextArea variant=\"error\" />`\n\n**After**\n\n`<TextArea error />`\n"},{"interface":"FieldTextAreaProps","property":"variant","deprecatedSince":"10.20.0","message":"\nThe `variant` prop has been deprecated and will be removed in a future version.\nPlease use the `error` boolean prop instead.\n\n**Before**\n\n`<TextArea variant=\"error\" />`\n\n**After**\n\n`<TextArea error />`\n"},{"interface":"FieldTextComponentProps","property":"variant","deprecatedSince":"","message":"Use the `error` prop instead"},{"interface":"FieldTextProps","property":"variant","deprecatedSince":"","message":"Use the `error` prop instead"},{"interface":"InputProps","property":"variant","deprecatedSince":"","message":"Use the `error` prop instead"},{"interface":"MenuProps","property":"isSelectable","deprecatedSince":"10.20.0","message":"\n\nThe `isSelectable` prop has been deprecated and will be removed in a future version.\nMenu item selection is now handled internally and there is no need to configure this\nanymore.\n"},{"interface":"MenuSearchProps","property":"typeahead","deprecatedSince":"10.20.0\n","message":"\n\nThe `typeahead` prop has been deprecated and will be removed in a future version.\n\nA new component, `Typeahead`, has been introduced with specific UX for typeahead-like\nbehavior. Please use this component instead.\n\n**Before**\n\n<Search typeahead onChange={() => { ... }} />\n\n**After**\n\n<Typeahead onChange={() => { ... }} />\n"},{"interface":"MenuSearchProps","property":"variant","deprecatedSince":"","message":"Use the `error` prop instead"},{"interface":"PresetPaginationProps","property":"fieldLabel","deprecatedSince":"10.20.0","message":"\n\nThe `fieldLabel` has been deprecated and will be removed in a future version.\nThe `Pagination` component now handles i18n internally and this prop has no effect,\nplease remove it from usage.\n\n\n**Before**\n\n`<Pagination fieldLabel={window.i18n.t('my.key')} />`\n\n**After**\n\n`<Pagination />`\n"},{"interface":"SearchHookConfig","property":"typeahead","deprecatedSince":"10.20.0\n","message":"\n\nThe `typeahead` prop has been deprecated and will be removed in a future version.\n\nA new component, `Typeahead`, has been introduced with specific UX for typeahead-like\nbehavior. Please use this component instead.\n\n**Before**\n\n<Search typeahead onChange={() => { ... }} />\n\n**After**\n\n<Typeahead onChange={() => { ... }} />\n"},{"interface":"SearchProps","property":"typeahead","deprecatedSince":"10.20.0\n","message":"\n\nThe `typeahead` prop has been deprecated and will be removed in a future version.\n\nA new component, `Typeahead`, has been introduced with specific UX for typeahead-like\nbehavior. Please use this component instead.\n\n**Before**\n\n<Search typeahead onChange={() => { ... }} />\n\n**After**\n\n<Typeahead onChange={() => { ... }} />\n"},{"interface":"SearchProps","property":"variant","deprecatedSince":"","message":"Use the `error` prop instead"},{"interface":"SegmentedControllerProps","property":"variant","deprecatedSince":"","message":"Please use the `block` prop"},{"interface":"SpinnerProps","property":"variant","deprecatedSince":"","message":"\"variant\" prop will be removed in a future version.\nUse \"color\" prop instead to set a spinner's color."},{"interface":"InputCellProps","property":"variant","deprecatedSince":"","message":"Use the `error` prop instead"},{"interface":"TabProps","property":"dropdown","deprecatedSince":"","message":"This was never intended to be a public facing API and does not\ndo anything. It will be removed in the future."},{"interface":"TabProps","property":"overflowing","deprecatedSince":"","message":"This was never intended to be a public facing API and does not\ndo anything. It will be removed in the future."},{"interface":"TabProps","property":"variant","deprecatedSince":"","message":"please use the `active` and `dark` props to configure style. The\n`dropdown`, `hover`, and `overflowing` variants were only for internal use\nand should not be used in clients"},{"interface":"TextAreaProps","property":"variant","deprecatedSince":"10.20.0","message":"\nThe `variant` prop has been deprecated and will be removed in a future version.\nPlease use the `error` boolean prop instead.\n\n**Before**\n\n`<TextArea variant=\"error\" />`\n\n**After**\n\n`<TextArea error />`\n"},{"interface":"TextEditorProps","property":"initialValue","deprecatedSince":"10.20.0","message":"\n`initialValue` has been deprecated and will be removed in a future version.\nPlease use the `value` prop instead\n\nThe first value passed into `value` prop will be the `TextEditor` initial\nvalue. Changing the value will update the text of the `TextEditor`.\nThe editor should be controlled via the combination of `value`\nand `onChange` props.\n\n**Before**\n\n`<TextEditor initialValue=\"Hello World\" />`\n\n**After**\n\n`<TextEditor value=\"Hello World\" />`\n"},{"interface":"TokenProps","property":"variant","deprecatedSince":"10.20.0","message":"\n\nThe `'disabled'` and `'focused'` variants have been deprecated and will be\nremoved in a future version. Please use the `disabled` and `focused` boolean\nprops instead.\n\n**Before**\n\n`<Token variant=\"disabled|focused\" />`\n\n**After**\n\n`<Token disabled focused />`\n"},{"interface":"ListPageControlProps","property":"variant","deprecatedSince":"","message":"please use the equivalent boolean prop instead"},{"interface":"ToolHeaderIconProps","property":"icon","deprecatedSince":"","message":"this will take an icon from '@procore/core-icons/dist' package\nin the near future. See Icon List page for further details"}]