@procore/core-react 10.20.0-rc.90 → 10.20.0-rc.94

package/dist/props/Menu.json

@@ -1 +1 @@
-{"MenuFooterProps":[{"name":"alignContent","type":"","required":false},{"name":"alignItems","type":"","required":false},{"name":"alignSelf","type":"","required":false},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"display","type":"","required":false},{"name":"flex","required":false,"description":"Alias to the `flex` property on a flexbox child."},{"name":"flexBasis","required":false,"description":"Alias to the `basis` property on a flexbox child."},{"name":"flexDirection","type":"","required":false,"description":"Alias to the `direction` property on a flexbox child."},{"name":"flexGrow","required":false,"description":"Alias to the `grow` property on a flexbox child."},{"name":"flexShrink","required":false,"description":"Alias to the `shrink` property on a flexbox child."},{"name":"flexWrap","type":"","required":false,"description":"Alias to the `wrap` property on a flexbox child."},{"name":"justifyContent","type":"","required":false},{"name":"margin","type":"string","required":false},{"name":"marginBottom","type":"","required":false},{"name":"marginLeft","type":"","required":false},{"name":"marginRight","type":"","required":false},{"name":"marginTop","type":"","required":false},{"name":"order","type":"number","required":false,"description":"Alias to the `order` property on a flexbox child"},{"name":"padding","type":"string","required":false},{"name":"paddingBottom","type":"","required":false},{"name":"paddingLeft","type":"","required":false},{"name":"paddingRight","type":"","required":false},{"name":"paddingTop","type":"","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tabIndex","type":"number","required":false},{"name":"textAlign","type":"","required":false}],"MenuGroupProps":[{"name":"className","type":"string","required":false},{"name":"clickable","type":"boolean","required":false,"description":"Can the group item be clicked"},{"name":"item","type":"any","required":false,"description":"Value which can be passed around various callback functions. Can be anything!"}],"MenuHeaderProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tabIndex","type":"number","required":false}],"MenuItemProps":[{"name":"children","type":"ReactNode","required":false},{"name":"className","type":"string","required":false},{"name":"index","type":"number","required":false},{"name":"item","type":"any","required":false,"description":"Value which can be passed around various callback functions. Can be anything!"},{"name":"ref","type":"Ref","required":false},{"name":"selected","type":"boolean","required":false,"description":"Is the item selected"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"suggested","type":"boolean","required":false},{"name":"onClick","type":"any","required":true}],"MenuOptionsProps":[{"name":"children","type":"ReactNode","required":false},{"name":"className","type":"string","required":false},{"name":"padding","type":"string","required":false},{"name":"scrollable","type":"boolean","required":false}],"MenuProps":[{"name":"UNSAFE_closesOnSelect","type":"boolean","required":false},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"isSelectable","type":"ElementTypeChecker","required":false,"deprecated":"\n<CodeBlock>\n (element: any, index?: number, list?: any[]) => boolean\n</CodeBlock>\n"},{"name":"keyHandlerRef","type":"RefObject","required":false,"description":"Ref object which will get the key handler listeners"},{"name":"scrollable","type":"boolean","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"usingHook","type":"MenuHook","required":false},{"name":"onScrollBottom","type":"void","required":true},{"name":"onSelect","type":"any","required":true,"description":"<div>Callback for selecting an item from the menu</div>\n<CodeBlock>\n{\n  '({ event: ReactEvent, item: Menu.Item.props.item, group: bool }) => void'\n}\n</CodeBlock>\n<div>\n <Code>item</Code> will be the <Code>item</Code> prop supplied to the{' '}\n <Code>Item</Code> component\n <br />\n <Code>group</Code> will be <Code>true</Code> if the clicked item was\n a group label\n</div>"}],"MenuSearchProps":[{"name":"autoFocus","type":"boolean","required":false},{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the menu search's configurable strings. Defaults to\nusing the core library's default strings."},{"name":"initialValue","type":"string","required":false},{"name":"typeahead","type":"boolean","required":false,"deprecated":"Please use the new `Typeahead` component\n"},{"name":"usingHook","type":"","required":false},{"name":"value","type":"string","required":false,"description":"Initial value string"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead\n"},{"name":"onClear","type":"void","required":true},{"name":"onSubmit","type":"void","required":true,"description":"<div>Input handler for search variant</div>\n<CodeBlock>(value: string) => void</CodeBlock>"}]}
+{"MenuFooterProps":[{"name":"alignContent","type":"","required":false},{"name":"alignItems","type":"","required":false},{"name":"alignSelf","type":"","required":false},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"display","type":"","required":false},{"name":"flex","required":false,"description":"Alias to the `flex` property on a flexbox child."},{"name":"flexBasis","required":false,"description":"Alias to the `basis` property on a flexbox child."},{"name":"flexDirection","type":"","required":false,"description":"Alias to the `direction` property on a flexbox child."},{"name":"flexGrow","required":false,"description":"Alias to the `grow` property on a flexbox child."},{"name":"flexShrink","required":false,"description":"Alias to the `shrink` property on a flexbox child."},{"name":"flexWrap","type":"","required":false,"description":"Alias to the `wrap` property on a flexbox child."},{"name":"justifyContent","type":"","required":false},{"name":"margin","type":"string","required":false},{"name":"marginBottom","type":"","required":false},{"name":"marginLeft","type":"","required":false},{"name":"marginRight","type":"","required":false},{"name":"marginTop","type":"","required":false},{"name":"order","type":"number","required":false,"description":"Alias to the `order` property on a flexbox child"},{"name":"padding","type":"string","required":false},{"name":"paddingBottom","type":"","required":false},{"name":"paddingLeft","type":"","required":false},{"name":"paddingRight","type":"","required":false},{"name":"paddingTop","type":"","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tabIndex","type":"number","required":false},{"name":"textAlign","type":"","required":false}],"MenuGroupProps":[{"name":"className","type":"string","required":false},{"name":"clickable","type":"boolean","required":false,"description":"Can the group item be clicked"},{"name":"item","type":"any","required":false,"description":"Value which can be passed around various callback functions. Can be anything!"}],"MenuHeaderProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tabIndex","type":"number","required":false}],"MenuItemProps":[{"name":"children","type":"ReactNode","required":false},{"name":"className","type":"string","required":false},{"name":"index","type":"number","required":false},{"name":"item","type":"any","required":false,"description":"Value which can be passed around various callback functions. Can be anything!"},{"name":"ref","type":"Ref","required":false},{"name":"selected","type":"boolean","required":false,"description":"Is the item selected"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"suggested","type":"boolean","required":false},{"name":"onClick","type":"any","required":true}],"MenuOptionsProps":[{"name":"children","type":"ReactNode","required":false},{"name":"className","type":"string","required":false},{"name":"padding","type":"string","required":false},{"name":"scrollable","type":"boolean","required":false}],"MenuProps":[{"name":"UNSAFE_closesOnSelect","type":"boolean","required":false},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"isSelectable","type":"ElementTypeChecker","required":false,"description":"<CodeBlock>\n (element: any, index?: number, list?: any[]) => boolean\n</CodeBlock>","deprecated":"\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"},{"name":"keyHandlerRef","type":"RefObject","required":false,"description":"Ref object which will get the key handler listeners"},{"name":"scrollable","type":"boolean","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"usingHook","type":"MenuHook","required":false},{"name":"onScrollBottom","type":"void","required":true},{"name":"onSelect","type":"any","required":true,"description":"<div>Callback for selecting an item from the menu</div>\n<CodeBlock>\n{\n  '({ event: ReactEvent, item: Menu.Item.props.item, group: bool }) => void'\n}\n</CodeBlock>\n<div>\n <Code>item</Code> will be the <Code>item</Code> prop supplied to the{' '}\n <Code>Item</Code> component\n <br />\n <Code>group</Code> will be <Code>true</Code> if the clicked item was\n a group label\n</div>"}],"MenuSearchProps":[{"name":"autoFocus","type":"boolean","required":false},{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the menu search's configurable strings. Defaults to\nusing the core library's default strings."},{"name":"initialValue","type":"string","required":false},{"name":"typeahead","type":"boolean","required":false,"deprecated":"\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"},{"name":"usingHook","type":"","required":false},{"name":"value","type":"string","required":false,"description":"Initial value string"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead\n"},{"name":"onClear","type":"void","required":true},{"name":"onSubmit","type":"void","required":true,"description":"<div>Input handler for search variant</div>\n<CodeBlock>(value: string) => void</CodeBlock>"}]}

package/dist/props/Pagination.json

@@ -1 +1 @@
-{"PresetPaginationProps":[{"name":"activePage","type":"number","required":false,"description":"Current page selected, 1 based."},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"fieldLabel","type":"string","required":false,"deprecated":"Pagination will handle i18n, please delete this prop.\n"},{"name":"items","type":"number","required":true,"description":"Total number of items across pages."},{"name":"perPage","type":"number","required":false,"description":"Number of items per page."},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"onSelectPage","type":"void","required":true,"description":"A callback that receives the page selected."}]}
+{"PresetPaginationProps":[{"name":"activePage","type":"number","required":false,"description":"Current page selected, 1 based."},{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"fieldLabel","type":"string","required":false,"deprecated":"\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"},{"name":"items","type":"number","required":true,"description":"Total number of items across pages."},{"name":"perPage","type":"number","required":false,"description":"Number of items per page."},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"onSelectPage","type":"void","required":true,"description":"A callback that receives the page selected."}]}

package/dist/props/Search.json

@@ -1 +1 @@
-{"SearchHook":[{"name":"domHandlers","required":true},{"name":"isEmpty","type":"boolean","required":true},{"name":"showSearch","type":"boolean","required":true},{"name":"value","type":"string","required":true},{"name":"clear","type":"void","required":true},{"name":"onChange","type":"void","required":true},{"name":"submit","type":"void","required":true}],"SearchHookConfig":[{"name":"initialValue","type":"string","required":false},{"name":"typeahead","type":"boolean","required":false,"deprecated":"Please use the new `Typeahead` component\n"},{"name":"onChange","type":"void","required":true,"description":"<div style={{ color: 'red' }}>\nDEPRECATED: Use the new Typeahead component\n</div>\n<br />\n<div>Input handler for typeahead variant</div>\n<CodeBlock>(event: ReactEvent) => void</CodeBlock>"},{"name":"onClear","type":"void","required":true},{"name":"onSubmit","type":"void","required":true,"description":"<div>Input handler for search variant</div>\n<CodeBlock>(value: string) => void</CodeBlock>"}],"SearchProps":[{"name":"autoFocus","type":"boolean","required":false},{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"initialValue","type":"string","required":false},{"name":"typeahead","type":"boolean","required":false,"deprecated":"Please use the new `Typeahead` component\n"},{"name":"usingHook","type":"","required":false},{"name":"value","type":"string","required":false,"description":"Initial value string"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead\n"},{"name":"onClear","type":"void","required":true},{"name":"onSubmit","type":"void","required":true,"description":"<div>Input handler for search variant</div>\n<CodeBlock>(value: string) => void</CodeBlock>"}]}
+{"SearchHook":[{"name":"domHandlers","required":true},{"name":"isEmpty","type":"boolean","required":true},{"name":"showSearch","type":"boolean","required":true},{"name":"value","type":"string","required":true},{"name":"clear","type":"void","required":true},{"name":"onChange","type":"void","required":true},{"name":"submit","type":"void","required":true}],"SearchHookConfig":[{"name":"initialValue","type":"string","required":false},{"name":"typeahead","type":"boolean","required":false,"deprecated":"\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"},{"name":"onChange","type":"void","required":true,"deprecated":"\n\nThe `onChange` 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"},{"name":"onClear","type":"void","required":true},{"name":"onSubmit","type":"void","required":true,"description":"<div>Input handler for search variant</div>\n<CodeBlock>(value: string) => void</CodeBlock>"}],"SearchProps":[{"name":"autoFocus","type":"boolean","required":false},{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"initialValue","type":"string","required":false},{"name":"typeahead","type":"boolean","required":false,"deprecated":"\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"},{"name":"usingHook","type":"","required":false},{"name":"value","type":"string","required":false,"description":"Initial value string"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead\n"},{"name":"onClear","type":"void","required":true},{"name":"onSubmit","type":"void","required":true,"description":"<div>Input handler for search variant</div>\n<CodeBlock>(value: string) => void</CodeBlock>"}]}

package/dist/props/TextArea.json

@@ -1 +1 @@
-{"TextAreaProps":[{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `TextArea`, changing the\nbackground color and border colors to red"},{"name":"resize","required":false,"description":"Controls the resize rules for the `TextArea`"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead\n"}]}
+{"TextAreaProps":[{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `TextArea`, changing the\nbackground color and border colors to red"},{"name":"resize","required":false,"description":"Controls the resize rules for the `TextArea`"},{"name":"variant","required":false,"deprecated":"\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"}]}

package/dist/props/TextEditor.json

@@ -1 +1 @@
-{"TextEditorProps":[{"name":"disabled","type":"boolean","required":false},{"name":"error","type":"boolean","required":false},{"name":"init","required":false},{"name":"initialValue","type":"string","required":false,"deprecated":"please use the equivalent value prop instead\n"},{"name":"locale","type":"Locale","required":false,"description":"Locale which will be used used for localization. Can be passed directly or\nset by wrapping components in I18n provider. Icelandic (is-IS) is not\nactually supported by TinyMCE, so it is defaulted to english."},{"name":"plugins","required":false,"description":"<div>\n Array of plugins to use with the editor in addition to the defaults.\n Can be any of:\n</div>\n<CodeBlock>\n [{plugins.map((plugin) => `'${plugin}'`).join(', ')}]\n</CodeBlock>"},{"name":"onChange","type":"void","required":true,"description":"<div>onChange event handler for text editor area</div>\n<CodeBlock>(content: string) => void</CodeBlock>"}]}
+{"TextEditorProps":[{"name":"disabled","type":"boolean","required":false},{"name":"error","type":"boolean","required":false},{"name":"init","required":false},{"name":"initialValue","type":"string","required":false,"deprecated":"\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"},{"name":"locale","type":"Locale","required":false,"description":"Locale which will be used used for localization. Can be passed directly or\nset by wrapping components in I18n provider. Icelandic (is-IS) is not\nactually supported by TinyMCE, so it is defaulted to english."},{"name":"plugins","required":false,"description":"<div>\n Array of plugins to use with the editor in addition to the defaults.\n Can be any of:\n</div>\n<CodeBlock>\n [{plugins.map((plugin) => `'${plugin}'`).join(', ')}]\n</CodeBlock>"},{"name":"onChange","type":"void","required":true,"description":"<div>onChange event handler for text editor area</div>\n<CodeBlock>(content: string) => void</CodeBlock>"}]}

package/dist/props/Token.json

@@ -1 +1 @@
-{"LegacyIconProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"clickable","type":"boolean","required":false},{"name":"icon","type":"ReactNode","required":true,"description":"The token icon"},{"name":"size","type":"","required":false,"description":"The size of the icon"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","type":"IconVariant","required":false,"description":"The icon variant"}],"TokenProps":[{"name":"disabled","type":"boolean","required":false,"description":"Disables the token"},{"name":"error","type":"boolean","required":false},{"name":"focused","type":"boolean","required":false},{"name":"variant","required":false,"deprecated":"Please use the `disabled` and `focused` boolean props\n"}]}
+{"LegacyIconProps":[{"name":"children","type":"ReactNode","required":false,"description":"Instead of using the default children, you can pass in your own."},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"clickable","type":"boolean","required":false},{"name":"icon","type":"ReactNode","required":true,"description":"The token icon"},{"name":"size","type":"","required":false,"description":"The size of the icon"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","type":"IconVariant","required":false,"description":"The icon variant"}],"TokenProps":[{"name":"disabled","type":"boolean","required":false,"description":"Disables the token"},{"name":"error","type":"boolean","required":false},{"name":"focused","type":"boolean","required":false},{"name":"variant","required":false,"deprecated":"\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"}]}