@procore/core-react 10.21.0-rc.28 → 10.21.0-rc.32

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

@@ -5,121 +5,261 @@ import { OverlayTriggerProps } from '../OverlayTrigger';
 export declare type SelectPlacement = DropdownPlacement;
 declare type DivProps = React.ComponentPropsWithoutRef<'div'>;
 export interface SelectMenuProps extends Omit<DivProps, 'onSelect' | 'onDragEnd'> {
+    /**
+     * @since 10.19.0
+     */
     emptyMessage?: string;
+    /**
+     * @since 10.19.0
+     */
     footer?: React.ReactNode;
+    /**
+     * @since 10.19.0
+     */
     i18nScope?: string;
+    /**
+     * @since 10.19.0
+     */
     onClear?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
+    /**
+     * @since 10.19.0
+     */
     onScrollBottom?: MenuProps['onScrollBottom'];
+    /**
+     * @since 10.19.0
+     */
     onSearch?: (event: React.ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * @since 10.19.0
+     */
     onSelect?: MenuProps['onSelect'];
+    /**
+     * @since 10.19.0
+     */
     optionsRef?: React.RefObject<HTMLDivElement>;
+    /**
+     * @since 10.19.0
+     */
     menuRef: React.RefObject<MenuRef>;
 }
 export interface OptionProps extends DivProps {
+    /**
+     * @since 10.19.0
+     */
     index?: number;
+    /**
+     * @since 10.19.0
+     */
     value: any;
+    /**
+     * @since 10.19.0
+     */
     disabled?: boolean;
     /**
      * Represents the currently selected value. This option will be styled
      * differently as well as receive UX to scroll into view and start list
      * navigation from this element.
+     * @since 10.19.0
      */
     selected?: boolean;
     /**
      * If nothing is selected, suggest this option. Suggested options mimic the
      * UX of a selected option, scroll into view and start list navigation from
      * this element.
+     * @since 10.19.0
      */
     suggested?: boolean;
 }
 interface QaTags {
+    /**
+     * @since 10.19.0
+     */
     label: string;
+    /**
+     * @since 10.19.0
+     */
     clear: string;
 }
 export interface SelectProps extends Omit<DivProps, 'onSelect'> {
+    /**
+     * @since 10.19.0
+     */
     afterHide?: OverlayTriggerProps['afterHide'];
+    /**
+     * @since 10.19.0
+     */
     afterShow?: OverlayTriggerProps['afterShow'];
+    /**
+     * @since 10.19.0
+     */
     beforeHide?: OverlayTriggerProps['beforeHide'];
+    /**
+     * @since 10.19.0
+     */
     beforeShow?: OverlayTriggerProps['beforeShow'];
     /**
      * Make the Select button 100% width
+     * @since 10.19.0
      */
     block?: boolean;
     /**
      * @default false
+     * @since 10.19.0
      */
     disabled?: boolean;
     /**
      * When there are no children this will render
+     * @since 10.19.0
      */
     emptyMessage?: string;
     /**
      * @default false
+     * @since 10.19.0
      */
     error?: boolean;
+    /**
+     * @since 10.19.0
+     */
     footer?: React.ReactNode;
+    /**
+     * @since 10.19.0
+     */
     hideDelay?: number;
     /**
      * The i18n key to use for the select's configurable strings.
      * Defaults to using the core library's default strings.
+     * @since 10.19.0
      */
     i18nScope?: string;
+    /**
+     * @since 10.19.0
+     */
     label?: React.ReactNode;
     /**
      * If the select is loading
      * @default false
+     * @since 10.19.0
      */
     loading?: boolean;
     /**
      * It is possible for this component to have an empty value
      * (render placeholder). Enables the x icon.
+     * @since 10.19.0
      */
     onClear?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
     /**
      * Optional <Code>function</Code> that automatically executes when
      * scrolling reaches the last item.
+     * @since 10.19.0
      */
     onScrollBottom?: MenuProps['onScrollBottom'];
     /**
      * Adds a search bar to the select.
+     * @since 10.19.0
      */
     onSearch?: (event: React.ChangeEvent<HTMLInputElement>) => void;
+    /**
+     * @since 10.19.0
+     */
     onSelect?: MenuProps['onSelect'];
+    /**
+     * @since 10.19.0
+     */
     optionsRef?: React.RefObject<HTMLDivElement>;
     /**
      * Renders when the label is blank
+     * @since 10.19.0
      */
     placeholder?: string;
     /**
      * The placement of the overlay
      * @default 'bottom-left'
+     * @since 10.19.0
      */
     placement?: SelectPlacement;
+    /**
+     * @since 10.19.0
+     */
     qa?: Partial<QaTags>;
+    /**
+     * @since 10.19.0
+     */
     showDelay?: number;
     /**
      * Configurable tabIndex for the select button
      * @default 0
+     * @since 10.19.0
      */
     tabIndex?: number;
 }
 export interface SelectButtonProps extends DivProps {
+    /**
+     * @since 10.19.0
+     */
     block?: ButtonProps['block'];
+    /**
+     * @since 10.19.0
+     */
     clearRef?: React.RefObject<HTMLButtonElement>;
+    /**
+     * @since 10.19.0
+     */
     disabled?: ButtonProps['disabled'];
+    /**
+     * @since 10.19.0
+     */
     dropdown?: boolean;
+    /**
+     * @since 10.19.0
+     */
     error?: boolean;
+    /**
+     * @since 10.19.0
+     */
     icon?: ButtonProps['icon'];
+    /**
+     * @since 10.19.0
+     */
     label?: React.ReactNode;
+    /**
+     * @since 10.19.0
+     */
     loading?: ButtonProps['loading'];
+    /**
+     * @since 10.19.0
+     */
     onClear?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
+    /**
+     * @since 10.19.0
+     */
     open?: boolean;
+    /**
+     * @since 10.19.0
+     */
     placeholder?: string;
+    /**
+     * @since 10.19.0
+     */
     qa?: Partial<QaTags>;
+    /**
+     * @since 10.19.0
+     */
     size?: ButtonProps['size'];
+    /**
+     * @since 10.19.0
+     */
     tabIndex?: number;
+    /**
+     * @since 10.19.0
+     */
     type?: ButtonProps['type'];
+    /**
+     * @since 10.19.0
+     */
     variant?: ButtonProps['variant'];
+    /**
+     * @since 10.19.0
+     */
     isMenuOpened?: boolean;
 }
 export {};

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

@@ -21,4 +21,18 @@ export declare const getDefaultValue: ({ min, max, step, }: {
     max: number;
     step?: number | undefined;
 }) => number;
+/**
+
+ A slider is a bar with selectable/grabbable handle. It allows users to click
+ and drag horizontally to a desired value. It is used when users need to select
+ a value from a predefined range of values. Sliders should always have a
+ corresponding value or increment displayed within proximity of the component.
+
+ @since 10.19.0
+
+ @see [Storybook](https://procore.github.io/core/latest/?path=/story/demos-slider--demo)
+
+ @see [Design Guidelines](https://design.procore.com/slider)
+
+ */
 export declare const Slider: React.ForwardRefExoticComponent<SliderProps & React.RefAttributes<HTMLInputElement>>;

package/dist/esm/components/Slider/Slider.js

@@ -54,6 +54,20 @@ export var getDefaultValue = function (_a) {
     var defaultVal = max < min ? min : min + (max - min) / 2;
     return step ? Math.round(defaultVal / step) * step : defaultVal;
 };
+/**
+
+ A slider is a bar with selectable/grabbable handle. It allows users to click
+ and drag horizontally to a desired value. It is used when users need to select
+ a value from a predefined range of values. Sliders should always have a
+ corresponding value or increment displayed within proximity of the component.
+
+ @since 10.19.0
+
+ @see [Storybook](https://procore.github.io/core/latest/?path=/story/demos-slider--demo)
+
+ @see [Design Guidelines](https://design.procore.com/slider)
+
+ */
 export var Slider = React.forwardRef(function Slider(_a, ref) {
     var className = _a.className, disabled = _a.disabled, onChange = _a.onChange, _b = _a.max, max = _b === void 0 ? 100 : _b, _c = _a.min, min = _c === void 0 ? 0 : _c, showLabel = _a.showLabel, step = _a.step, style = _a.style, value_ = _a.value, props = __rest(_a, ["className", "disabled", "onChange", "max", "min", "showLabel", "step", "style", "value"]);
     var _d = React.useState(false), isDragging = _d[0], setIsDragging = _d[1];

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

@@ -1 +1 @@
-{"version":3,"file":"Slider.js","sourceRoot":"","sources":["../../../../src/components/Slider/Slider.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EACL,eAAe,EACf,YAAY,EACZ,sBAAsB,EACtB,wBAAwB,EACxB,WAAW,GACZ,MAAM,iBAAiB,CAAA;AAGxB,MAAM,CAAC,IAAM,aAAa,GAAG,UAAC,EAQ7B;QAPC,GAAG,SAAA,EACH,GAAG,SAAA,EACH,IAAI,UAAA;IAMJ,IAAI,CAAC,IAAI,EAAE;QACT,OAAO,CAAC,CAAA;KACT;IACD,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,IAAI,CAAA;AAC3B,CAAC,CAAA;AAED,MAAM,CAAC,IAAM,aAAa,GAAG,UAAC,EAQ7B;QAPC,GAAG,SAAA,EACH,GAAG,SAAA,EACH,KAAK,WAAA;IAML,OAAO,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAA;AAC5C,CAAC,CAAA;AAED,MAAM,CAAC,IAAM,QAAQ,GAAG,UAAC,EAUxB;QATC,GAAG,SAAA,EACH,GAAG,SAAA,EACH,IAAI,UAAA,EACJ,KAAK,WAAA;IAOL,IAAI,GAAG,KAAK,CAAC,EAAE;QACb,OAAO,KAAK,GAAG,IAAI,CAAA;KACpB;SAAM,IAAI,GAAG,IAAI,CAAC,EAAE;QACnB,OAAO,KAAK,GAAG,IAAI,GAAG,GAAG,CAAA;KAC1B;SAAM,IAAI,GAAG,IAAI,CAAC,EAAE;QACnB,OAAO,CAAC,KAAK,GAAG,aAAa,CAAC,EAAE,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,IAAI,MAAA,EAAE,CAAC,CAAC,GAAG,IAAI,GAAG,GAAG,CAAA;KAChE;SAAM;QACL,OAAO,CAAC,CAAA;KACT;AACH,CAAC,CAAA;AAED,MAAM,CAAC,IAAM,eAAe,GAAG,UAAC,EAQ/B;QAPC,GAAG,SAAA,EACH,GAAG,SAAA,EACH,IAAI,UAAA;IAMJ,kFAAkF;IAClF,IAAM,UAAU,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAA;IAC1D,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAA;AACjE,CAAC,CAAA;AAED,MAAM,CAAC,IAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CACpC,SAAS,MAAM,CACb,EAWC,EACD,GAAG;IAXD,IAAA,SAAS,eAAA,EACT,QAAQ,cAAA,EACR,QAAQ,cAAA,EACR,WAAS,EAAT,GAAG,mBAAG,GAAG,KAAA,EACT,WAAO,EAAP,GAAG,mBAAG,CAAC,KAAA,EACP,SAAS,eAAA,EACT,IAAI,UAAA,EACJ,KAAK,WAAA,EACE,MAAM,WAAA,EACV,KAAK,cAVV,0FAWC,CADS;IAIJ,IAAA,KAA8B,KAAK,CAAC,QAAQ,CAAU,KAAK,CAAC,EAA3D,UAAU,QAAA,EAAE,aAAa,QAAkC,CAAA;IAElE,IAAM,KAAK,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,eAAe,CAAC,EAAE,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,IAAI,MAAA,EAAE,CAAC,CAAA;IAC3D,IAAM,UAAU,GAAG,aAAa,CAAC,EAAE,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,IAAI,MAAA,EAAE,CAAC,CAAA;IAEpD,6CAA6C;IAC7C,yBAAyB;IACzB,IAAI,UAAU,GAAG,CAAC,KAAK,CAAC,EAAE;QACxB,OAAO,CAAC,IAAI,CACV,4JAA4J,CAC7J,CAAA;KACF;IAED,OAAO,CACL,oBAAC,eAAe,IACd,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,SAAS;QAEpB,oBAAC,YAAY,eACP,KAAK,IACT,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,GAAG,EAAE,GAAG,EACR,GAAG,EAAE,GAAG,cACE,aAAa,CAAC,EAAE,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,KAAK,OAAA,EAAE,CAAC,EAC5C,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,IAAI,EACV,IAAI,EAAC,OAAO,EACZ,KAAK,EAAE,KAAK,EACZ,WAAW,EAAE,cAAM,OAAA,aAAa,CAAC,IAAI,CAAC,EAAnB,CAAmB,EACtC,SAAS,EAAE,cAAM,OAAA,aAAa,CAAC,KAAK,CAAC,EAApB,CAAoB,EACrC,UAAU,EAAE,UAAU,IACtB;QACD,IAAI,IAAI,CACP,oBAAC,wBAAwB,QACtB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;aAC/B,IAAI,CAAC,IAAI,CAAC;aACV,GAAG,CAAC,UAAC,CAAC,EAAE,KAAK;YACZ,OAAO,CACL,oBAAC,sBAAsB,IACrB,GAAG,EAAE,wCAAiC,KAAK,cAAI,GAAG,cAAI,GAAG,cAAI,IAAI,CAAE,IAElE,SAAS,IAAI,CACZ,oBAAC,WAAW,IAAC,MAAM,EAAC,OAAO,IACxB,QAAQ,CAAC;gBACR,GAAG,KAAA;gBACH,GAAG,KAAA;gBACH,IAAI,MAAA;gBACJ,KAAK,OAAA;aACN,CAAC,CACU,CACf,CACsB,CAC1B,CAAA;QACH,CAAC,CAAC,CACqB,CAC5B,CACe,CACnB,CAAA;AACH,CAAC,CACF,CAAA"}
+{"version":3,"file":"Slider.js","sourceRoot":"","sources":["../../../../src/components/Slider/Slider.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EACL,eAAe,EACf,YAAY,EACZ,sBAAsB,EACtB,wBAAwB,EACxB,WAAW,GACZ,MAAM,iBAAiB,CAAA;AAGxB,MAAM,CAAC,IAAM,aAAa,GAAG,UAAC,EAQ7B;QAPC,GAAG,SAAA,EACH,GAAG,SAAA,EACH,IAAI,UAAA;IAMJ,IAAI,CAAC,IAAI,EAAE;QACT,OAAO,CAAC,CAAA;KACT;IACD,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,IAAI,CAAA;AAC3B,CAAC,CAAA;AAED,MAAM,CAAC,IAAM,aAAa,GAAG,UAAC,EAQ7B;QAPC,GAAG,SAAA,EACH,GAAG,SAAA,EACH,KAAK,WAAA;IAML,OAAO,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAA;AAC5C,CAAC,CAAA;AAED,MAAM,CAAC,IAAM,QAAQ,GAAG,UAAC,EAUxB;QATC,GAAG,SAAA,EACH,GAAG,SAAA,EACH,IAAI,UAAA,EACJ,KAAK,WAAA;IAOL,IAAI,GAAG,KAAK,CAAC,EAAE;QACb,OAAO,KAAK,GAAG,IAAI,CAAA;KACpB;SAAM,IAAI,GAAG,IAAI,CAAC,EAAE;QACnB,OAAO,KAAK,GAAG,IAAI,GAAG,GAAG,CAAA;KAC1B;SAAM,IAAI,GAAG,IAAI,CAAC,EAAE;QACnB,OAAO,CAAC,KAAK,GAAG,aAAa,CAAC,EAAE,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,IAAI,MAAA,EAAE,CAAC,CAAC,GAAG,IAAI,GAAG,GAAG,CAAA;KAChE;SAAM;QACL,OAAO,CAAC,CAAA;KACT;AACH,CAAC,CAAA;AAED,MAAM,CAAC,IAAM,eAAe,GAAG,UAAC,EAQ/B;QAPC,GAAG,SAAA,EACH,GAAG,SAAA,EACH,IAAI,UAAA;IAMJ,kFAAkF;IAClF,IAAM,UAAU,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAA;IAC1D,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAA;AACjE,CAAC,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,IAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CACpC,SAAS,MAAM,CACb,EAWC,EACD,GAAG;IAXD,IAAA,SAAS,eAAA,EACT,QAAQ,cAAA,EACR,QAAQ,cAAA,EACR,WAAS,EAAT,GAAG,mBAAG,GAAG,KAAA,EACT,WAAO,EAAP,GAAG,mBAAG,CAAC,KAAA,EACP,SAAS,eAAA,EACT,IAAI,UAAA,EACJ,KAAK,WAAA,EACE,MAAM,WAAA,EACV,KAAK,cAVV,0FAWC,CADS;IAIJ,IAAA,KAA8B,KAAK,CAAC,QAAQ,CAAU,KAAK,CAAC,EAA3D,UAAU,QAAA,EAAE,aAAa,QAAkC,CAAA;IAElE,IAAM,KAAK,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,eAAe,CAAC,EAAE,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,IAAI,MAAA,EAAE,CAAC,CAAA;IAC3D,IAAM,UAAU,GAAG,aAAa,CAAC,EAAE,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,IAAI,MAAA,EAAE,CAAC,CAAA;IAEpD,6CAA6C;IAC7C,yBAAyB;IACzB,IAAI,UAAU,GAAG,CAAC,KAAK,CAAC,EAAE;QACxB,OAAO,CAAC,IAAI,CACV,4JAA4J,CAC7J,CAAA;KACF;IAED,OAAO,CACL,oBAAC,eAAe,IACd,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,SAAS;QAEpB,oBAAC,YAAY,eACP,KAAK,IACT,QAAQ,EAAE,QAAQ,EAClB,QAAQ,EAAE,QAAQ,EAClB,GAAG,EAAE,GAAG,EACR,GAAG,EAAE,GAAG,cACE,aAAa,CAAC,EAAE,GAAG,KAAA,EAAE,GAAG,KAAA,EAAE,KAAK,OAAA,EAAE,CAAC,EAC5C,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,IAAI,EACV,IAAI,EAAC,OAAO,EACZ,KAAK,EAAE,KAAK,EACZ,WAAW,EAAE,cAAM,OAAA,aAAa,CAAC,IAAI,CAAC,EAAnB,CAAmB,EACtC,SAAS,EAAE,cAAM,OAAA,aAAa,CAAC,KAAK,CAAC,EAApB,CAAoB,EACrC,UAAU,EAAE,UAAU,IACtB;QACD,IAAI,IAAI,CACP,oBAAC,wBAAwB,QACtB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;aAC/B,IAAI,CAAC,IAAI,CAAC;aACV,GAAG,CAAC,UAAC,CAAC,EAAE,KAAK;YACZ,OAAO,CACL,oBAAC,sBAAsB,IACrB,GAAG,EAAE,wCAAiC,KAAK,cAAI,GAAG,cAAI,GAAG,cAAI,IAAI,CAAE,IAElE,SAAS,IAAI,CACZ,oBAAC,WAAW,IAAC,MAAM,EAAC,OAAO,IACxB,QAAQ,CAAC;gBACR,GAAG,KAAA;gBACH,GAAG,KAAA;gBACH,IAAI,MAAA;gBACJ,KAAK,OAAA;aACN,CAAC,CACU,CACf,CACsB,CAC1B,CAAA;QACH,CAAC,CAAC,CACqB,CAC5B,CACe,CACnB,CAAA;AACH,CAAC,CACF,CAAA"}

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

@@ -2,31 +2,37 @@ import { InputAttributes } from '../../utils/types';
 export interface SliderProps extends InputAttributes {
     /**
      * Whether or not to put the slider into a disabled state.
+     * @since 10.19.0
      */
     disabled?: boolean;
     /**
      * The maximum value of the slider (right side)
      * @defaultValue 100
+     * @since 10.19.0
      */
     max?: number;
     /**
      * The minimum value of the slider (left side)
      * @defaultValue 0
+     * @since 10.19.0
      */
     min?: number;
     /**
      * Whether or not to show value labels below the slider increments.
+     * @since 10.19.0
      */
     showLabel?: boolean;
     /**
      * The distance between each stopping point on the Slider.
      * @defaultValue 1
+     * @since 10.19.0
      */
     step?: number;
     /**
      * The currently set value of the Slider.
      * Defaults to the middle between min and max.
      * @defaultValue (max < min) ? min : min + (max - min)/2;
+     * @since 10.19.0
      */
     value?: number;
 }

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

@@ -1,4 +1,16 @@
 import React from 'react';
 import { SpinnerProps } from './Spinner.types';
 export declare const defaultSpinnerSize = "lg";
+/**
+
+ Spinners indicate a loading state on either a full page or smaller component,
+ like a menu, select or button.
+
+ @since 10.19.0
+
+ @see [Storybook](https://procore.github.io/core/latest/?path=/story/demos-spinner--demo)
+
+ @see [Design Guidelines](https://design.procore.com/spinner)
+
+ */
 export declare const Spinner: React.ForwardRefExoticComponent<SpinnerProps & React.RefAttributes<HTMLDivElement>>;

package/dist/esm/components/Spinner/Spinner.js

@@ -29,6 +29,18 @@ var radiusMap = {
     lg: 20.5,
 };
 export var defaultSpinnerSize = 'lg';
+/**
+
+ Spinners indicate a loading state on either a full page or smaller component,
+ like a menu, select or button.
+
+ @since 10.19.0
+
+ @see [Storybook](https://procore.github.io/core/latest/?path=/story/demos-spinner--demo)
+
+ @see [Design Guidelines](https://design.procore.com/spinner)
+
+ */
 export var Spinner = React.forwardRef(function Spinner(_a, ref) {
     var children = _a.children, _b = _a.className, className = _b === void 0 ? '' : _b, color = _a.color, label = _a.label, _c = _a.loading, loading = _c === void 0 ? false : _c, _d = _a.size, size = _d === void 0 ? defaultSpinnerSize : _d, variant = _a.variant, props = __rest(_a, ["children", "className", "color", "label", "loading", "size", "variant"]);
     var circle = (React.createElement(StyledSpinnerContainer, { className: !children ? className : '', "$color": color, "$size": size, "$variant": variant, ref: ref },

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

@@ -1 +1 @@
-{"version":3,"file":"Spinner.js","sourceRoot":"","sources":["../../../../src/components/Spinner/Spinner.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,+BAA+B,EAC/B,oBAAoB,EACpB,6BAA6B,EAC7B,yBAAyB,EACzB,gBAAgB,GACjB,MAAM,kBAAkB,CAAA;AAGzB,IAAM,SAAS,GAAsC;IACnD,EAAE,EAAE,IAAI;IACR,EAAE,EAAE,EAAE;IACN,EAAE,EAAE,EAAE;IACN,EAAE,EAAE,IAAI;CACT,CAAA;AAED,MAAM,CAAC,IAAM,kBAAkB,GAAG,IAAI,CAAA;AAEtC,MAAM,CAAC,IAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CACrC,SAAS,OAAO,CACd,EASC,EACD,GAAG;IATD,IAAA,QAAQ,cAAA,EACR,iBAAc,EAAd,SAAS,mBAAG,EAAE,KAAA,EACd,KAAK,WAAA,EACL,KAAK,WAAA,EACL,eAAe,EAAf,OAAO,mBAAG,KAAK,KAAA,EACf,YAAyB,EAAzB,IAAI,mBAAG,kBAAkB,KAAA,EACzB,OAAO,aAAA,EACJ,KAAK,cARV,yEASC,CADS;IAIV,IAAM,MAAM,GAAG,CACb,oBAAC,sBAAsB,IACrB,SAAS,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,YAC7B,KAAK,WACN,IAAI,cACD,OAAO,EACjB,GAAG,EAAE,GAAG;QAER,oBAAC,gBAAgB,IACf,OAAO,EAAC,WAAW,EACnB,KAAK,EAAC,4BAA4B;YAElC,oBAAC,YAAY,IAAC,EAAE,EAAC,IAAI,EAAC,EAAE,EAAC,IAAI,EAAC,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,GAAI,CACnC,CACI,CAC1B,CAAA;IAED,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,MAAM,CAAA;KACd;IAED,OAAO,CACL,oBAAC,6BAA6B,yBAClB,OAAO,EACjB,SAAS,EAAE,SAAS,IAChB,KAAK;QAET,oBAAC,oBAAoB,OAAG;QACxB,oBAAC,+BAA+B;YAC7B,MAAM;YACP,oBAAC,yBAAyB,QAAE,KAAK,CAA6B,CAC9B;QACjC,QAAQ,CACqB,CACjC,CAAA;AACH,CAAC,CACF,CAAA;AAED,OAAO,CAAC,WAAW,GAAG,SAAS,CAAA"}
+{"version":3,"file":"Spinner.js","sourceRoot":"","sources":["../../../../src/components/Spinner/Spinner.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,+BAA+B,EAC/B,oBAAoB,EACpB,6BAA6B,EAC7B,yBAAyB,EACzB,gBAAgB,GACjB,MAAM,kBAAkB,CAAA;AAGzB,IAAM,SAAS,GAAsC;IACnD,EAAE,EAAE,IAAI;IACR,EAAE,EAAE,EAAE;IACN,EAAE,EAAE,EAAE;IACN,EAAE,EAAE,IAAI;CACT,CAAA;AAED,MAAM,CAAC,IAAM,kBAAkB,GAAG,IAAI,CAAA;AAEtC;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,IAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CACrC,SAAS,OAAO,CACd,EASC,EACD,GAAG;IATD,IAAA,QAAQ,cAAA,EACR,iBAAc,EAAd,SAAS,mBAAG,EAAE,KAAA,EACd,KAAK,WAAA,EACL,KAAK,WAAA,EACL,eAAe,EAAf,OAAO,mBAAG,KAAK,KAAA,EACf,YAAyB,EAAzB,IAAI,mBAAG,kBAAkB,KAAA,EACzB,OAAO,aAAA,EACJ,KAAK,cARV,yEASC,CADS;IAIV,IAAM,MAAM,GAAG,CACb,oBAAC,sBAAsB,IACrB,SAAS,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,YAC7B,KAAK,WACN,IAAI,cACD,OAAO,EACjB,GAAG,EAAE,GAAG;QAER,oBAAC,gBAAgB,IACf,OAAO,EAAC,WAAW,EACnB,KAAK,EAAC,4BAA4B;YAElC,oBAAC,YAAY,IAAC,EAAE,EAAC,IAAI,EAAC,EAAE,EAAC,IAAI,EAAC,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,GAAI,CACnC,CACI,CAC1B,CAAA;IAED,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,MAAM,CAAA;KACd;IAED,OAAO,CACL,oBAAC,6BAA6B,yBAClB,OAAO,EACjB,SAAS,EAAE,SAAS,IAChB,KAAK;QAET,oBAAC,oBAAoB,OAAG;QACxB,oBAAC,+BAA+B;YAC7B,MAAM;YACP,oBAAC,yBAAyB,QAAE,KAAK,CAA6B,CAC9B;QACjC,QAAQ,CACqB,CACjC,CAAA;AACH,CAAC,CACF,CAAA;AAED,OAAO,CAAC,WAAW,GAAG,SAAS,CAAA"}

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

@@ -9,22 +9,28 @@ export interface SpinnerProps extends Props {
      *  <Link to="/web/style/colors/#hsl-palette">HSL Palette</Link> css
      *  strings
      * </span>
+     * @since 10.19.0
      */
     color?: Color;
     /**
      * The spinner label, only displayed when used as an overlay
+     * @since 10.19.0
      */
     label?: string;
     /**
      * The spinner will show if loading is true
+     * @since 10.19.0
      */
     loading?: boolean;
     /**
      * The size of the spinner
+     * @since 10.19.0
      */
     size?: SpinnerSize;
     /**
-     * @deprecated "variant" prop will be removed in a future version. Use "color" prop instead to set a spinner's color.
+     * @deprecated "variant" prop will be removed in a future version.
+     * Use "color" prop instead to set a spinner's color.
+     * @since 10.19.0
      */
     variant?: SpinnerVariant;
 }

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

@@ -1,4 +1,16 @@
 import React from 'react';
 import { InputAttributes } from '../../utils/types';
 import { SwitchProps } from './Switch.types';
+/**
+
+ We use switches to allow users to choose between two mutually exclusive choices
+ in the same line. This is often associated with enabling vs. disabling.
+
+ @since 10.19.0
+
+ @see [Storybook](https://procore.github.io/core/latest/?path=/story/demos-switch--demo)
+
+ @see [Design Guidelines](https://design.procore.com/switch)
+
+ */
 export declare const Switch: React.ForwardRefExoticComponent<InputAttributes & SwitchProps & React.RefAttributes<HTMLInputElement>>;

package/dist/esm/components/Switch/Switch.js

@@ -22,6 +22,18 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 import React from 'react';
 import { StyledSwitchLabel, StyledToggle, StyledTrack, StyledSwitchContainer, StyledSwitchInput, } from './Switch.styles';
+/**
+
+ We use switches to allow users to choose between two mutually exclusive choices
+ in the same line. This is often associated with enabling vs. disabling.
+
+ @since 10.19.0
+
+ @see [Storybook](https://procore.github.io/core/latest/?path=/story/demos-switch--demo)
+
+ @see [Design Guidelines](https://design.procore.com/switch)
+
+ */
 export var Switch = React.forwardRef(function Switch(_a, ref) {
     var children = _a.children, props = __rest(_a, ["children"]);
     return (React.createElement(StyledSwitchContainer, { disabled: props.disabled },

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

@@ -1 +1 @@
-{"version":3,"file":"Switch.js","sourceRoot":"","sources":["../../../../src/components/Switch/Switch.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,WAAW,EACX,qBAAqB,EACrB,iBAAiB,GAClB,MAAM,iBAAiB,CAAA;AAGxB,MAAM,CAAC,IAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CAGpC,SAAS,MAAM,CAAC,EAAsB,EAAE,GAAG;IAAzB,IAAA,QAAQ,cAAA,EAAK,KAAK,cAApB,YAAsB,CAAF;IACpC,OAAO,CACL,oBAAC,qBAAqB,IAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ;QAC7C,oBAAC,iBAAiB,eAAK,KAAK,IAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAC,UAAU,IAAG;QAC1D,oBAAC,WAAW;YACV,oBAAC,YAAY,OAAG,CACJ;QACb,QAAQ,IAAI,oBAAC,iBAAiB,QAAE,QAAQ,CAAqB,CACxC,CACzB,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,MAAM,CAAC,WAAW,GAAG,QAAQ,CAAA"}
+{"version":3,"file":"Switch.js","sourceRoot":"","sources":["../../../../src/components/Switch/Switch.tsx"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,WAAW,EACX,qBAAqB,EACrB,iBAAiB,GAClB,MAAM,iBAAiB,CAAA;AAGxB;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,IAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CAGpC,SAAS,MAAM,CAAC,EAAsB,EAAE,GAAG;IAAzB,IAAA,QAAQ,cAAA,EAAK,KAAK,cAApB,YAAsB,CAAF;IACpC,OAAO,CACL,oBAAC,qBAAqB,IAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ;QAC7C,oBAAC,iBAAiB,eAAK,KAAK,IAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAC,UAAU,IAAG;QAC1D,oBAAC,WAAW;YACV,oBAAC,YAAY,OAAG,CACJ;QACb,QAAQ,IAAI,oBAAC,iBAAiB,QAAE,QAAQ,CAAqB,CACxC,CACzB,CAAA;AACH,CAAC,CAAC,CAAA;AAEF,MAAM,CAAC,WAAW,GAAG,QAAQ,CAAA"}

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

@@ -9,10 +9,12 @@ export declare type TableCellVariant = '' | 'asc' | 'desc' | 'snugfit';
 export interface BodyCellProps extends Props {
     /**
      * Shrink the cell around the contents
+     * @since 10.19.0
      */
     snugfit?: boolean;
     /**
      * The table body cell variant
+     * @since 10.19.0
      */
     variant?: TableCellVariant;
 }
@@ -21,24 +23,31 @@ export interface BodyProps extends Props {
 export interface BodyRowProps extends Props {
     /**
      * Sets row text color to red to signify overdue items
+     * @since 10.19.0
      */
     overdue?: boolean;
 }
 export interface CaratProps {
     /**
      * Whether or not the carat is rotated
+     * @since 10.19.0
      */
     expanded?: boolean;
     /**
      * Callback to fire when clicked
+     * @since 10.19.0
      */
     onClick: React.EventHandler<any>;
 }
 export interface ContainerProps {
+    /**
+     * @since 10.19.0
+     */
     children?: React.ReactNode;
     /**
      * Adjust the container to support a table shelf
      * @default false
+     * @since 10.19.0
      * */
     shelf?: boolean;
 }
@@ -47,10 +56,12 @@ export interface CurrencyCellProps extends Props {
 export interface GroupProps extends Props {
     /**
      * Number of columns in table
+     * @since 10.19.0
      */
     colSpan?: number;
     /**
      * Determines indentation of the group and content
+     * @since 10.19.0
      */
     depth?: number;
 }
@@ -59,16 +70,19 @@ export interface GroupTitleProps extends Props {
 export interface HeaderCellProps extends Props {
     /**
      * Is this the column sortable
+     * @since 10.19.0
      */
     sortable?: boolean;
     /**
      * Shrink the cell around the contents
      * @default false
+     * @since 10.19.0
      */
     snugfit?: boolean;
     /**
      * Allows for setting ascending or descending sorting icon
      * @default ''
+     * @since 10.19.0
      */
     variant?: TableCellVariant;
 }
@@ -81,16 +95,19 @@ export interface IconCellProps extends Props {
 export interface InputCellProps extends Omit<InputProps, 'size'> {
     /**
      * Message to be displayed below the input during an error
+     * @since 10.19.0
      */
     errorMessage?: string;
     /**
      * Triggers the spinner for processing inline editable content
      * @default false
+     * @since 10.19.0
      */
     processing?: boolean;
     /**
      * The size of the input cell and corresponding error message
      * @default 'block'
+     * @since 10.19.0
      */
     size?: InputCellSize;
 }
@@ -98,6 +115,7 @@ export interface LinkCellProps extends Props {
     /**
      * Destination url
      * @default ''
+     * @since 10.19.0
      * */
     href: string;
 }
@@ -107,45 +125,59 @@ export interface SelectCellProps extends SelectProps {
     /**
      * Message to be displayed below the select during an error
      * @default ''
+     * @since 10.19.0
      */
     errorMessage?: string;
     /**
      * Triggers the spinner that covers inline editable content
      * @default false
+     * @since 10.19.0
      */
     processing?: boolean;
 }
 export interface DateSelectCellProps extends DateSelectProps {
+    /**
+     * @since 10.19.0
+     */
     className?: string;
     /**
      * Message to be displayed below the date select during an error
      * @default ''
+     * @since 10.19.0
      */
     errorMessage?: string;
     /**
      * Triggers the spinner that covers inline editable content
      * @default false
+     * @since 10.19.0
      */
     processing?: boolean;
 }
 export interface TableProps extends Props {
+    /**
+     * @since 10.19.0
+     */
     inline?: boolean;
     /**
      * The table variant
+     * @since 10.19.0
      */
     variant?: TableVariant;
 }
 export interface TextAreaCellProps extends Props {
     /**
      * Message to be displayed below the textarea during an error
+     * @since 10.19.0
      */
     errorMessage?: string;
     /**
      * Triggers the spinner for processing inline editable content
+     * @since 10.19.0
      */
     processing?: boolean;
     /**
      * Sets whether it is resizable
+     * @since 10.19.0
      */
     resizable?: boolean;
 }

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

@@ -2,6 +2,18 @@ import React from 'react';
 import { DivAttributes, Props, SpanAttributes } from '../../utils/types';
 import { TabDropdownProps, TabProps, TabsProps } from './Tabs.types';
 export declare const Link: React.ForwardRefExoticComponent<SpanAttributes & Props & React.RefAttributes<HTMLSpanElement>>;
+/**
+
+ We use tabs to navigate between different, but related content.
+ Tabs are commonly used on tool landing pages and on item detail pages.
+
+ @since 10.19.0
+
+ @see [Storybook](https://procore.github.io/core/latest/?path=/story/tabs-jss--demo)
+
+ @see [Design Guidelines](https://design.procore.com/tabs)
+
+ */
 export declare const Tab: React.ForwardRefExoticComponent<DivAttributes & TabProps & React.RefAttributes<HTMLDivElement>>;
 export declare const MoreMenu: React.ForwardRefExoticComponent<DivAttributes & TabDropdownProps & React.RefAttributes<HTMLDivElement>>;
 export declare const Tabs: React.ForwardRefExoticComponent<DivAttributes & TabsProps & React.RefAttributes<HTMLDivElement>> & {

package/dist/esm/components/Tabs/Tabs.js

@@ -44,6 +44,18 @@ export var Link = React.forwardRef(function Link(_a, ref) {
     var children = _a.children, props = __rest(_a, ["children"]);
     return (React.createElement(StyledLink, __assign({ ref: ref }, props), children));
 });
+/**
+
+ We use tabs to navigate between different, but related content.
+ Tabs are commonly used on tool landing pages and on item detail pages.
+
+ @since 10.19.0
+
+ @see [Storybook](https://procore.github.io/core/latest/?path=/story/tabs-jss--demo)
+
+ @see [Design Guidelines](https://design.procore.com/tabs)
+
+ */
 export var Tab = React.forwardRef(function Tab(_a, ref) {
     var _b = _a.active, active = _b === void 0 ? false : _b, children = _a.children, _c = _a.onMount, onMount = _c === void 0 ? noop : _c, _d = _a.onUnmount, onUnmount = _d === void 0 ? noop : _d, _e = _a.overflowing, overflowing = _e === void 0 ? false : _e, _f = _a.dropdown, dropdown = _f === void 0 ? false : _f, _g = _a.variant, variant = _g === void 0 ? '' : _g, props = __rest(_a, ["active", "children", "onMount", "onUnmount", "overflowing", "dropdown", "variant"]);
     var innerRef = React.useRef(null);