@procore/core-react 10.20.0-rc.8 → 10.20.0-rc.84

package/dist/props/Form.json

@@ -0,0 +1 @@
+{"BaseFieldProps":[{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"children","required":false,"description":"A subcomponent to render on a particular view.\n<br />\n<br />\nOne or all of:\n<br />\n<Code>Form.X.Create, Form.X.Read, Form.X.Update</Code>"},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"error","required":false},{"name":"label","type":"string","required":false},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"view","required":false,"description":"Determines show or edit state of field."}],"FieldAPI":[{"name":"helpers","type":"FieldHelperProps","required":true},{"name":"input","type":"FieldInputProps","required":true},{"name":"messages","required":true},{"name":"meta","type":"FieldMetaProps","required":true}],"FieldCheckboxComponentProps":[{"name":"checked","type":"boolean","required":false,"description":"Checked state of the checkbox"},{"name":"children","type":"ReactNode","required":false,"description":"The contents of the checkbox label"},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"disabled","type":"boolean","required":false,"description":"Disabled state of the checkbox"},{"name":"error","type":"boolean","required":false,"description":"Error state of the checkbox"},{"name":"field","type":"","required":true},{"name":"i18nScope","type":"string","required":false},{"name":"indeterminate","type":"boolean","required":false,"description":"Indeterminate state of the checkbox"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}],"FieldCheckboxProps":[{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"checked","type":"boolean","required":false,"description":"Checked state of the checkbox"},{"name":"children","required":false},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"error","required":false},{"name":"i18nScope","type":"string","required":false},{"name":"indeterminate","type":"boolean","required":false,"description":"Indeterminate state of the checkbox"},{"name":"label","type":"string","required":false},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"view","required":false,"description":"Determines show or edit state of field."}],"FieldCheckboxesComponentProps":[{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"field","type":"","required":true},{"name":"options","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"getId","required":true,"description":"<div>\n The id of an option{' '}\n <Code>{'(option: OptionItem) => string | number'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.id'}</Code>\n</div>"},{"name":"getLabel","type":"string","required":true,"description":"<div>\n The display label of an option\n <Code>{'(option: OptionItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.label || option.name'}</Code>\n</div>"},{"name":"isDisabledOption","type":"boolean","required":true},{"name":"isIndeterminateOption","type":"boolean","required":true}],"FieldCheckboxesProps":[{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"children","required":false},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"error","required":false},{"name":"label","type":"string","required":false},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"options","required":false},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"view","required":false,"description":"Determines show or edit state of field."},{"name":"getId","required":true,"description":"<div>\n The id of an option{' '}\n <Code>{'(option: OptionItem) => string | number'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.id'}</Code>\n</div>"},{"name":"getLabel","type":"string","required":true,"description":"<div>\n The display label of an option\n <Code>{'(option: OptionItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.label || option.name'}</Code>\n</div>"},{"name":"isDisabledOption","type":"boolean","required":true},{"name":"isIndeterminateOption","type":"boolean","required":true}],"FieldConfig":[{"name":"disabled","type":"boolean","required":false},{"name":"error","required":false},{"name":"name","type":"string","required":true},{"name":"required","type":"boolean","required":false},{"name":"validate","type":"FieldValidator","required":false},{"name":"view","required":false},{"name":"getId","required":true}],"FieldCurrencyComponentProps":[{"name":"decimalScale","required":false,"description":"The maximum number of fraction digits to use. Possible values range from 0 to 14. Setting to true will result in the maximum size, setting to false will allow 0 decimals, whole numbers only.","defaultValue":"true\n"},{"name":"defaultValue","type":"","required":false,"description":"Initial value of an uncontrolled component"},{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"field","type":"","required":true},{"name":"fillDecimalScale","type":"","required":false,"description":"<Code>none</Code> prevents from adding zeros to match given\n<Code>decimalScale</Code>.<br /> <Code>always</Code> automatically adds\nzeros to match given\n<Code>decimalScale</Code>. <br />\n<Code>onBlur</Code> automatically adds zeros to match given{' '}\n<Code>decimalScale</Code> when input has lost focus."},{"name":"locale","type":"","required":false,"description":"A string with a BCP 47 language tag or an array of such strings which specifies number formatting.","defaultValue":"en-US\n"},{"name":"prefix","type":"string","required":false,"description":"A string which is added to input as a prefix."},{"name":"qa","type":"QaTags","required":false},{"name":"step","type":"number","required":false,"description":"A stepping interval which is used in incrementer. Zero value turns off incrementer.","defaultValue":"0\n"},{"name":"suffix","type":"string","required":false,"description":"A string which is added to input as a suffix"},{"name":"value","type":"","required":false,"description":"Value of a controlled component"},{"name":"onChange","type":"void","required":true,"description":"`(value: ValueChange) => void`, where `ValueChange` is an object `{ value: string, parsedNumber: number | null }`."}],"FieldCurrencyProps":[{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"children","required":false},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"error","required":false},{"name":"label","type":"string","required":false},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"view","required":false,"description":"Determines show or edit state of field."}],"FieldDateComponentProps":[{"name":"beforeHide","type":"BeforeCallback","required":false,"description":"<div>\n The callback to run before the overlay is hidden. Returning\n <Code>false</Code> will prevent hiding.\n</div>\n<CodeBlock>(e: event) => boolean | Promise | undefined</CodeBlock>"},{"name":"beforeShow","type":"BeforeCallback","required":false,"description":"<div>\n The callback to run before the overlay is shown. Returning\n <Code>false</Code> will prevent showing.\n</div>\n<CodeBlock>(e: event) => boolean | Promise | undefined</CodeBlock>"},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"disabled","type":"boolean","required":false},{"name":"error","type":"boolean","required":false,"description":"Error variant"},{"name":"field","type":"","required":true},{"name":"tabIndex","type":"number","required":false},{"name":"value","type":"Date","required":false},{"name":"variant","type":"DateInputVariant","required":false},{"name":"afterHide","type":"void","required":true},{"name":"afterShow","type":"void","required":true},{"name":"disabledDate","type":"boolean","required":true},{"name":"onChange","type":"void","required":true},{"name":"onClear","type":"void","required":true}],"FieldDateProps":[{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"beforeHide","type":"BeforeCallback","required":false,"description":"<div>\n The callback to run before the overlay is hidden. Returning\n <Code>false</Code> will prevent hiding.\n</div>\n<CodeBlock>(e: event) => boolean | Promise | undefined</CodeBlock>"},{"name":"beforeShow","type":"BeforeCallback","required":false,"description":"<div>\n The callback to run before the overlay is shown. Returning\n <Code>false</Code> will prevent showing.\n</div>\n<CodeBlock>(e: event) => boolean | Promise | undefined</CodeBlock>"},{"name":"children","required":false},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"error","required":false},{"name":"label","type":"string","required":false},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"tabIndex","type":"number","required":false},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"value","type":"Date","required":false},{"name":"variant","type":"DateInputVariant","required":false},{"name":"view","required":false,"description":"Determines show or edit state of field."},{"name":"afterHide","type":"void","required":true},{"name":"afterShow","type":"void","required":true},{"name":"disabledDate","type":"boolean","required":true},{"name":"onChange","type":"void","required":true},{"name":"onClear","type":"void","required":true}],"FieldGroupSelectComponentProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false},{"name":"className","type":"string","required":false},{"name":"disabled","type":"boolean","required":false},{"name":"emptyMessage","type":"string","required":false},{"name":"field","type":"","required":true},{"name":"groups","required":false,"description":"Array of available collections, field options contain option id's\n`{ id: number label: string options: Option[] groupId?: string | number }`\n`arrayOf: [object]`"},{"name":"loading","type":"boolean","required":false},{"name":"onBlur","type":"FocusEventHandler","required":false},{"name":"onFocus","type":"FocusEventHandler","required":false},{"name":"onScrollBottom","required":false},{"name":"optgroups","required":false,"description":"Array of available option groups"},{"name":"options","required":false},{"name":"placeholder","type":"string","required":false},{"name":"placement","type":"","required":false},{"name":"qa","type":"QaTags","required":false},{"name":"tabIndex","type":"number","required":false},{"name":"value","required":false},{"name":"getGroup","required":true,"description":"Callback for each entry in groups for keying and optimizations\n`(option: T) => Option[]`"},{"name":"getId","required":true,"description":"<div>\n The id of an option{' '}\n <Code>{'(option: OptionItem) => string | number'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.id'}</Code>\n</div>"},{"name":"getLabel","type":"string","required":true,"description":"<div>\n The display label of an option\n <Code>{'(option: OptionItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.label || option.name'}</Code>\n</div>"},{"name":"getOptGroup","required":true,"description":"Callback for each entry in groups and options to define relation in optgroups\n`(option: OptionItem) => number | string`"},{"name":"groupRenderer","type":"ReactNode","required":true,"description":"Callback for rendering each group option\n`(groupOption: T, props: OptionRendererProps) => React.ReactNode`"},{"name":"isOptionDisabled","type":"boolean","required":true},{"name":"onChange","type":"void","required":true,"description":"Callback with options selected when selecting or removing an option\n`(value: T[]) => void`"},{"name":"onSearch","type":"void","required":true},{"name":"optGroupRenderer","type":"ReactNode","required":true,"description":"Callback for rendering header for each entry in `optgroups`\n`(group: GroupItem) => React.ReactNode`"},{"name":"optionRenderer","type":"ReactNode","required":true,"description":"Callback for rendering each option\n`(option: T, props: OptionRendererProps) => React.ReactNode`"},{"name":"tokenRenderer","type":"ReactNode","required":true,"description":"Callback for rendering each selected value\n<CodeBlock>\n {'(props: TokenRendererProps) => React.ReactNode'}\n</CodeBlock>"}],"FieldGroupSelectProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false},{"name":"children","required":false},{"name":"className","type":"string","required":false},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"emptyMessage","type":"string","required":false},{"name":"error","required":false},{"name":"groups","required":false,"description":"Array of available collections, field options contain option id's\n`{ id: number label: string options: Option[] groupId?: string | number }`\n`arrayOf: [object]`"},{"name":"label","type":"string","required":false},{"name":"loading","type":"boolean","required":false},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"onBlur","type":"FocusEventHandler","required":false},{"name":"onFocus","type":"FocusEventHandler","required":false},{"name":"onScrollBottom","required":false},{"name":"optgroups","required":false,"description":"Array of available option groups"},{"name":"options","required":false},{"name":"placeholder","type":"string","required":false},{"name":"placement","type":"","required":false},{"name":"qa","type":"QaTags","required":false},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"tabIndex","type":"number","required":false},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"value","required":false},{"name":"view","required":false,"description":"Determines show or edit state of field."},{"name":"getGroup","required":true,"description":"Callback for each entry in groups for keying and optimizations\n`(option: T) => Option[]`"},{"name":"getId","required":true,"description":"<div>\n The id of an option{' '}\n <Code>{'(option: OptionItem) => string | number'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.id'}</Code>\n</div>"},{"name":"getLabel","type":"string","required":true,"description":"<div>\n The display label of an option\n <Code>{'(option: OptionItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.label || option.name'}</Code>\n</div>"},{"name":"getOptGroup","required":true,"description":"Callback for each entry in groups and options to define relation in optgroups\n`(option: OptionItem) => number | string`"},{"name":"groupRenderer","type":"ReactNode","required":true,"description":"Callback for rendering each group option\n`(groupOption: T, props: OptionRendererProps) => React.ReactNode`"},{"name":"isOptionDisabled","type":"boolean","required":true},{"name":"onChange","type":"void","required":true,"description":"Callback with options selected when selecting or removing an option\n`(value: T[]) => void`"},{"name":"onSearch","type":"void","required":true},{"name":"optGroupRenderer","type":"ReactNode","required":true,"description":"Callback for rendering header for each entry in `optgroups`\n`(group: GroupItem) => React.ReactNode`"},{"name":"optionRenderer","type":"ReactNode","required":true,"description":"Callback for rendering each option\n`(option: T, props: OptionRendererProps) => React.ReactNode`"},{"name":"tokenRenderer","type":"ReactNode","required":true,"description":"Callback for rendering each selected value\n<CodeBlock>\n {'(props: TokenRendererProps) => React.ReactNode'}\n</CodeBlock>"}],"FieldMultiSelectComponentProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false},{"name":"className","type":"string","required":false},{"name":"disabled","type":"boolean","required":false},{"name":"emptyMessage","type":"string","required":false},{"name":"field","type":"","required":true},{"name":"getGroup","required":false},{"name":"loading","type":"boolean","required":false},{"name":"onBlur","type":"FocusEventHandler","required":false},{"name":"onFocus","type":"FocusEventHandler","required":false},{"name":"onScrollBottom","required":false},{"name":"onSearch","required":false},{"name":"optgroups","required":false,"description":"Array of available option groups"},{"name":"options","required":false},{"name":"placeholder","type":"string","required":false},{"name":"placement","type":"","required":false},{"name":"qa","type":"QaTags","required":false},{"name":"tabIndex","type":"number","required":false},{"name":"value","required":false,"description":"Array of the currently selected values"},{"name":"getId","required":true,"description":"<div>\n The id of an option{' '}\n <Code>{'(option: OptionItem) => string | number'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.id'}</Code>\n</div>"},{"name":"getLabel","type":"string","required":true,"description":"<div>\n The display label of an option\n <Code>{'(option: OptionItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.label || option.name'}</Code>\n</div>"},{"name":"groupHeaderRenderer","type":"ReactNode","required":true,"description":"Callback for rendering header for each entry in <Code>groups</Code>\n<CodeBlock>{'(group: GroupItem) => React.ReactNode'}</CodeBlock>"},{"name":"isOptionDisabled","type":"boolean","required":true},{"name":"onChange","type":"void","required":true},{"name":"optionRenderer","type":"ReactNode","required":true},{"name":"tokenRenderer","type":"ReactNode","required":true,"description":"Callback for rendering each selected value\n<CodeBlock>\n {'(props: TokenRendererProps) => React.ReactNode'}\n</CodeBlock>"}],"FieldMultiSelectProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false},{"name":"children","required":false},{"name":"className","type":"string","required":false},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"emptyMessage","type":"string","required":false},{"name":"error","required":false},{"name":"getGroup","required":false},{"name":"label","type":"string","required":false},{"name":"loading","type":"boolean","required":false},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"onBlur","type":"FocusEventHandler","required":false},{"name":"onFocus","type":"FocusEventHandler","required":false},{"name":"onScrollBottom","required":false},{"name":"onSearch","required":false},{"name":"optgroups","required":false,"description":"Array of available option groups"},{"name":"options","required":false},{"name":"placeholder","type":"string","required":false},{"name":"placement","type":"","required":false},{"name":"qa","type":"QaTags","required":false},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"tabIndex","type":"number","required":false},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"value","required":false,"description":"Array of the currently selected values"},{"name":"view","required":false,"description":"Determines show or edit state of field."},{"name":"getId","required":true,"description":"<div>\n The id of an option{' '}\n <Code>{'(option: OptionItem) => string | number'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.id'}</Code>\n</div>"},{"name":"getLabel","type":"string","required":true,"description":"<div>\n The display label of an option\n <Code>{'(option: OptionItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.label || option.name'}</Code>\n</div>"},{"name":"groupHeaderRenderer","type":"ReactNode","required":true,"description":"Callback for rendering header for each entry in <Code>groups</Code>\n<CodeBlock>{'(group: GroupItem) => React.ReactNode'}</CodeBlock>"},{"name":"isOptionDisabled","type":"boolean","required":true},{"name":"onChange","type":"void","required":true},{"name":"optionRenderer","type":"ReactNode","required":true},{"name":"tokenRenderer","type":"ReactNode","required":true,"description":"Callback for rendering each selected value\n<CodeBlock>\n {'(props: TokenRendererProps) => React.ReactNode'}\n</CodeBlock>"}],"FieldNumberComponentProps":[{"name":"decimalScale","required":false,"description":"The maximum number of fraction digits to use. Possible values range from 0 to 14. Setting to true will result in the maximum size, setting to false will allow 0 decimals, whole numbers only.","defaultValue":"true\n"},{"name":"defaultValue","type":"","required":false,"description":"Initial value of an uncontrolled component"},{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"field","type":"","required":true},{"name":"fillDecimalScale","type":"","required":false,"description":"<Code>none</Code> prevents from adding zeros to match given\n<Code>decimalScale</Code>.<br /> <Code>always</Code> automatically adds\nzeros to match given\n<Code>decimalScale</Code>. <br />\n<Code>onBlur</Code> automatically adds zeros to match given{' '}\n<Code>decimalScale</Code> when input has lost focus."},{"name":"locale","type":"","required":false,"description":"A string with a BCP 47 language tag or an array of such strings which specifies number formatting.","defaultValue":"en-US\n"},{"name":"prefix","type":"string","required":false,"description":"A string which is added to input as a prefix."},{"name":"qa","type":"QaTags","required":false},{"name":"step","type":"number","required":false,"description":"A stepping interval which is used in incrementer. Zero value turns off incrementer.","defaultValue":"0\n"},{"name":"suffix","type":"string","required":false,"description":"A string which is added to input as a suffix"},{"name":"value","type":"","required":false,"description":"Value of a controlled component"},{"name":"onChange","type":"void","required":true,"description":"`(value: ValueChange) => void`, where `ValueChange` is an object `{ value: string, parsedNumber: number | null }`."}],"FieldNumberProps":[{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"children","required":false},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"error","required":false},{"name":"label","type":"string","required":false},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"view","required":false,"description":"Determines show or edit state of field."}],"FieldPillSelectComponentProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false,"description":"Make the Select button 100% width"},{"name":"disabled","type":"boolean","required":false},{"name":"emptyMessage","type":"string","required":false,"description":"When there are no children this will render"},{"name":"field","type":"","required":true},{"name":"footer","type":"ReactNode","required":false},{"name":"hideDelay","type":"number","required":false},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the select's configurable strings.\nDefaults to using the core library's default strings."},{"name":"loading","type":"boolean","required":false,"description":"If the select is loading"},{"name":"onClear","required":false},{"name":"onScrollBottom","required":false},{"name":"onSelect","required":false},{"name":"optgroups","required":false,"description":"Array of available option groups"},{"name":"options","required":false,"description":"Array of available options"},{"name":"optionsRef","type":"RefObject","required":false},{"name":"placeholder","type":"string","required":false,"description":"Renders when the label is blank"},{"name":"placement","type":"","required":false,"description":"The placement of the overlay"},{"name":"qa","type":"Partial","required":false},{"name":"showDelay","type":"number","required":false},{"name":"tabIndex","type":"number","required":false,"description":"Configurable tabIndex for the select button"},{"name":"getColor","type":"","required":true,"description":"A function returning the display color of an option's `Pill`\n`(option: unknown) => PillColor`","defaultValue":"`(option) => (option as PillOption).color`\n"},{"name":"getGroup","required":true,"description":"A function returning group ID for a given option to define a relation to `optgroups`\n`(option: unknown) => string | number`","defaultValue":"`(option) => (option as PillOption).groupId`\n"},{"name":"getId","type":"Id","required":true,"description":"A function returning ID of a given option\n`(option: unknown) => string | number`","defaultValue":"`(option) => (option as PillOption).id`\n"},{"name":"getLabel","type":"string","required":true,"description":"A function returning label of an option\n`(option: unknown) => string`","defaultValue":"`(option) => (option as PillOption).label`\n"},{"name":"getSuggested","required":true,"description":"A function returning `boolean` value to suggest this option if nothing is selected.\n`(option: unknown) => boolean`","defaultValue":"`(option) => (option as PillOption).suggested`\n"},{"name":"groupGetId","type":"Id","required":true,"description":"A function returning the ID of a group\n`(group: unknown) => string | number`","defaultValue":"`(group) => (group as PillOptgroup).id`\n"},{"name":"groupGetLabel","type":"string","required":true,"description":"A function returning label of a group\n`(group: unknown) => string`","defaultValue":"`(group) => (group as PillOptgroup).label`\n"},{"name":"onSearch","type":"void","required":true,"description":"Adds a search bar to the select."}],"FieldPillSelectProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false,"description":"Make the Select button 100% width"},{"name":"children","required":false},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"emptyMessage","type":"string","required":false,"description":"When there are no children this will render"},{"name":"error","required":false},{"name":"footer","type":"ReactNode","required":false},{"name":"hideDelay","type":"number","required":false},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the select's configurable strings.\nDefaults to using the core library's default strings."},{"name":"label","type":"string","required":false},{"name":"loading","type":"boolean","required":false,"description":"If the select is loading"},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"onClear","required":false},{"name":"onScrollBottom","required":false},{"name":"onSelect","required":false},{"name":"optgroups","required":false,"description":"Array of available option groups"},{"name":"options","required":false,"description":"Array of available options"},{"name":"optionsRef","type":"RefObject","required":false},{"name":"placeholder","type":"string","required":false,"description":"Renders when the label is blank"},{"name":"placement","type":"","required":false,"description":"The placement of the overlay"},{"name":"qa","type":"Partial","required":false},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"showDelay","type":"number","required":false},{"name":"tabIndex","type":"number","required":false,"description":"Configurable tabIndex for the select button"},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"view","required":false,"description":"Determines show or edit state of field."},{"name":"getColor","type":"","required":true,"description":"A function returning the display color of an option's `Pill`\n`(option: unknown) => PillColor`","defaultValue":"`(option) => (option as PillOption).color`\n"},{"name":"getGroup","required":true,"description":"A function returning group ID for a given option to define a relation to `optgroups`\n`(option: unknown) => string | number`","defaultValue":"`(option) => (option as PillOption).groupId`\n"},{"name":"getId","type":"Id","required":true,"description":"A function returning ID of a given option\n`(option: unknown) => string | number`","defaultValue":"`(option) => (option as PillOption).id`\n"},{"name":"getLabel","type":"string","required":true,"description":"A function returning label of an option\n`(option: unknown) => string`","defaultValue":"`(option) => (option as PillOption).label`\n"},{"name":"getSuggested","required":true,"description":"A function returning `boolean` value to suggest this option if nothing is selected.\n`(option: unknown) => boolean`","defaultValue":"`(option) => (option as PillOption).suggested`\n"},{"name":"groupGetId","type":"Id","required":true,"description":"A function returning the ID of a group\n`(group: unknown) => string | number`","defaultValue":"`(group) => (group as PillOptgroup).id`\n"},{"name":"groupGetLabel","type":"string","required":true,"description":"A function returning label of a group\n`(group: unknown) => string`","defaultValue":"`(group) => (group as PillOptgroup).label`\n"},{"name":"onSearch","type":"void","required":true,"description":"Adds a search bar to the select."}],"FieldProps":[{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"children","required":false},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"error","required":false},{"name":"label","type":"string","required":false},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"view","required":false,"description":"Determines show or edit state of field."}],"FieldRadioButtonsComponentProps":[{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"field","type":"","required":true},{"name":"options","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"getId","required":true,"description":"<div>\n The id of an option{' '}\n <Code>{'(option: OptionItem) => string | number'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.id'}</Code>\n</div>"},{"name":"getLabel","type":"string","required":true,"description":"<div>\n The display label of an option\n <Code>{'(option: OptionItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.label || option.name'}</Code>\n</div>"},{"name":"isDisabledOption","type":"boolean","required":true}],"FieldRadioButtonsProps":[{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"children","required":false},{"name":"className","type":"string","required":false,"description":"Additional classNames"},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"error","required":false},{"name":"label","type":"string","required":false},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"options","required":false},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"view","required":false,"description":"Determines show or edit state of field."},{"name":"getId","required":true,"description":"<div>\n The id of an option{' '}\n <Code>{'(option: OptionItem) => string | number'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.id'}</Code>\n</div>"},{"name":"getLabel","type":"string","required":true,"description":"<div>\n The display label of an option\n <Code>{'(option: OptionItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.label || option.name'}</Code>\n</div>"},{"name":"isDisabledOption","type":"boolean","required":true}],"FieldRichTextComponentProps":[{"name":"disabled","type":"boolean","required":false},{"name":"error","type":"boolean","required":false},{"name":"field","type":"","required":true},{"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>"}],"FieldRichTextProps":[{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"children","required":false},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"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":"label","type":"string","required":false},{"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":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"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":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"view","required":false,"description":"Determines show or edit state of field."},{"name":"onChange","type":"void","required":true,"description":"<div>onChange event handler for text editor area</div>\n<CodeBlock>(content: string) => void</CodeBlock>"}],"FieldSelectComponentProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false,"description":"Make the Select button 100% width"},{"name":"disabled","type":"boolean","required":false},{"name":"emptyMessage","type":"string","required":false,"description":"When there are no children this will render"},{"name":"field","type":"","required":true},{"name":"footer","type":"ReactNode","required":false},{"name":"hideDelay","type":"number","required":false},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the select's configurable strings.\nDefaults to using the core library's default strings."},{"name":"label","type":"ReactNode","required":false},{"name":"loading","type":"boolean","required":false,"description":"If the select is loading"},{"name":"onClear","required":false,"description":"Callback for when cleared. Default enabled, has clear icon."},{"name":"onScrollBottom","required":false},{"name":"onSearch","required":false,"description":"Callback for when searching. Default enabled, has seach bar in menu."},{"name":"onSelect","required":false},{"name":"optgroups","required":false,"description":"Array of available option groups"},{"name":"options","required":false},{"name":"optionsRef","type":"RefObject","required":false},{"name":"placeholder","type":"string","required":false,"description":"Renders when the label is blank"},{"name":"placement","type":"","required":false,"description":"The placement of the overlay"},{"name":"qa","type":"Partial","required":false},{"name":"showDelay","type":"number","required":false},{"name":"tabIndex","type":"number","required":false,"description":"Configurable tabIndex for the select button"},{"name":"getGroup","required":true,"description":"Callback for each entry in <Code>options</Code> to define relation to\ngroup in <Code>optgroups</Code>\n<Code>{'(option: OptionItem) => string | number'}</Code>"},{"name":"getId","required":true,"description":"<div>\n The id of an option{' '}\n <Code>{'(option: OptionItem) => string | number'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.id'}</Code>\n</div>"},{"name":"getLabel","type":"string","required":true,"description":"<div>\n The display label of an option\n <Code>{'(option: OptionItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.label || option.name'}</Code>\n</div>"},{"name":"groupGetId","required":true},{"name":"groupGetLabel","type":"string","required":true,"description":"<div>\n The display label of a group\n <Code>{'(group: GroupItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(group: GroupItem) => group.label || group.name'}</Code>\n</div>"},{"name":"groupHeaderRenderer","type":"ReactNode","required":true,"description":"Callback for rendering header for each entry in <Code>optgroups</Code>\n<Code>{'(group: GroupItem) => React.ReactNode'}</Code>"},{"name":"isSuggestedOption","type":"boolean","required":true,"description":"If nothing is selected, suggest this option. From{' '}\n<Code>{'Select.Option suggested'}</Code>.\n<Code>{'(option: OptionItem) => boolean'}</Code>"},{"name":"onBlur","type":"void","required":true},{"name":"optionRenderer","type":"ReactNode","required":true,"description":"Callback for rendering each <Code>option</Code>\n<Code>{'(option: OptionItem) => React.ReactNode'}</Code>"},{"name":"searchComparator","type":"boolean","required":true,"description":"<div>Customize how search works</div>\n<Code>{'(query: string, value: string) => boolean'}</Code>"}],"FieldSelectProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false,"description":"Make the Select button 100% width"},{"name":"children","required":false},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"emptyMessage","type":"string","required":false,"description":"When there are no children this will render"},{"name":"error","required":false},{"name":"footer","type":"ReactNode","required":false},{"name":"hideDelay","type":"number","required":false},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the select's configurable strings.\nDefaults to using the core library's default strings."},{"name":"label","type":"string","required":false},{"name":"loading","type":"boolean","required":false,"description":"If the select is loading"},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"onClear","required":false,"description":"Callback for when cleared. Default enabled, has clear icon."},{"name":"onScrollBottom","required":false},{"name":"onSearch","required":false,"description":"Callback for when searching. Default enabled, has seach bar in menu."},{"name":"onSelect","required":false},{"name":"optgroups","required":false,"description":"Array of available option groups"},{"name":"options","required":false},{"name":"optionsRef","type":"RefObject","required":false},{"name":"placeholder","type":"string","required":false,"description":"Renders when the label is blank"},{"name":"placement","type":"","required":false,"description":"The placement of the overlay"},{"name":"qa","type":"Partial","required":false},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"showDelay","type":"number","required":false},{"name":"tabIndex","type":"number","required":false,"description":"Configurable tabIndex for the select button"},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"view","required":false,"description":"Determines show or edit state of field."},{"name":"getGroup","required":true,"description":"Callback for each entry in <Code>options</Code> to define relation to\ngroup in <Code>optgroups</Code>\n<Code>{'(option: OptionItem) => string | number'}</Code>"},{"name":"getId","required":true,"description":"<div>\n The id of an option{' '}\n <Code>{'(option: OptionItem) => string | number'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.id'}</Code>\n</div>"},{"name":"getLabel","type":"string","required":true,"description":"<div>\n The display label of an option\n <Code>{'(option: OptionItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.label || option.name'}</Code>\n</div>"},{"name":"groupGetId","required":true},{"name":"groupGetLabel","type":"string","required":true,"description":"<div>\n The display label of a group\n <Code>{'(group: GroupItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(group: GroupItem) => group.label || group.name'}</Code>\n</div>"},{"name":"groupHeaderRenderer","type":"ReactNode","required":true,"description":"Callback for rendering header for each entry in <Code>optgroups</Code>\n<Code>{'(group: GroupItem) => React.ReactNode'}</Code>"},{"name":"isSuggestedOption","type":"boolean","required":true,"description":"If nothing is selected, suggest this option. From{' '}\n<Code>{'Select.Option suggested'}</Code>.\n<Code>{'(option: OptionItem) => boolean'}</Code>"},{"name":"onBlur","type":"void","required":true},{"name":"optionRenderer","type":"ReactNode","required":true,"description":"Callback for rendering each <Code>option</Code>\n<Code>{'(option: OptionItem) => React.ReactNode'}</Code>"},{"name":"searchComparator","type":"boolean","required":true,"description":"<div>Customize how search works</div>\n<Code>{'(query: string, value: string) => boolean'}</Code>"}],"FieldTextAreaComponentProps":[{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `TextArea`, changing the\nbackground color and border colors to red"},{"name":"field","type":"","required":true},{"name":"resize","required":false,"description":"Controls the resize rules for the `TextArea`"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead\n"}],"FieldTextAreaProps":[{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"children","required":false},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"error","required":false},{"name":"label","type":"string","required":false},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"resize","required":false,"description":"Controls the resize rules for the `TextArea`"},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead\n"},{"name":"view","required":false,"description":"Determines show or edit state of field."}],"FieldTextComponentProps":[{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"field","type":"","required":true},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead\n"}],"FieldTextProps":[{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"children","required":false},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"error","required":false},{"name":"label","type":"string","required":false},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead\n"},{"name":"view","required":false,"description":"Determines show or edit state of field."}],"FieldTieredSelectComponentProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false},{"name":"disabled","type":"boolean","required":false},{"name":"field","type":"","required":true},{"name":"getValueString","type":"GetValueString","required":false},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the tiered select's configurable strings. Defaults to using the core library's default strings."},{"name":"loading","type":"boolean","required":false},{"name":"loadingMore","type":"boolean","required":false,"description":"Used to display a loading indicator as the last item of the list. Can\nbe used with <Code>onScrollBottom</Code> or <Code>onSearch</Code>{' '}\n(empty <Code>options</Code> during search async call) to indicate the\nloading of new items."},{"name":"onClear","required":false},{"name":"onScrollBottom","required":false},{"name":"onSearch","required":false},{"name":"options","required":false},{"name":"selectableTiers","type":"boolean","required":false,"description":"If true, any tier is selectable. If false, only leaf nodes are selectable"},{"name":"tabIndex","type":"number","required":false},{"name":"value","required":false,"description":"Flat array of tier objects that represents the selected value"},{"name":"getGroupId","type":"Id","required":true,"description":"Callback for using a custom <Code>tier</Code> shape\n<CodeBlock>{'(tier: any) => Id'}</CodeBlock>\nDefaults to <CodeBlock>{'(tier: any) => tier.GroupId'}</CodeBlock>"},{"name":"getId","required":true,"description":"<div>\n The id of an option{' '}\n <Code>{'(option: OptionItem) => string | number'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.id'}</Code>\n</div>"},{"name":"getLabel","type":"string","required":true,"description":"<div>\n The display label of an option\n <Code>{'(option: OptionItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.label || option.name'}</Code>\n</div>"},{"name":"getNextGroupId","type":"Id","required":true,"description":"Callback for using a custom <Code>tier</Code> shape\n<CodeBlock>{'(tier: any) => Id'}</CodeBlock>\nDefaults to <CodeBlock>{'(tier: any) => tier.NextGroupId'}</CodeBlock>"},{"name":"isLeaf","type":"boolean","required":true},{"name":"isTierDisabled","required":true},{"name":"onChange","type":"void","required":true,"description":"<div>\n Callback for selecting an item from the tiered select. Returns the{' '}\n <Code>Selection</Code> object from the <Code>Menu</Code> api, along\n with the updated <Code>value</Code>\n</div>\n<CodeBlock>\n {'(Selection: { event, item, group }, value) =>'}\n</CodeBlock>"},{"name":"onNavigate","type":"void","required":true,"description":"Callback for when navigation occurs. Triggered by the left and right\narrow keys, or clicking a navigable item. Returns the id of the next\ngroup that will be navigated to, and the updated path.\n<CodeBlock>\n {'(nextGroupId: string | number | undefined, path: any[]) => '}\n</CodeBlock>"},{"name":"onQuickCreate","type":"void","required":true,"description":"Pass this callback when a quick create experience is desired. Called\nwhen the \"create\" button in quick create mode is clicked. Returns the\nvalue of the quick create input.\n<CodeBlock>{'(string) =>'}</CodeBlock>"}],"FieldTieredSelectProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false},{"name":"children","required":false},{"name":"colStart","required":false,"description":"Starting location of column. For traditional variant, this does not exist\nand is not necessary."},{"name":"colWidth","required":false,"description":"Width of column. For traditional variant, will be either 6 or 12."},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"error","required":false},{"name":"getValueString","type":"GetValueString","required":false},{"name":"i18nScope","type":"string","required":false,"description":"The i18n key to use for the tiered select's configurable strings. Defaults to using the core library's default strings."},{"name":"label","type":"string","required":false},{"name":"loading","type":"boolean","required":false},{"name":"loadingMore","type":"boolean","required":false,"description":"Used to display a loading indicator as the last item of the list. Can\nbe used with <Code>onScrollBottom</Code> or <Code>onSearch</Code>{' '}\n(empty <Code>options</Code> during search async call) to indicate the\nloading of new items."},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"onClear","required":false},{"name":"onScrollBottom","required":false},{"name":"onSearch","required":false},{"name":"options","required":false},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"selectableTiers","type":"boolean","required":false,"description":"If true, any tier is selectable. If false, only leaf nodes are selectable"},{"name":"tabIndex","type":"number","required":false},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"value","required":false,"description":"Flat array of tier objects that represents the selected value"},{"name":"view","required":false,"description":"Determines show or edit state of field."},{"name":"getGroupId","type":"Id","required":true,"description":"Callback for using a custom <Code>tier</Code> shape\n<CodeBlock>{'(tier: any) => Id'}</CodeBlock>\nDefaults to <CodeBlock>{'(tier: any) => tier.GroupId'}</CodeBlock>"},{"name":"getId","required":true,"description":"<div>\n The id of an option{' '}\n <Code>{'(option: OptionItem) => string | number'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.id'}</Code>\n</div>"},{"name":"getLabel","type":"string","required":true,"description":"<div>\n The display label of an option\n <Code>{'(option: OptionItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.label || option.name'}</Code>\n</div>"},{"name":"getNextGroupId","type":"Id","required":true,"description":"Callback for using a custom <Code>tier</Code> shape\n<CodeBlock>{'(tier: any) => Id'}</CodeBlock>\nDefaults to <CodeBlock>{'(tier: any) => tier.NextGroupId'}</CodeBlock>"},{"name":"isLeaf","type":"boolean","required":true},{"name":"isTierDisabled","required":true},{"name":"onChange","type":"void","required":true,"description":"<div>\n Callback for selecting an item from the tiered select. Returns the{' '}\n <Code>Selection</Code> object from the <Code>Menu</Code> api, along\n with the updated <Code>value</Code>\n</div>\n<CodeBlock>\n {'(Selection: { event, item, group }, value) =>'}\n</CodeBlock>"},{"name":"onNavigate","type":"void","required":true,"description":"Callback for when navigation occurs. Triggered by the left and right\narrow keys, or clicking a navigable item. Returns the id of the next\ngroup that will be navigated to, and the updated path.\n<CodeBlock>\n {'(nextGroupId: string | number | undefined, path: any[]) => '}\n</CodeBlock>"},{"name":"onQuickCreate","type":"void","required":true,"description":"Pass this callback when a quick create experience is desired. Called\nwhen the \"create\" button in quick create mode is clicked. Returns the\nvalue of the quick create input.\n<CodeBlock>{'(string) =>'}</CodeBlock>"}],"FormContextAPI":[{"name":"different","type":"boolean","required":true},{"name":"disabled","type":"boolean","required":true},{"name":"enableReinitialize","type":"boolean","required":false},{"name":"validationSchema","type":"any","required":false,"description":"A <a href=\"https://github.com/jquense/yup\">Yup</a> object schema to\nvalidate all values.\n<CodeBlock>\n {`Yup.object().shape({\n   input_name: Yup.mixed().required()\n })`}\n</CodeBlock>\nThis is a great way to get error messages into the component. In\naddition, if using Yup for required, those fields will automatically\nget the required asterisk and highlight error."},{"name":"variant","required":true,"description":"Toggle between modern and traditional form styles. Leave blank for the\nmodern label-above layout."},{"name":"view","required":true,"description":"Determines show or edit state of form."},{"name":"setFieldDifferent","type":"void","required":true}],"FormErrorBannerProps":[{"name":"i18nScope","type":"string","required":false},{"name":"item","type":"string","required":true}],"FormProps":[{"name":"children","type":"ReactNode","required":true},{"name":"disabled","type":"boolean","required":false,"description":"Disable all fields at once."},{"name":"enableConfirmNavigation","type":"boolean","required":false,"description":"Enable a browser confirmation about losing of unsaved data when the\nform values are visually different from the initial values. Uses{' '}\n<Code>window.onbeforeunload</Code>"},{"name":"variant","required":false,"description":"Toggle between modern and traditional form styles. Leave blank for the modern label-above layout."},{"name":"view","required":false,"description":"Determines show or edit state of form."}],"GroupedOptionsConfig":[{"name":"optgroups","required":false},{"name":"options","required":false},{"name":"value","type":"","required":false},{"name":"comparator","type":"boolean","required":true},{"name":"getGroup","required":true},{"name":"getId","required":true,"description":"<div>\n The id of an option{' '}\n <Code>{'(option: OptionItem) => string | number'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.id'}</Code>\n</div>"},{"name":"getLabel","type":"string","required":true,"description":"<div>\n The display label of an option\n <Code>{'(option: OptionItem) => string'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(option: OptionItem) => option.label || option.name'}</Code>\n</div>"},{"name":"groupGetId","required":true,"description":"<div>\n The id of group{' '}\n <Code>{'(group: GroupItem) => string | number'}</Code>\n</div>\n<br />\n<div>\n Default:\n <Code>{'(group) => group.id'}</Code>\n</div>"}],"TraditionalBaseFieldProps":[{"name":"as","required":false,"description":"Customize the input component, either a single component for all views\nor an object with the keys of the views to render on that particular\nview. This input component will receive the <Code>field</Code> prop.\nIf using TypeScript, these components will need to extend a specific\ntype from Core React, read more about the{' '}\n<a href=\"#typescript-and-as-prop-components\">props per view</a>.\n<br />\n<br />\nOne of:\n<br />\n<Code>ReactComponent</Code>or\n<Code>\n{\n   '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'\n}\n</Code>"},{"name":"children","required":false,"description":"A subcomponent to render on a particular view.\n<br />\n<br />\nOne or all of:\n<br />\n<Code>Form.X.Create, Form.X.Read, Form.X.Update</Code>"},{"name":"colWidth","required":false},{"name":"data-qa","type":"string","required":false},{"name":"disabled","type":"boolean","required":false,"description":"Specify disabled. Field disabled replaces the overall Form disabled state."},{"name":"error","required":false},{"name":"label","type":"string","required":false},{"name":"name","type":"string","required":true,"description":"Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}\n<Code>dot.notation</Code>."},{"name":"required","type":"boolean","required":false,"description":"The required asterisk if not using Yup <Code>required</Code>\n<CodeBlock>\n{`<Form\nvalidationSchema={Yup.object().shape({\n input_name: Yup.mixed().required(),\n})}>`}\n</CodeBlock>"},{"name":"tooltip","type":"any","required":false},{"name":"validate","type":"FieldValidator","required":false,"description":"The validate function from Formik for single field validation.\n<CodeBlock>\n {`(value: Value = any) => undefined | string | Promise<Value>`}\n</CodeBlock>"},{"name":"view","required":false,"description":"Determines show or edit state of field."}]}

package/dist/props/Grid.json

@@ -0,0 +1 @@
+{"ColProps":[{"name":"children","type":"ReactNode","required":false},{"name":"lg","type":"number","required":false,"description":"Sets the width for large breakpoint"},{"name":"md","type":"number","required":false,"description":"Sets the width for medium breakpoint"},{"name":"sm","type":"number","required":false,"description":"Sets the width for small breakpoint"},{"name":"span","type":"number","required":false,"description":"Sets the same width across all breakpoints"},{"name":"xs","type":"number","required":false,"description":"Sets the width for extra small breakpoint"}],"LayoutGridProps":[{"name":"children","type":"ReactNode","required":false},{"name":"fluid","type":"boolean","required":false,"description":"Allow the grid be infinitely wide"},{"name":"style","type":"CSSProperties","required":false}],"RowProps":[{"name":"children","type":"ReactNode","required":false}]}

package/dist/props/GridSource.json

@@ -0,0 +1 @@
+{"GridProps":[{"name":"children","type":"ReactNode","required":false,"description":"React nodes to be displayed next to the search bar"},{"name":"emptyState","required":false,"description":"<Code>{`{ text: string, image: string }`}</Code> props for{' '}\n<Code>EmptyState</Code> component shown when there are no items in\ngrid"},{"name":"getGroupId","required":false,"description":"A function called returning group ID of a given grid item that is used\nto sort items by group. Returns <Code>item.groupId</Code>\nby default."},{"name":"getId","required":false,"description":"A function called returning ID of a given grid item that is used to\nidentify the item. Returns <Code>item.id</Code> by default."},{"name":"getThumbnailLabel","required":false,"description":"A function called returning label of a given grid item that is used to\ndisplay the item's thumbnail label. Returns <Code>item.label</Code>\nby default."},{"name":"getThumbnailName","required":false,"description":"A function called returning name of a given grid item that is used to\ndisplay the item's thumbnail name. Returns <Code>item.name</Code> by\ndefault."},{"name":"getThumbnailSource","required":false,"description":"A function called returning thumbnail URL of a given grid item that is\nused to display the item's thumbnail image. Returns{' '}\n<Code>item.src</Code>\nby default."},{"name":"groups","required":false,"description":"<Code>{`{ id: string | number, title: string }[]`}</Code> object\nrepresenting file groups"},{"name":"icon","type":"ReactNode","required":true,"deprecated":"String icon variant is deprecated, use the React components directly from the `@procore/core-icons/dist` package\n"},{"name":"isLoading","type":"boolean","required":false,"description":"Show/Hide loading indicator of the content"},{"name":"isLoadingMore","type":"boolean","required":false,"description":"Show/Hide loading indicator at the list bottom"},{"name":"items","required":true,"description":"An array of arbitrarily-shaped objects representing grid items.{' '}\n<Code>getId</Code> <Code>getName</Code> and <Code>getThumbnail</Code>{' '}\nshould be used to bind the target shape to a view."},{"name":"qa","type":"QaTags","required":false},{"name":"searchQuery","type":"string","required":false,"description":"Allows controlling the search input value. Can be used with\n<Code>onSearch</Code> to customize the default string-based search"},{"name":"sourceId","type":"string","required":true},{"name":"title","type":"string","required":true},{"name":"onScrollBottom","type":"Promise","required":true,"description":"Optional <Code>function</Code> that automatically executes when\nscrolling reaches the last item."},{"name":"onSearch","type":"void","required":true,"description":"Allows customizing the default string-based search by passing a\ndifferent set of <Code>items</Code> every time\n<Code>onSearch</Code> is called with query string as a single\nparameter"}],"SearchBarProps":[{"name":"query","type":"string","required":true},{"name":"onChange","type":"void","required":true}]}

package/dist/props/GroupSelect.json

@@ -1 +1 @@
-{"GroupSelectConfig":[{"name":"groups","required":true,"description":null,"defaultValue":null},{"name":"options","required":true,"description":null,"defaultValue":null},{"name":"value","required":true,"description":null,"defaultValue":null},{"name":"getGroup","type":"","required":true,"description":null,"defaultValue":null},{"name":"getId","type":"","required":true,"description":null,"defaultValue":null},{"name":"getLabel","type":"","required":true,"description":null,"defaultValue":null},{"name":"onChange","type":"","required":true,"description":null,"defaultValue":null},{"name":"onSearch","type":"","required":false,"description":null,"defaultValue":null}],"GroupSelectProps":[{"name":"afterHide","required":false,"description":null,"defaultValue":null},{"name":"afterShow","required":false,"description":null,"defaultValue":null},{"name":"beforeHide","type":"BeforeCallback","required":false,"description":null,"defaultValue":null},{"name":"beforeShow","type":"BeforeCallback","required":false,"description":null,"defaultValue":null},{"name":"block","type":"boolean","required":false,"description":null,"defaultValue":null},{"name":"className","type":"string","required":false,"description":null,"defaultValue":null},{"name":"disabled","type":"boolean","required":false,"description":null,"defaultValue":null},{"name":"emptyMessage","type":"string","required":false,"description":null,"defaultValue":null},{"name":"error","type":"boolean","required":false,"description":null,"defaultValue":null},{"name":"groups","required":false,"description":"Array of available collections, field options contain option id's\n`{ id: number label: string options: Option[] groupId?: string | number }`\n`arrayOf: [object]`","defaultValue":null},{"name":"loading","type":"boolean","required":false,"description":null,"defaultValue":null},{"name":"onBlur","type":"FocusEventHandler","required":false,"description":null,"defaultValue":null},{"name":"onFocus","type":"FocusEventHandler","required":false,"description":null,"defaultValue":null},{"name":"onScrollBottom","required":false,"description":null,"defaultValue":null},{"name":"optgroups","required":false,"description":null,"defaultValue":null},{"name":"options","required":false,"description":"Array of available options\n`{ id: number label: string groupId?: string | number }`\n`arrayOf: [object]`","defaultValue":null},{"name":"placeholder","type":"string","required":false,"description":null,"defaultValue":null},{"name":"placement","type":"","required":false,"description":null,"defaultValue":null},{"name":"qa","type":"QaTags","required":false,"description":null,"defaultValue":null},{"name":"tabIndex","type":"number","required":false,"description":null,"defaultValue":null},{"name":"value","required":false,"description":null,"defaultValue":null},{"name":"getGroup","type":"","required":false,"description":null,"defaultValue":null},{"name":"getId","type":"","required":false,"description":null,"defaultValue":null},{"name":"getLabel","type":"","required":false,"description":null,"defaultValue":null},{"name":"getOptGroup","type":"","required":false,"description":null,"defaultValue":null},{"name":"groupRenderer","type":"","required":false,"description":null,"defaultValue":null},{"name":"isOptionDisabled","type":"","required":false,"description":null,"defaultValue":null},{"name":"onChange","type":"","required":false,"description":null,"defaultValue":null},{"name":"onSearch","type":"","required":false,"description":null,"defaultValue":null},{"name":"optGroupRenderer","type":"","required":false,"description":null,"defaultValue":null},{"name":"optionRenderer","type":"","required":false,"description":null,"defaultValue":null},{"name":"tokenRenderer","type":"","required":false,"description":null,"defaultValue":null}],"OptionRendererProps":[{"name":"children","type":"ReactNode","required":false,"description":null,"defaultValue":null},{"name":"className","type":"string","required":false,"description":null,"defaultValue":null},{"name":"disabled","type":"boolean","required":false,"description":null,"defaultValue":null},{"name":"index","type":"number","required":false,"description":null,"defaultValue":null},{"name":"ref","type":"Ref","required":false,"description":null,"defaultValue":null},{"name":"selected","type":"boolean","required":false,"description":null,"defaultValue":null},{"name":"style","type":"CSSProperties","required":false,"description":null,"defaultValue":null},{"name":"value","type":"any","required":true,"description":null,"defaultValue":null},{"name":"getId","type":"","required":true,"description":null,"defaultValue":null},{"name":"getLabel","type":"","required":true,"description":null,"defaultValue":null}]}
+{"GroupSelectConfig":[{"name":"groups","required":true},{"name":"options","required":true},{"name":"value","required":true},{"name":"getGroup","required":true},{"name":"getId","required":true},{"name":"getLabel","type":"string","required":true},{"name":"onChange","type":"void","required":true},{"name":"onSearch","type":"void","required":true}],"GroupSelectProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false},{"name":"className","type":"string","required":false},{"name":"disabled","type":"boolean","required":false},{"name":"emptyMessage","type":"string","required":false},{"name":"error","type":"boolean","required":false},{"name":"groups","required":false,"description":"Array of available collections, field options contain option id's\n`{ id: number label: string options: Option[] groupId?: string | number }`\n`arrayOf: [object]`"},{"name":"loading","type":"boolean","required":false},{"name":"onBlur","type":"FocusEventHandler","required":false},{"name":"onFocus","type":"FocusEventHandler","required":false},{"name":"onScrollBottom","required":false},{"name":"optgroups","required":false,"description":"Array of available option groups"},{"name":"options","required":false,"description":"Array of available options\n`{ id: number label: string groupId?: string | number }`\n`arrayOf: [object]`"},{"name":"placeholder","type":"string","required":false},{"name":"placement","type":"","required":false},{"name":"qa","type":"QaTags","required":false},{"name":"tabIndex","type":"number","required":false},{"name":"value","required":false},{"name":"getGroup","required":true,"description":"Callback for each entry in groups for keying and optimizations\n`(option: T) => Option[]`"},{"name":"getId","required":true},{"name":"getLabel","type":"string","required":true,"description":"Callback for each entry in options to generate the token label, also used for default searching.\n`(option: T) => string`"},{"name":"getOptGroup","required":true,"description":"Callback for each entry in groups and options to define relation in optgroups\n`(option: OptionItem) => number | string`"},{"name":"groupRenderer","type":"ReactNode","required":true,"description":"Callback for rendering each group option\n`(groupOption: T, props: OptionRendererProps) => React.ReactNode`"},{"name":"isOptionDisabled","type":"boolean","required":true},{"name":"onChange","type":"void","required":true,"description":"Callback with options selected when selecting or removing an option\n`(value: T[]) => void`"},{"name":"onSearch","type":"void","required":true},{"name":"optGroupRenderer","type":"ReactNode","required":true,"description":"Callback for rendering header for each entry in `optgroups`\n`(group: GroupItem) => React.ReactNode`"},{"name":"optionRenderer","type":"ReactNode","required":true,"description":"Callback for rendering each option\n`(option: T, props: OptionRendererProps) => React.ReactNode`"},{"name":"tokenRenderer","type":"ReactNode","required":true,"description":"Callback for rendering each selected value\n<CodeBlock>\n {'(props: TokenRendererProps) => React.ReactNode'}\n</CodeBlock>"}],"OptionRendererProps":[{"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":"disabled","type":"boolean","required":false},{"name":"index","type":"number","required":false},{"name":"ref","type":"Ref","required":false},{"name":"selected","type":"boolean","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"value","type":"any","required":true},{"name":"getId","required":true},{"name":"getLabel","type":"string","required":true,"description":"Callback for each entry in options to generate the token label, also used for default searching.\n`(option: T) => string`"}]}

package/dist/props/Icon.json

@@ -0,0 +1 @@
+{"IconProps":[{"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":"string","required":true,"description":"The core-icon to show"},{"name":"size","type":"Extract","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"}],"SVGIconProps":[{"name":"fill","type":"string","required":false},{"name":"path","type":"string","required":true},{"name":"size","type":"Extract","required":true}]}

package/dist/props/IconLayout.json

@@ -0,0 +1 @@
+{}

package/dist/props/Input.json

@@ -0,0 +1 @@
+{"InputProps":[{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"variant","required":false,"deprecated":"Use the `error` prop instead\n"}]}

package/dist/props/LegacyDetailPage.json

@@ -0,0 +1 @@
+{"LegacyDetailPageProps":[{"name":"children","type":"ReactNode","required":false},{"name":"className","type":"string","required":false},{"name":"initialIsVisible","type":"boolean","required":true,"description":"Sets the sidebar to be initially open"},{"name":"style","type":"object","required":false}]}

package/dist/props/Link.json

@@ -1 +1 @@
-{"LinkProps":[{"name":"children","type":"ReactNode","required":false,"description":null,"defaultValue":null},{"name":"className","type":"string","required":false,"description":null,"defaultValue":null},{"name":"style","type":"CSSProperties","required":false,"description":null,"defaultValue":null},{"name":"variant","type":"LinkVariant","required":false,"description":"The color variant of the link","defaultValue":null}]}
+{"LinkProps":[{"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":"variant","type":"LinkVariant","required":false,"description":"The color variant of the link"}]}

package/dist/props/ListPage.json

@@ -0,0 +1 @@
+{"DivProps":[{"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"}],"ListPageControlProps":[{"name":"alignRight","type":"boolean","required":false,"description":"Controls whether the contents will align to the right"},{"name":"block","type":"boolean","required":false,"description":"Controls whether the contents will attmpt to span the full width"},{"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":"search","type":"boolean","required":false,"description":"Sets width to a specific size for Search to fit"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"variant","required":false,"deprecated":"please use the equivalent boolean prop instead\n"}]}

package/dist/props/LocalSource.json

@@ -0,0 +1 @@
+{"LocalSourceProps":[{"name":"accept","required":false,"description":"Set accepted file types. Accepts everything if left undefined"},{"name":"maxFileSize","type":"number","required":false,"description":"Maximum file size (in bytes)"},{"name":"minFileSize","type":"number","required":false,"description":"Minimum file size (in bytes)"},{"name":"onCancel","required":false},{"name":"qa","type":"","required":false},{"name":"sourceId","type":"string","required":true},{"name":"uploadFile","type":"UploadFile","required":false,"description":"<Code>\n (file: File,{' '}\n {`{\n   onProgress: (progress: number) => void\n   onSuccess: (response: unknown) => void\n   onError: (error: unknown) => void\n }`}\n ) => string\n</Code>\n<br />\n<br />A function for manually controlling the network request for file\nupload. An alternative to using <Code>getEndpoint</Code> which handles\nthe network request itself."},{"name":"beforeLocalFileUpload","type":"Promise","required":true,"description":"Optional async function that is invoked when selecting or dropping in a\nlocal file. If you want to restrict certain uploads, you can use this\ncallback. Returning true continues the upload, while false will prevent\nupload.\n<Code>{'(files: ThumbnailListItem[]) => Promise<boolean>'}</Code>"},{"name":"dropzoneContentRenderer","type":"ReactNode","required":true,"description":"An optional content renderer for the dropzone. Accepts{' '}\n<Code>{'{ open, disabled, errorMessage }'}</Code> as a single argument,\nallowing to control the dropzone and display different content depending\non dropzone state"},{"name":"getEndpoint","type":"string","required":true,"description":"<Code>(file: File) => string</Code>\n<br />\n<br />A function returning an upload URL for a given file. An\nalternative to <Code>uploadFile</Code> which allows manual control of\nthe network request for file upload."},{"name":"getHeaders","type":"Record","required":true,"description":"<Code>(file: File) => object</Code>\n<br />\n<br />A function returning an upload request headers. Returns empty\nobject by default."},{"name":"getMethod","type":"Method","required":true,"description":"<Code>(file: File) => HTTPRequestMethod</Code>\n<br />\n<br />A function returning an upload HTTP method for a given file.\nReturns <Code>POST</Code> by default."},{"name":"getPayload","type":"FormData","required":true,"description":"<Code>(file: File) => FormData</Code>\n<br />\n<br />A function returning an upload payload <Code>FormData</Code>{' '}\nobject for a given file. When defined, <Code>getPayloadKey</Code> is\nignored."},{"name":"getPayloadKey","type":"string","required":true,"description":"<Code>(file: File) => string</Code>\n<br />\n<br />A function returning an upload payload <Code>FormData</Code> key\nfor a given file. Returns <Code>file</Code> by default."}]}

package/dist/props/Menu.json

@@ -0,0 +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>"}]}

package/dist/props/MenuImperative.json

@@ -0,0 +1 @@
+{"DroppableProps":[{"name":"children","type":"ReactNode","required":true},{"name":"id","type":"string","required":true}],"FooterProps":[{"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}],"HeaderProps":[{"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}],"ItemProps":[{"name":"disabled","type":"boolean","required":false},{"name":"item","type":"any","required":true},{"name":"selected","type":"boolean","required":false},{"name":"suggested","type":"boolean","required":false}],"ItemWithDraggingProps":[{"name":"disabled","type":"boolean","required":false},{"name":"draggableId","type":"string","required":true},{"name":"draggableIndex","type":"number","required":true},{"name":"droppableIn","required":true},{"name":"item","type":"any","required":true},{"name":"selected","type":"boolean","required":false},{"name":"suggested","type":"boolean","required":false}],"MenuContext":[{"name":"currentlyDroppableIn","required":true},{"name":"onHoverItem","type":"void","required":true},{"name":"onScrollBottom","type":"void","required":true},{"name":"onSelect","type":"void","required":true}],"MenuRef":[{"name":"el","required":true},{"name":"highlight","type":"void","required":true},{"name":"highlightFirst","type":"void","required":true},{"name":"highlightLast","type":"void","required":true},{"name":"highlightSelected","type":"void","required":true},{"name":"highlightSuggested","type":"void","required":true},{"name":"highlighted","type":"any","required":true},{"name":"next","type":"void","required":true},{"name":"prev","type":"void","required":true},{"name":"select","type":"void","required":true}],"OptionsProps":[{"name":"children","type":"ReactNode","required":false},{"name":"className","type":"string","required":false}],"Reorder":[{"name":"destination","required":true},{"name":"draggableId","type":"string","required":true},{"name":"source","required":true}],"Selection":[{"name":"action","required":true},{"name":"event","required":true},{"name":"group","type":"boolean","required":true},{"name":"item","type":"any","required":true}]}

package/dist/props/Modal.json

@@ -1 +1 @@
-{"ConfirmModalProps":[{"name":"children","type":"ReactNode","required":false,"description":null,"defaultValue":null},{"name":"className","type":"string","required":false,"description":null,"defaultValue":null},{"name":"headline","type":"string","required":false,"description":null,"defaultValue":null},{"name":"open","type":"boolean","required":false,"description":"Modal open state","defaultValue":"false\n"},{"name":"placement","required":false,"description":"Vertical placement of the modal","defaultValue":"center\n"},{"name":"style","type":"CSSProperties","required":false,"description":null,"defaultValue":null},{"name":"width","required":false,"description":"Sets a width on the container and uses next centering. Future will default to `md`","defaultValue":null},{"name":"onClickOverlay","type":"","required":false,"description":null,"defaultValue":null},{"name":"onClose","type":"","required":false,"description":null,"defaultValue":null}],"ModalBodyProps":[{"name":"noSideSpacing","type":"boolean","required":false,"description":"Removes left, right paddings from the modal body when true","defaultValue":"false\n"}],"ModalCloseableHeaderProps":[{"name":"children","type":"ReactNode","required":false,"description":null,"defaultValue":null},{"name":"className","type":"string","required":false,"description":null,"defaultValue":null},{"name":"qa","required":false,"description":null,"defaultValue":null},{"name":"style","type":"CSSProperties","required":false,"description":null,"defaultValue":null},{"name":"onClose","type":"","required":false,"description":null,"defaultValue":null}],"ModalContainerProps":[{"name":"children","type":"ReactNode","required":false,"description":null,"defaultValue":null},{"name":"className","type":"string","required":false,"description":null,"defaultValue":null},{"name":"placement","required":true,"description":null,"defaultValue":null},{"name":"style","type":"CSSProperties","required":false,"description":null,"defaultValue":null},{"name":"width","required":false,"description":null,"defaultValue":null}],"ModalProps":[{"name":"children","type":"ReactNode","required":false,"description":null,"defaultValue":null},{"name":"className","type":"string","required":false,"description":null,"defaultValue":null},{"name":"open","type":"boolean","required":false,"description":"Modal open state","defaultValue":"false\n"},{"name":"placement","required":false,"description":"Vertical placement of the modal","defaultValue":"center\n"},{"name":"style","type":"CSSProperties","required":false,"description":null,"defaultValue":null},{"name":"width","required":false,"description":"Sets a width on the container and uses next centering. Future will default to `md`","defaultValue":null},{"name":"onClickOverlay","type":"","required":false,"description":null,"defaultValue":null}]}
+{"ConfirmModalProps":[{"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":"headline","type":"string","required":false,"description":"Headline message"},{"name":"open","type":"boolean","required":false,"description":"Modal open state","defaultValue":"false\n"},{"name":"placement","required":false,"description":"Vertical placement of the modal","defaultValue":"center\n"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"width","required":false,"description":"Sets a width on the container and uses next centering. Future will default to `md`"},{"name":"onClickOverlay","type":"void","required":true,"description":"Callback for clicking the overlay"},{"name":"onClose","type":"void","required":true,"description":"The dismiss onClick callback"}],"ModalBodyProps":[{"name":"noSideSpacing","type":"boolean","required":false,"description":"Removes left, right paddings from the modal body when true","defaultValue":"false\n"}],"ModalCloseableHeaderProps":[{"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":"qa","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"onClose","type":"void","required":true}],"ModalContainerProps":[{"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":"placement","required":true},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"width","required":false}],"ModalProps":[{"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":"open","type":"boolean","required":false,"description":"Modal open state","defaultValue":"false\n"},{"name":"placement","required":false,"description":"Vertical placement of the modal","defaultValue":"center\n"},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"},{"name":"width","required":false,"description":"Sets a width on the container and uses next centering. Future will default to `md`"},{"name":"onClickOverlay","type":"void","required":true,"description":"Callback for clicking the overlay"}]}

package/dist/props/MultiSelect.json

@@ -0,0 +1 @@
+{"MultiSelectProps":[{"name":"afterHide","required":false},{"name":"afterShow","required":false},{"name":"beforeHide","type":"BeforeCallback","required":false},{"name":"beforeShow","type":"BeforeCallback","required":false},{"name":"block","type":"boolean","required":false},{"name":"className","type":"string","required":false},{"name":"disabled","type":"boolean","required":false},{"name":"emptyMessage","type":"string","required":false},{"name":"error","type":"boolean","required":false},{"name":"getGroup","required":false},{"name":"getId","required":false},{"name":"getLabel","required":false},{"name":"loading","type":"boolean","required":false},{"name":"onBlur","type":"FocusEventHandler","required":false},{"name":"onFocus","type":"FocusEventHandler","required":false},{"name":"onScrollBottom","required":false},{"name":"onSearch","required":false},{"name":"optgroups","required":false,"description":"Array of available option groups"},{"name":"options","required":false,"description":"Array of available options"},{"name":"placeholder","type":"string","required":false},{"name":"placement","type":"","required":false},{"name":"qa","type":"QaTags","required":false},{"name":"tabIndex","type":"number","required":false},{"name":"value","required":false,"description":"Array of the currently selected values"},{"name":"groupHeaderRenderer","type":"ReactNode","required":true,"description":"Callback for rendering header for each entry in <Code>groups</Code>\n<CodeBlock>{'(group: GroupItem) => React.ReactNode'}</CodeBlock>"},{"name":"isOptionDisabled","type":"boolean","required":true},{"name":"onChange","type":"void","required":true},{"name":"optionRenderer","type":"ReactNode","required":true},{"name":"tokenRenderer","type":"ReactNode","required":true,"description":"Callback for rendering each selected value\n<CodeBlock>\n {'(props: TokenRendererProps) => React.ReactNode'}\n</CodeBlock>"}]}

package/dist/props/NextDetailPage.json

@@ -0,0 +1 @@
+{"NextDetailPageProps":[{"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":"width","type":"DetailPageWidth","required":false}]}

package/dist/props/NextGrid.json

@@ -1 +1 @@
-{"NextGridColProps":[{"name":"colStart","required":false,"description":"If given a number value between 1 and 12, sets start positions across all breakpoints.\nIf given an object, sets start positions for given breakpoints (keys in configuration object, e.g. {\"tabletMd\": 10, \"mobileLg\": 5}).","defaultValue":null},{"name":"colWidth","required":false,"defaultValue":"auto\nIf given a number value between 1 and 12, sets column width across all breakpoints.\nIf given an object, sets column widths for given breakpoints (keys in configuration object, e.g. {\"tabletMd\": 10, \"mobileLg\": 5}).\nIf set to \"auto\", the column will take all the available space\n"}],"NextGridContextShape":[{"name":"colStackCap","required":true,"description":null,"defaultValue":null},{"name":"gutterX","type":"NextGridSpacing","required":true,"description":null,"defaultValue":null},{"name":"gutterY","type":"NextGridSpacing","required":true,"description":null,"defaultValue":null}],"NextGridProps":[{"name":"colStackCap","required":false,"description":"Sets a breakpoing at which columns will start stacking on top of each other.\nE.g. if set to \"tabletMd\" - columns will stack on \"tabletMd\", \"tabletSm\" and \"mobileLg\" breakpoints.","defaultValue":null},{"name":"gutterX","type":"NextGridSpacing","required":false,"description":"If given a spacing string value (e.g. \"sm\" or \"none\"), sets horizontal column spacing across all breakpoints.\nIf given an object, sets horizontal column spacing for given breakpoints (keys in configuration object, e.g. {\"tabletMd\": \"xs\", \"mobileLg\": \"none\"}).","defaultValue":null},{"name":"gutterY","type":"NextGridSpacing","required":false,"description":"If given a spacing string value (e.g. \"sm\" or \"none\"), sets vertical column spacing across all breakpoints.\nVertical spacing is only displayed when the columns are stacked (typically, on smaller breakpoints or as defined by \"colStackCap\").\nIf given an object, sets vertical column spacing for given breakpoints (keys in configuration object, e.g. {\"tabletMd\": \"xs\", \"mobileLg\": \"none\"}).","defaultValue":null}]}
+{"NextGridColProps":[{"name":"colStart","required":false,"description":"If given a number value between 1 and 12, sets start positions across all breakpoints.\nIf given an object, sets start positions for given breakpoints (keys in configuration object, e.g. {\"tabletMd\": 10, \"mobileLg\": 5})."},{"name":"colWidth","required":false,"defaultValue":"auto\nIf given a number value between 1 and 12, sets column width across all breakpoints.\nIf given an object, sets column widths for given breakpoints (keys in configuration object, e.g. {\"tabletMd\": 10, \"mobileLg\": 5}).\nIf set to \"auto\", the column will take all the available space\n"}],"NextGridContextShape":[{"name":"colStackCap","required":true},{"name":"gutterX","type":"NextGridSpacing","required":true},{"name":"gutterY","type":"NextGridSpacing","required":true}],"NextGridProps":[{"name":"colStackCap","required":false,"description":"Sets a breakpoing at which columns will start stacking on top of each other.\nE.g. if set to \"tabletMd\" - columns will stack on \"tabletMd\", \"tabletSm\" and \"mobileLg\" breakpoints."},{"name":"gutterX","type":"NextGridSpacing","required":false,"description":"If given a spacing string value (e.g. \"sm\" or \"none\"), sets horizontal column spacing across all breakpoints.\nIf given an object, sets horizontal column spacing for given breakpoints (keys in configuration object, e.g. {\"tabletMd\": \"xs\", \"mobileLg\": \"none\"})."},{"name":"gutterY","type":"NextGridSpacing","required":false,"description":"If given a spacing string value (e.g. \"sm\" or \"none\"), sets vertical column spacing across all breakpoints.\nVertical spacing is only displayed when the columns are stacked (typically, on smaller breakpoints or as defined by \"colStackCap\").\nIf given an object, sets vertical column spacing for given breakpoints (keys in configuration object, e.g. {\"tabletMd\": \"xs\", \"mobileLg\": \"none\"})."}]}

package/dist/props/Notation.json

@@ -0,0 +1 @@
+{"NotationProps":[{"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":"variant","type":"NotationVariant","required":false,"description":"The notation color variant"}]}

package/dist/props/NumberInput.json

@@ -0,0 +1 @@
+{"CursorPosition":[{"name":"selection","type":"string","required":true},{"name":"selectionEnd","type":"number","required":true},{"name":"selectionStart","type":"number","required":true}],"NumberInputProps":[{"name":"decimalScale","required":false,"description":"The maximum number of fraction digits to use. Possible values range from 0 to 14. Setting to true will result in the maximum size, setting to false will allow 0 decimals, whole numbers only.","defaultValue":"true\n"},{"name":"defaultValue","required":false,"description":"Initial value of an uncontrolled component"},{"name":"error","type":"boolean","required":false,"description":"Controls the error state of the `Input`, changing the\nbackground color and border colors to red"},{"name":"fillDecimalScale","required":false,"description":"<Code>none</Code> prevents from adding zeros to match given\n<Code>decimalScale</Code>.<br /> <Code>always</Code> automatically adds\nzeros to match given\n<Code>decimalScale</Code>. <br />\n<Code>onBlur</Code> automatically adds zeros to match given{' '}\n<Code>decimalScale</Code> when input has lost focus."},{"name":"locale","required":false,"description":"A string with a BCP 47 language tag or an array of such strings which specifies number formatting.","defaultValue":"en-US\n"},{"name":"prefix","type":"string","required":false,"description":"A string which is added to input as a prefix."},{"name":"qa","type":"QaTags","required":false},{"name":"step","type":"number","required":false,"description":"A stepping interval which is used in incrementer. Zero value turns off incrementer.","defaultValue":"0\n"},{"name":"suffix","type":"string","required":false,"description":"A string which is added to input as a suffix"},{"name":"value","required":false,"description":"Value of a controlled component"},{"name":"onChange","type":"void","required":true,"description":"`(value: ValueChange) => void`, where `ValueChange` is an object `{ value: string, parsedNumber: number | null }`."}],"ParsedInputValue":[{"name":"decimal","type":"string","required":true},{"name":"fraction","type":"string","required":true},{"name":"integer","type":"string","required":true},{"name":"parsedNumber","type":"number","required":true}],"Separators":[{"name":"decimal","type":"string","required":true},{"name":"group","type":"string","required":true}],"UseNumberFormatConfig":[{"name":"decimalScale","required":false,"description":"The maximum number of fraction digits to use. Possible values range from 0 to 14. Setting to true will result in the maximum size, setting to false will allow 0 decimals, whole numbers only.","defaultValue":"true\n"},{"name":"fillDecimalScale","required":false,"description":"<Code>none</Code> prevents from adding zeros to match given\n<Code>decimalScale</Code>.<br /> <Code>always</Code> automatically adds\nzeros to match given\n<Code>decimalScale</Code>. <br />\n<Code>onBlur</Code> automatically adds zeros to match given{' '}\n<Code>decimalScale</Code> when input has lost focus."},{"name":"locale","required":false,"description":"A string with a BCP 47 language tag or an array of such strings which specifies number formatting.","defaultValue":"en-US\n"}],"ValueChange":[{"name":"parsedNumber","required":true},{"name":"value","type":"string","required":true}]}

package/dist/props/OverlayTrigger.json

@@ -0,0 +1 @@
+{"OverlayTriggerProps":[{"name":"beforeHide","type":"BeforeCallback","required":false,"description":"<div>\n The callback to run before the overlay is hidden. Returning\n <Code>false</Code> will prevent hiding.\n</div>\n<CodeBlock>(e: event) => boolean | Promise | undefined</CodeBlock>"},{"name":"beforeShow","type":"BeforeCallback","required":false,"description":"<div>\n The callback to run before the overlay is shown. Returning\n <Code>false</Code> will prevent showing.\n</div>\n<CodeBlock>(e: event) => boolean | Promise | undefined</CodeBlock>"},{"name":"canFlip","type":"boolean","required":false},{"name":"children","required":true},{"name":"clickOutsideIgnoreRefs","required":false,"description":"Additional refs to check for clickOutside behavior"},{"name":"hideDelay","type":"number","required":false,"description":"The delay when hiding the overlay"},{"name":"hideKeys","required":false},{"name":"initialIsVisible","type":"boolean","required":false},{"name":"overlay","type":"ReactNode","required":true},{"name":"padding","type":"number","required":false},{"name":"placement","type":"Placement","required":false},{"name":"restoreFocusOnHide","type":"boolean","required":false,"description":"Restore focus to the target after the overlay is hidden"},{"name":"showDelay","type":"number","required":false,"description":"The delay when showing the overlay"},{"name":"showKeys","required":false,"description":"Keys to show the overlay when the target is focused"},{"name":"shrinkOverlay","type":"boolean","required":false},{"name":"trigger","required":false},{"name":"afterHide","type":"void","required":true},{"name":"afterShow","type":"void","required":true}]}

package/dist/props/PageLayout.json

@@ -0,0 +1 @@
+{"PageAsideProps":[{"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":"open","type":"boolean","required":false},{"name":"style","type":"CSSProperties","required":false,"description":"Additional CSS styles"}],"PageComponentProps":[{"name":"children","type":"ReactNode","required":false}],"PageHeaderProps":[{"name":"children","type":"ReactNode","required":false},{"name":"transparent","type":"boolean","required":false}]}

package/dist/props/Pagination.json

@@ -0,0 +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."}]}

package/dist/props/Panel.json

@@ -0,0 +1 @@
+{"PanelBodyProps":[{"name":"secondaryBgColor","type":"boolean","required":false,"description":"Applies the gray secondary background color."}],"PanelHeaderActionProps":[{"name":"block","type":"boolean","required":false,"description":"Sets the button to be 100% of the width of its parent"},{"name":"icon","type":"ReactNode","required":false,"description":"string icons have been deprecated, please pass a component from `@procore/core-icons`\nThe icon to display on the left side of the label"},{"name":"iconRight","type":"ReactNode","required":false,"description":"The icon to display on the right side of the label"},{"name":"loading","type":"boolean","required":false,"description":"Shows the button spinner"},{"name":"size","type":"","required":false,"description":"The size of the button"},{"name":"title","type":"string","required":true,"description":"Tooltip/Overflow menu label text."},{"name":"variant","type":"","required":false,"description":"All variants except for primary, secondary, tertiary are DEPRECATED.\nAll will still be accepted, but deprecated ones will look like secondary"}],"PanelHeaderProps":[{"name":"onClickBack","type":"void","required":true,"description":"Controls visibility and behavior for the \"chevron-left\" icon on the left\nside of the title."},{"name":"onClose","type":"void","required":true}],"PanelQaTags":[{"name":"moreIcon","type":"string","required":false},{"name":"title","type":"string","required":false}],"PanelTitleTooltipProps":[{"name":"children","type":"ReactNode","required":true},{"name":"isVisible","type":"boolean","required":true},{"name":"overlay","type":"ReactNode","required":true}]}