@procore/core-react 10.20.0-rc.25 → 10.20.0-rc.26

package/dist/esm/components/Form/Form.types.d.ts

@@ -20,8 +20,28 @@ export interface FormContextAPI {
     disabled: boolean;
     enableReinitialize?: boolean;
     setFieldDifferent: (key: string, different: boolean) => void;
+    /**
+     * A <a href="https://github.com/jquense/yup">Yup</a> object schema to
+     * validate all values.
+     * <CodeBlock>
+     *  {`Yup.object().shape({
+     *    input_name: Yup.mixed().required()
+     *  })`}
+     * </CodeBlock>
+     * This is a great way to get error messages into the component. In
+     * addition, if using Yup for required, those fields will automatically
+     * get the required asterisk and highlight error.
+     */
     validationSchema?: FormikConfig<unknown>['validationSchema'];
+    /**
+     * Toggle between modern and traditional form styles. Leave blank for the
+     * modern label-above layout.
+     */
     variant: Layout;
+    /**
+     * Determines show or edit state of form.
+     * @default 'create'
+     */
     view: View;
 }
 interface FieldMetaProps<Value> extends Omit<FormikFieldMetaProps<Value>, 'error'> {
@@ -49,9 +69,26 @@ export interface FieldAPI<Value> {
 }
 export interface FormProps<Values> extends Partial<FormikConfig<Values>> {
     children: React.ReactNode;
+    /**
+     * Enable a browser confirmation about losing of unsaved data when the
+     * form values are visually different from the initial values. Uses{' '}
+     * <Code>window.onbeforeunload</Code>
+     */
     enableConfirmNavigation?: boolean;
+    /**
+     * Disable all fields at once.
+     * @default false
+     */
     disabled?: boolean;
+    /**
+     * Toggle between modern and traditional form styles. Leave blank for the modern label-above layout.
+     *
+     */
     variant?: Layout;
+    /**
+     * Determines show or edit state of form.
+     * @default 'create'
+     */
     view?: View;
 }
 export declare type ValueComponentProps<Value = any> = {
@@ -59,20 +96,79 @@ export declare type ValueComponentProps<Value = any> = {
 };
 export declare type ComponentWithFieldProp<Value, Props extends ValueComponentProps<Value>> = React.FunctionComponent<Props> | React.ForwardRefExoticComponent<Props> | ((p: Props) => React.ReactNode);
 export interface BaseFieldProps<Value, ComponentProps extends ValueComponentProps<Value>> {
+    /**
+     * Customize the input component, either a single component for all views
+     * or an object with the keys of the views to render on that particular
+     * view. This input component will receive the <Code>field</Code> prop.
+     * If using TypeScript, these components will need to extend a specific
+     * type from Core React, read more about the{' '}
+     * <a href="#typescript-and-as-prop-components">props per view</a>.
+     * <br />
+     * <br />
+     * One of:
+     * <br />
+     * <Code>ReactComponent</Code>or
+     * <Code>
+     * {
+     *    '{ read: ReactComponent, create: ReactComponent, update: ReactComponent }'
+     * }
+     </Code>
+     */
     as?: ComponentWithFieldProp<Value, ComponentProps> | {
         [V in View]: ComponentWithFieldProp<Value, ComponentProps>;
     };
+    /**
+     * A subcomponent to render on a particular view.
+     * <br />
+     * <br />
+     * One or all of:
+     * <br />
+     * <Code>Form.X.Create, Form.X.Read, Form.X.Update</Code>
+     */
     children?: ((field: FieldAPI<Value>) => React.ReactNode) | React.ReactNode;
+    /**
+     * Starting location of column. For traditional variant, this does not exist
+     * and is not necessary.
+     * */
     colStart?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+    /**
+     * Width of column. For traditional variant, will be either 6 or 12.
+     * @default 6
+     */
     colWidth?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
     ['data-qa']?: string;
+    /**
+     * Specify disabled. Field disabled replaces the overall Form disabled state.
+     */
     disabled?: boolean;
     error?: boolean | string;
     label?: string;
+    /**
+     * Key path in store. Accepts <Code>bracket[notation]</Code> or{' '}
+     * <Code>dot.notation</Code>.
+     */
     name: string;
+    /**
+     * The required asterisk if not using Yup <Code>required</Code>
+     * <CodeBlock>
+     * {`<Form
+     * validationSchema={Yup.object().shape({
+     *  input_name: Yup.mixed().required(),
+     * })}>`}
+     * </CodeBlock>
+     */
     required?: boolean;
     tooltip?: TooltipProps['overlay'];
+    /**
+     * The validate function from Formik for single field validation.
+     * <CodeBlock>
+     *  {`(value: Value = any) => undefined | string | Promise<Value>`}
+     * </CodeBlock>
+     */
     validate?: FieldValidator;
+    /**
+     * Determines show or edit state of field.
+     */
     view?: View;
 }
 export interface TraditionalBaseFieldProps<Value, ComponentProps extends ValueComponentProps<Value>> extends Omit<BaseFieldProps<Value, ComponentProps>, 'colWidth' | 'colStart'> {
@@ -82,7 +178,29 @@ export interface FieldProps<Value> extends Omit<BaseFieldProps<Value, ValueCompo
     children?: React.ReactElement<BaseFieldProps<Value, ValueComponentProps<Value>>> | React.ReactElement<BaseFieldProps<Value, ValueComponentProps<Value>>>[];
 }
 export declare type OptionList<OptionShape = any> = {
+    /**
+     * <div>
+     *  The id of an option{' '}
+     *  <Code>{'(option: OptionItem) => string | number'}</Code>
+     * </div>
+     * <br />
+     * <div>
+     *  Default:
+     *  <Code>{'(option: OptionItem) => option.id'}</Code>
+     * </div>
+     */
     getId: (option: OptionShape) => string | number;
+    /**
+     * <div>
+     *  The display label of an option
+     *  <Code>{'(option: OptionItem) => string'}</Code>
+     * </div>
+     * <br />
+     * <div>
+     *  Default:
+     *  <Code>{'(option: OptionItem) => option.label || option.name'}</Code>
+     * </div>
+     */
     getLabel: (option: OptionShape) => string;
     options?: OptionShape[];
 };
@@ -152,21 +270,74 @@ export declare type FieldSelectGroupHeader = FieldSelectGroupItem & {
 export interface GroupedOptionsConfig<OptionItem, GroupItem> extends OptionList<OptionItem> {
     comparator?: (query: string, value: string) => boolean;
     getGroup: (option: OptionItem) => number | string;
+    /**
+     * <div>
+     *  The id of group{' '}
+     *  <Code>{'(group: GroupItem) => string | number'}</Code>
+     * </div>
+     * <br />
+     * <div>
+     *  Default:
+     *  <Code>{'(group) => group.id'}</Code>
+     * </div>
+     */
     groupGetId: (group: GroupItem) => number | string;
     optgroups?: GroupItem[];
     value?: OptionItem;
 }
 export interface FieldSelectComponentProps<Value = FieldSelectValueType, OptionItem = FieldSelectOptionItem, GroupItem = FieldSelectGroupItem> extends ValueComponentProps<Value>, Partial<OptionList<OptionItem>>, Omit<SelectProps, 'onClear' | 'onSearch' | 'error' | 'children'> {
+    /**
+     * Callback for each entry in <Code>options</Code> to define relation to
+     * group in <Code>optgroups</Code>
+     * <Code>{'(option: OptionItem) => string | number'}</Code>
+     * */
     getGroup?: (option: OptionItem) => number | string;
     groupGetId?: (group: GroupItem) => number | string;
+    /**
+     * <div>
+     *  The display label of a group
+     *  <Code>{'(group: GroupItem) => string'}</Code>
+     * </div>
+     * <br />
+     * <div>
+     *  Default:
+     *  <Code>{'(group: GroupItem) => group.label || group.name'}</Code>
+     * </div>
+     */
     groupGetLabel?: (group: GroupItem) => string;
+    /**
+     * Callback for rendering header for each entry in <Code>optgroups</Code>
+     * <Code>{'(group: GroupItem) => React.ReactNode'}</Code>
+     */
     groupHeaderRenderer?: (group: GroupItem) => React.ReactNode;
+    /**
+     * If nothing is selected, suggest this option. From{' '}
+     * <Code>{'Select.Option suggested'}</Code>.
+     * <Code>{'(option: OptionItem) => boolean'}</Code>
+     */
     isSuggestedOption?: (option: OptionItem) => boolean;
+    /**
+     * Array of available option groups
+     */
     optgroups?: GroupItem[];
+    /**
+     * Callback for rendering each <Code>option</Code>
+     * <Code>{'(option: OptionItem) => React.ReactNode'}</Code>
+     */
     optionRenderer?: (option: OptionItem) => React.ReactNode;
     onBlur?: (e: React.FocusEvent<HTMLDivElement>) => void;
+    /**
+     * Callback for when cleared. Default enabled, has clear icon.
+     */
     onClear?: false | SelectButtonProps['onClear'];
+    /**
+     * Callback for when searching. Default enabled, has seach bar in menu.
+     */
     onSearch?: false | SelectProps['onSearch'];
+    /**
+     * <div>Customize how search works</div>
+     * <Code>{'(query: string, value: string) => boolean'}</Code>
+     */
     searchComparator?: (query: string, value: string) => boolean;
 }
 export interface FieldSelectProps<Value = FieldSelectValueType, OptionItem = FieldSelectOptionItem, GroupItem = FieldSelectGroupItem> extends FieldProps<Value>, Partial<OptionList<OptionItem>>, Pick<FieldSelectComponentProps<Value, OptionItem, GroupItem>, 'getGroup' | 'groupGetId' | 'groupGetLabel' | 'groupHeaderRenderer' | 'isSuggestedOption' | 'onBlur' | 'onClear' | 'optgroups' | 'onSearch' | 'optionRenderer' | 'searchComparator'>, Omit<SelectProps, 'onClear' | 'onSearch' | 'error' | 'children' | 'label'> {

package/dist/esm/components/Icon/Icon.d.ts

@@ -1,13 +1,6 @@
 import React from 'react';
-import { Props, Size, SpanAttributes } from '../../utils/types';
-export declare type IconSize = Extract<Size, 'inherit' | 'sm' | 'md' | 'lg'>;
-declare type IconVariant = '' | 'hover-circle' | 'hover-fill';
-export interface IconProps extends Props {
-    clickable?: boolean;
-    icon: string;
-    size?: IconSize;
-    variant?: IconVariant;
-}
+import { SpanAttributes } from '../../utils/types';
+import { IconProps } from './Icon.types';
 /**
  * @deprecated The `Icon` component has been deprecated and will be removed in a future version.
  *

package/dist/esm/components/Icon/Icon.js.map

@@ -1 +1 @@
-{"version":3,"file":"Icon.js","sourceRoot":"","sources":["../../../../src/components/Icon/Icon.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,MAAM,MAAM,6CAA6C,CAAA;AAChE,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,IAAM,UAAU,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;AAE7C,IAAM,SAAS,GAAG,OAAO,CAAC,qCAAqC,CAAC,CAAA;AAmBhE,IAAM,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AAElC,IAAM,KAAK,GAAgC;IACzC,OAAO,EAAE,SAAS;IAClB,EAAE,EAAE,MAAM;IACV,EAAE,EAAE,MAAM;IACV,EAAE,EAAE,MAAM;CACX,CAAA;AAED,SAAS,OAAO,CAAC,EAIF;QAHb,YAAS,EAAT,IAAI,mBAAG,EAAE,KAAA,EACT,YAAqB,EAArB,IAAI,mBAAG,cAAc,KAAA,EACrB,YAAW,EAAX,IAAI,mBAAG,IAAI,KAAA;IAEX,IAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAA;IAEtC,OAAO,CACL,6BACE,SAAS,EAAC,OAAO,EACjB,MAAM,EAAE,UAAU,EAClB,KAAK,EAAE,UAAU,EACjB,OAAO,EAAC,eAAe;QAEvB,8BAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAI,CACzB,CACP,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,IAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAGlC,SAAS,IAAI,CACb,EAA2E,EAC3E,GAAG;;IADD,IAAA,SAAS,eAAA,EAAE,iBAAiB,EAAjB,SAAS,mBAAG,KAAK,KAAA,EAAE,IAAI,UAAA,EAAE,YAAW,EAAX,IAAI,mBAAG,IAAI,KAAA,EAAE,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA,EAAK,KAAK,cAAzE,qDAA2E,CAAF;IAGzE,OAAO,CACL,uCACE,GAAG,EAAE,GAAG,EACR,SAAS,EAAE,EAAE,CACX,MAAM;gBAEJ,iBAAiB,EAAE,SAAS;;YAC5B,GAAC,WAAS,OAAS,IAAG,OAAO;iBAE/B,SAAS,CACV,0BACoB,MAAM,IACvB,KAAK;QAET,oBAAC,OAAO,IAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,GAAI,CACzC,CACR,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,WAAW,GAAG,MAAM,CAAA;AAEzB,eAAe,IAAI,CAAA"}
+{"version":3,"file":"Icon.js","sourceRoot":"","sources":["../../../../src/components/Icon/Icon.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,MAAM,MAAM,6CAA6C,CAAA;AAChE,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,IAAM,UAAU,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;AAE7C,IAAM,SAAS,GAAG,OAAO,CAAC,qCAAqC,CAAC,CAAA;AAEhE,IAAM,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AAElC,IAAM,KAAK,GAAgC;IACzC,OAAO,EAAE,SAAS;IAClB,EAAE,EAAE,MAAM;IACV,EAAE,EAAE,MAAM;IACV,EAAE,EAAE,MAAM;CACX,CAAA;AAED,SAAS,OAAO,CAAC,EAIF;QAHb,YAAS,EAAT,IAAI,mBAAG,EAAE,KAAA,EACT,YAAqB,EAArB,IAAI,mBAAG,cAAc,KAAA,EACrB,YAAW,EAAX,IAAI,mBAAG,IAAI,KAAA;IAEX,IAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAA;IAEtC,OAAO,CACL,6BACE,SAAS,EAAC,OAAO,EACjB,MAAM,EAAE,UAAU,EAClB,KAAK,EAAE,UAAU,EACjB,OAAO,EAAC,eAAe;QAEvB,8BAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAI,CACzB,CACP,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,IAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAGlC,SAAS,IAAI,CACb,EAA2E,EAC3E,GAAG;;IADD,IAAA,SAAS,eAAA,EAAE,iBAAiB,EAAjB,SAAS,mBAAG,KAAK,KAAA,EAAE,IAAI,UAAA,EAAE,YAAW,EAAX,IAAI,mBAAG,IAAI,KAAA,EAAE,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA,EAAK,KAAK,cAAzE,qDAA2E,CAAF;IAGzE,OAAO,CACL,uCACE,GAAG,EAAE,GAAG,EACR,SAAS,EAAE,EAAE,CACX,MAAM;gBAEJ,iBAAiB,EAAE,SAAS;;YAC5B,GAAC,WAAS,OAAS,IAAG,OAAO;iBAE/B,SAAS,CACV,0BACoB,MAAM,IACvB,KAAK;QAET,oBAAC,OAAO,IAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,GAAI,CACzC,CACR,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,WAAW,GAAG,MAAM,CAAA;AAEzB,eAAe,IAAI,CAAA"}

package/dist/esm/components/Icon/Icon.types.d.ts

@@ -0,0 +1,26 @@
+import { Props, Size } from '../../utils/types';
+export declare type IconSize = Extract<Size, 'inherit' | 'sm' | 'md' | 'lg'>;
+declare type IconVariant = '' | 'hover-circle' | 'hover-fill';
+export interface SVGIconProps {
+    path: string;
+    fill?: string;
+    size: IconSize;
+}
+export interface IconProps extends Props {
+    clickable?: boolean;
+    /**
+     * The core-icon to show
+     */
+    icon: string;
+    /**
+     * The size of the icon
+     * @default 'sm'
+     */
+    size?: IconSize;
+    /**
+     * The icon variant
+     * @default ''
+     */
+    variant?: IconVariant;
+}
+export {};

package/dist/esm/components/Icon/Icon.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Icon.types.js.map

package/dist/esm/components/Icon/Icon.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Icon.types.js","sourceRoot":"","sources":["../../../../src/components/Icon/Icon.types.ts"],"names":[],"mappings":""}

package/dist/esm/components/Icon/index.d.ts

@@ -1 +1,2 @@
-export { Icon as default, Icon, IconProps } from './Icon';
+export { Icon as default, Icon } from './Icon';
+export { IconProps } from './Icon.types';

package/dist/esm/components/Icon/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/Icon/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,OAAO,EAAE,IAAI,EAAa,MAAM,QAAQ,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/Icon/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA"}

package/dist/esm/components/Menu/Menu.types.d.ts

@@ -17,23 +17,43 @@ export interface NavigationProps extends Props {
 export interface ItemProps extends NavigationProps {
     children?: React.ReactNode;
     className?: string;
+    /**
+     * Value which can be passed around various callback functions. Can be anything!
+     */
     item?: any;
     onClick?: (event: React.MouseEvent<HTMLElement, MouseEvent>) => any;
+    /**
+     * Is the item selected
+     * @default false
+     */
     selected?: boolean;
     suggested?: boolean;
 }
 export interface GroupProps {
     className?: string;
+    /**
+     * Can the group item be clicked
+     */
     clickable?: boolean;
+    /**
+     * Value which can be passed around various callback functions. Can be anything!
+     */
     item?: any;
 }
 export interface OptionsProps {
     children?: React.ReactNode;
     className?: string;
     padding?: string;
+    /**
+     * @default true
+     */
     scrollable?: boolean;
 }
 export interface MenuSearchProps extends SearchProps, Props {
+    /**
+     * The i18n key to use for the menu search's configurable strings. Defaults to
+     * using the core library's default strings.
+     */
     i18nScope?: string;
 }
 export interface HeaderProps extends Props {
@@ -42,6 +62,12 @@ export interface HeaderProps extends Props {
 export interface FooterProps extends Omit<BoxProps, 'as'> {
 }
 export interface MenuHookConfig {
+    /**
+     * @deprecated
+     * <CodeBlock>
+     *  (element: any, index?: number, list?: any[]) => boolean
+     * </CodeBlock>
+     */
     isSelectable?: MenuHook['isSelectable'];
     keyHandlerRef?: React.RefObject<HTMLElement>;
     multiple?: boolean;
@@ -56,18 +82,51 @@ export interface MenuHook {
         onKeyDown: (e: React.KeyboardEvent<HTMLElement>) => void;
     };
     highlighted: React.MutableRefObject<HTMLDivElement | null>;
+    /**
+     * @deprecated
+     * <CodeBlock>
+     *  (element: any, index?: number, list?: any[]) => boolean
+     * </CodeBlock>
+     */
     isSelectable: ElementTypeChecker;
     listNavigation: ListNavigationApi;
     multiple: boolean;
     onScrollBottom?: (e: Event) => void;
+    /**
+     * @default true
+     */
     scrollable: boolean;
     search: SearchHook;
     selectItem: (selection: Selection) => void;
 }
 export interface MenuProps extends Props, Omit<OptionsProps, 'padding'> {
+    /**
+     * @deprecated
+     * <CodeBlock>
+     *  (element: any, index?: number, list?: any[]) => boolean
+     * </CodeBlock>
+     */
     isSelectable?: ElementTypeChecker;
+    /**
+     * Ref object which will get the key handler listeners
+     */
     keyHandlerRef?: React.RefObject<HTMLElement>;
     onScrollBottom?: (e: Event) => void;
+    /**
+     * <div>Callback for selecting an item from the menu</div>
+     * <CodeBlock>
+     * {
+     *   '({ event: ReactEvent, item: Menu.Item.props.item, group: bool }) => void'
+     * }
+     * </CodeBlock>
+     * <div>
+     *  <Code>item</Code> will be the <Code>item</Code> prop supplied to the{' '}
+     *  <Code>Item</Code> component
+     *  <br />
+     *  <Code>group</Code> will be <Code>true</Code> if the clicked item was
+     *  a group label
+     * </div>
+     */
     onSelect?: (selection: Selection) => any;
     usingHook?: MenuHook;
     UNSAFE_closesOnSelect?: boolean;

package/dist/esm/components/Modal/Modal.types.d.ts

@@ -26,7 +26,13 @@ export interface ModalContainerProps extends Props {
     width?: ModalWidth;
 }
 export interface ConfirmModalProps extends ModalProps {
+    /**
+     * Headline message
+     */
     headline?: string;
+    /**
+     * The dismiss onClick callback
+     */
     onClose?: (event: React.MouseEvent<HTMLButtonElement>) => void;
 }
 export interface ModalCloseableHeaderProps extends Props {

package/dist/esm/components/MultiSelect/MultiSelect.types.d.ts

@@ -78,11 +78,36 @@ export interface MultiSelectProps {
     afterShow?: OverlayTriggerProps['afterShow'];
     beforeHide?: OverlayTriggerProps['beforeHide'];
     beforeShow?: OverlayTriggerProps['beforeShow'];
+    /**
+     * Callback for each entry in <Code>options</Code> to define relation to
+     * group in <Code>groups</Code>
+     * <CodeBlock>{'(option: OptionItem) => React.ReactNode'}</CodeBlock>
+     */
     getGroup?: MultiSelectConfig['getGroup'];
+    /**
+     * Callback for each entry in <Code>options</Code> for keying and
+     * optimizations
+     * <CodeBlock>{'(option: OptionItem) => number | string'}</CodeBlock>*
+     */
     getId?: MultiSelectConfig['getId'];
+    /**
+     * Callback for each entry in <Code>options</Code> to generate the token
+     * label.
+     * <CodeBlock>{'(option: OptionItem) => string'}</CodeBlock>
+     */
     getLabel?: MultiSelectConfig['getLabel'];
+    /**
+     * Callback for when a user types into the multiselect input
+     <CodeBlock>{'(event: KeyboardEvent) => void'}</CodeBlock>
+     */
     onSearch?: MultiSelectConfig['onSearch'];
+    /**
+     * Array of available option groups
+     */
     optgroups?: MultiSelectConfig['optgroups'];
+    /**
+     * Array of available options
+     */
     options?: MultiSelectConfig['options'];
     onScrollBottom?: MenuProps['onScrollBottom'];
     block?: boolean;
@@ -91,6 +116,10 @@ export interface MultiSelectProps {
     isOptionDisabled?: (option: OptionItem) => boolean;
     emptyMessage?: string;
     error?: boolean;
+    /**
+     * Callback for rendering header for each entry in <Code>groups</Code>
+     * <CodeBlock>{'(group: GroupItem) => React.ReactNode'}</CodeBlock>
+     */
     groupHeaderRenderer?: (group: GroupItem) => React.ReactNode;
     loading?: boolean;
     onBlur?: React.SelectHTMLAttributes<HTMLDivElement>['onBlur'];
@@ -101,6 +130,15 @@ export interface MultiSelectProps {
     placement?: DropdownPlacement;
     qa?: QaTags;
     tabIndex?: number;
+    /**
+     * Callback for rendering each selected value
+     * <CodeBlock>
+     *  {'(props: TokenRendererProps) => React.ReactNode'}
+     * </CodeBlock>
+     */
     tokenRenderer?: (props: TokenRendererProps) => React.ReactNode;
+    /**
+     * Array of the currently selected values
+     */
     value?: OptionItem[];
 }

package/dist/esm/components/Notation/Notation.d.ts

@@ -1,15 +1,6 @@
 import React from 'react';
-import { Props, SpanAttributes } from '../../utils/types';
-export declare const notationVariant: {
-    readonly error: "error";
-    readonly none: "";
-    readonly pagination: "pagination";
-    readonly required: "required";
-};
-declare type NotationVariant = typeof notationVariant[keyof typeof notationVariant];
-export interface NotationProps extends Props {
-    variant?: NotationVariant;
-}
+import { SpanAttributes } from '../../utils/types';
+import { NotationProps } from './Notation.types';
 /**
  * @deprecated Please use `<Typography italic />` component for plain text
  * notations or the `<Required />` component for required notations. `Notation`

package/dist/esm/components/Notation/Notation.js

@@ -29,12 +29,6 @@ import styled from 'styled-components';
 import { useDeprecation } from '../../effects/Deprecation';
 import { colors } from '../../styles/colors';
 import { getTypographyIntent } from '../Typography/Typography.styles';
-export var notationVariant = {
-    error: 'error',
-    none: '',
-    pagination: 'pagination',
-    required: 'required',
-};
 var variantColorMap = {
     required: 'orange50',
     error: 'red50',

package/dist/esm/components/Notation/Notation.js.map

@@ -1 +1 @@
-{"version":3,"file":"Notation.js","sourceRoot":"","sources":["../../../../src/components/Notation/Notation.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,MAAM,MAAM,mBAAmB,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAE5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAA;AAErE,MAAM,CAAC,IAAM,eAAe,GAAG;IAC7B,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,YAAY;IACxB,QAAQ,EAAE,UAAU;CACZ,CAAA;AAQV,IAAM,eAAe,GAAG;IACtB,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;IACd,UAAU,EAAE,QAAQ;CACZ,CAAA;AAEV,IAAM,cAAc,GAAG,MAAM,CAAC,CAAC,sHAAe,MAC1C,EAA4B,aACrB,EACmD,4BAE7D;IACD;;;;OAIG;KATC,mBAAmB,CAAC,OAAO,CAAC,EACrB,UAAC,EAAW;QAAT,OAAO,aAAA;IACjB,OAAA,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM;AAA1D,CAA0D,CAE7D,CAAA;AACD;;;;GAIG;AACH,MAAM,CAAC,IAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CAGtC,SAAS,QAAQ,CAAC,EAAoC,EAAE,GAAG;IAAvC,IAAA,QAAQ,cAAA,EAAE,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA,EAAK,KAAK,cAAlC,uBAAoC,CAAF;IACpD,cAAc,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,wBAAwB,EAAE,CAAC,CAAA;IAE5E,OAAO,CACL,oBAAC,cAAc,eAAK,KAAK,IAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,KAClD,QAAQ,CACM,CAClB,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,QAAQ,CAAC,WAAW,GAAG,UAAU,CAAA;AAEjC,eAAe,QAAQ,CAAA"}
+{"version":3,"file":"Notation.js","sourceRoot":"","sources":["../../../../src/components/Notation/Notation.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,MAAM,MAAM,mBAAmB,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAE5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAA;AAGrE,IAAM,eAAe,GAAG;IACtB,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;IACd,UAAU,EAAE,QAAQ;CACZ,CAAA;AAEV,IAAM,cAAc,GAAG,MAAM,CAAC,CAAC,sHAAe,MAC1C,EAA4B,aACrB,EACmD,4BAE7D;IACD;;;;OAIG;KATC,mBAAmB,CAAC,OAAO,CAAC,EACrB,UAAC,EAAW;QAAT,OAAO,aAAA;IACjB,OAAA,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM;AAA1D,CAA0D,CAE7D,CAAA;AACD;;;;GAIG;AACH,MAAM,CAAC,IAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CAGtC,SAAS,QAAQ,CAAC,EAAoC,EAAE,GAAG;IAAvC,IAAA,QAAQ,cAAA,EAAE,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA,EAAK,KAAK,cAAlC,uBAAoC,CAAF;IACpD,cAAc,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,wBAAwB,EAAE,CAAC,CAAA;IAE5E,OAAO,CACL,oBAAC,cAAc,eAAK,KAAK,IAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,KAClD,QAAQ,CACM,CAClB,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,QAAQ,CAAC,WAAW,GAAG,UAAU,CAAA;AAEjC,eAAe,QAAQ,CAAA"}

package/dist/esm/components/Notation/Notation.types.d.ts

@@ -0,0 +1,15 @@
+import { Props } from '../../utils/types';
+export declare const notationVariant: {
+    readonly error: "error";
+    readonly none: "";
+    readonly pagination: "pagination";
+    readonly required: "required";
+};
+declare type NotationVariant = typeof notationVariant[keyof typeof notationVariant];
+export interface NotationProps extends Props {
+    /**
+     * The notation color variant
+     */
+    variant?: NotationVariant;
+}
+export {};

package/dist/esm/components/Notation/Notation.types.js

@@ -0,0 +1,7 @@
+export var notationVariant = {
+    error: 'error',
+    none: '',
+    pagination: 'pagination',
+    required: 'required',
+};
+//# sourceMappingURL=Notation.types.js.map

package/dist/esm/components/Notation/Notation.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Notation.types.js","sourceRoot":"","sources":["../../../../src/components/Notation/Notation.types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,IAAM,eAAe,GAAG;IAC7B,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,YAAY;IACxB,QAAQ,EAAE,UAAU;CACZ,CAAA"}

package/dist/esm/components/Notation/index.d.ts

@@ -1 +1,2 @@
-export { Notation as default, Notation, NotationProps } from './Notation';
+export { Notation as default, Notation } from './Notation';
+export { NotationProps } from './Notation.types';

package/dist/esm/components/Notation/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/Notation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,OAAO,EAAE,QAAQ,EAAiB,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/Notation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA"}

package/dist/esm/components/NumberInput/NumberInput.types.d.ts

@@ -11,7 +11,7 @@ export interface ValueChange {
     parsedNumber: number | null;
 }
 export declare type InputValue = string | number | undefined | null;
-export interface QaTags {
+interface QaTags {
     wrapper?: string;
     increment?: string;
     decrement?: string;
@@ -27,9 +27,13 @@ export interface NumberInputProps extends Omit<InputProps, 'value' | 'defaultVal
      */
     defaultValue?: InputValue;
     /**
-     * `none` prevents from adding zeros to match given `decimalScale`.
-     * `always` automatically adds zeros to match given `decimalScale`.
-     * `onBlur` automatically adds zeros to match given `decimalScale` when input has lost focus.
+     * <Code>none</Code> prevents from adding zeros to match given
+     * <Code>decimalScale</Code>.<br /> <Code>always</Code> automatically adds
+     * zeros to match given
+     * <Code>decimalScale</Code>. <br />
+     * <Code>onBlur</Code> automatically adds zeros to match given{' '}
+     * <Code>decimalScale</Code> when input has lost focus.
+     * @default 'none'
      */
     fillDecimalScale?: FillDecimalScaleVariant;
     /**
@@ -46,7 +50,7 @@ export interface NumberInputProps extends Omit<InputProps, 'value' | 'defaultVal
      */
     prefix?: string;
     /**
-     * A stepping interval which is used in incremeter. Zero value turns off incrementer.
+     * A stepping interval which is used in incrementer. Zero value turns off incrementer.
      * @defaultValue 0
      */
     step?: number;
@@ -78,3 +82,4 @@ export interface CursorPosition {
     selectionEnd: number;
     selection: string;
 }
+export {};