@instructure/ui-spinner 8.45.1-snapshot-3 → 8.46.0

package/types/Spinner/__new-tests__/Spinner.test.d.ts

@@ -0,0 +1,2 @@
+import '@testing-library/jest-dom/extend-expect';
+//# sourceMappingURL=Spinner.test.d.ts.map

package/types/Spinner/__new-tests__/Spinner.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Spinner.test.d.ts","sourceRoot":"","sources":["../../../src/Spinner/__new-tests__/Spinner.test.tsx"],"names":[],"mappings":"AA0BA,OAAO,yCAAyC,CAAA"}

package/types/Spinner/index.d.ts

@@ -1,30 +1,32 @@
 /** @jsx jsx */
 import { Component } from 'react';
 import { jsx } from '@instructure/emotion';
-import type { SpinnerProps } from './props';
+import type { SpinnerProps, SpinnerState } from './props';
 /**
 ---
 category: components
 ---
 @tsProps
 **/
-declare class Spinner extends Component<SpinnerProps> {
+declare class Spinner extends Component<SpinnerProps, SpinnerState> {
     static readonly componentId = "Spinner";
     static allowedProps: readonly (keyof {
+        as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
+        delay?: number | undefined;
+        elementRef?: ((element: Element | null) => void) | undefined;
+        margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
         renderTitle?: import("@instructure/shared-types").Renderable;
-        size?: "small" | "x-small" | "medium" | "large" | undefined;
+        size?: "small" | "medium" | "large" | "x-small" | undefined;
         variant?: "default" | "inverse" | undefined;
-        margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
-        elementRef?: ((element: Element | null) => void) | undefined;
-        as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
     })[];
     static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
+        as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
+        delay?: number | undefined;
+        elementRef?: ((element: Element | null) => void) | undefined;
+        margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
         renderTitle?: import("@instructure/shared-types").Renderable;
-        size?: "small" | "x-small" | "medium" | "large" | undefined;
+        size?: "small" | "medium" | "large" | "x-small" | undefined;
         variant?: "default" | "inverse" | undefined;
-        margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
-        elementRef?: ((element: Element | null) => void) | undefined;
-        as?: import("@instructure/shared-types/types/CommonProps").AsElementType | undefined;
     }>;
     static defaultProps: {
         as: string;
@@ -33,12 +35,15 @@ declare class Spinner extends Component<SpinnerProps> {
     };
     ref: Element | null;
     private readonly titleId?;
+    private delayTimeout?;
     handleRef: (el: Element | null) => void;
     constructor(props: SpinnerProps);
     componentDidMount(): void;
     componentDidUpdate(): void;
+    componentWillUnmount(): void;
     radius(): "0.5em" | "1em" | "2.25em" | "1.75em";
-    render(): jsx.JSX.Element;
+    renderSpinner(): jsx.JSX.Element;
+    render(): jsx.JSX.Element | null;
 }
 export default Spinner;
 export { Spinner };

package/types/Spinner/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Spinner/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAWjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAG3C;;;;;GAKG;AACH,cAGM,OAAQ,SAAQ,SAAS,CAAC,YAAY,CAAC;IAC3C,MAAM,CAAC,QAAQ,CAAC,WAAW,aAAY;IACvC,MAAM,CAAC,YAAY;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;MAIlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAQ;IAEjC,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;gBAEW,KAAK,EAAE,YAAY;IAM/B,iBAAiB;IAIjB,kBAAkB;IAIlB,MAAM;IAaN,MAAM;CAiDP;AAED,eAAe,OAAO,CAAA;AACtB,OAAO,EAAE,OAAO,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Spinner/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAWjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAGzD;;;;;GAKG;AACH,cAGM,OAAQ,SAAQ,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC;IACzD,MAAM,CAAC,QAAQ,CAAC,WAAW,aAAY;IACvC,MAAM,CAAC,YAAY;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;MAIlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAQ;IACjC,OAAO,CAAC,YAAY,CAAC,CAAgB;IAErC,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;gBAEW,KAAK,EAAE,YAAY;IAU/B,iBAAiB;IAWjB,kBAAkB;IAIlB,oBAAoB;IAIpB,MAAM;IAaN,aAAa;IAkDb,MAAM;CAGP;AAED,eAAe,OAAO,CAAA;AACtB,OAAO,EAAE,OAAO,EAAE,CAAA"}

package/types/Spinner/props.d.ts

@@ -4,17 +4,17 @@ import type { WithDeterministicIdProps } from '@instructure/ui-react-utils';
 import { Renderable } from '@instructure/shared-types';
 type SpinnerOwnProps = {
     /**
-     * Give the spinner a title to be read by screenreaders
+     * Render Spinner "as" another HTML element
      */
-    renderTitle?: Renderable;
+    as?: AsElementType;
     /**
-     * Different-sized spinners
+     * delay spinner rendering for a time (in ms). Used to prevent flickering in case of very fast load times
      */
-    size?: 'x-small' | 'small' | 'medium' | 'large';
+    delay?: number;
     /**
-     * Different color schemes for use with light or dark backgrounds
+     * provides a reference to the underlying html root element
      */
-    variant?: 'default' | 'inverse';
+    elementRef?: (element: Element | null) => void;
     /**
      * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
      * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
@@ -22,17 +22,27 @@ type SpinnerOwnProps = {
      */
     margin?: Spacing;
     /**
-     * provides a reference to the underlying html root element
+     * Give the spinner a title to be read by screenreaders
      */
-    elementRef?: (element: Element | null) => void;
-    as?: AsElementType;
+    renderTitle?: Renderable;
+    /**
+     * Different-sized spinners
+     */
+    size?: 'x-small' | 'small' | 'medium' | 'large';
+    /**
+     * Different color schemes for use with light or dark backgrounds
+     */
+    variant?: 'default' | 'inverse';
 };
 type PropKeys = keyof SpinnerOwnProps;
 type AllowedPropKeys = Readonly<Array<PropKeys>>;
 type SpinnerProps = SpinnerOwnProps & WithStyleProps<SpinnerTheme, SpinnerStyle> & OtherHTMLAttributes<SpinnerOwnProps> & WithDeterministicIdProps;
+type SpinnerState = {
+    shouldRender: boolean;
+};
 type SpinnerStyle = ComponentStyle<'spinner' | 'circle' | 'circleTrack' | 'circleSpin'>;
 declare const propTypes: PropValidators<PropKeys>;
 declare const allowedProps: AllowedPropKeys;
-export type { SpinnerProps, SpinnerStyle };
+export type { SpinnerProps, SpinnerState, SpinnerStyle };
 export { propTypes, allowedProps };
 //# sourceMappingURL=props.d.ts.map

package/types/Spinner/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Spinner/props.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,cAAc,EACd,YAAY,EACb,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAEtD,KAAK,eAAe,GAAG;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,CAAA;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IAC/C;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,CAAA;IAC/B;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C,EAAE,CAAC,EAAE,aAAa,CAAA;CACnB,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,eAAe,CAAA;AAErC,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,YAAY,GAAG,eAAe,GACjC,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,GAC1C,mBAAmB,CAAC,eAAe,CAAC,GACpC,wBAAwB,CAAA;AAE1B,KAAK,YAAY,GAAG,cAAc,CAChC,SAAS,GAAG,QAAQ,GAAG,aAAa,GAAG,YAAY,CACpD,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAOvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAOnB,CAAA;AAED,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,CAAA;AAC1C,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Spinner/props.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,cAAc,EACd,YAAY,EACb,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAEtD,KAAK,eAAe,GAAG;IACrB;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,CAAA;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IAC/C;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,CAAA;CAChC,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,eAAe,CAAA;AAErC,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,YAAY,GAAG,eAAe,GACjC,cAAc,CAAC,YAAY,EAAE,YAAY,CAAC,GAC1C,mBAAmB,CAAC,eAAe,CAAC,GACpC,wBAAwB,CAAA;AAE1B,KAAK,YAAY,GAAG;IAClB,YAAY,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,KAAK,YAAY,GAAG,cAAc,CAChC,SAAS,GAAG,QAAQ,GAAG,aAAa,GAAG,YAAY,CACpD,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAQvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAQnB,CAAA;AAED,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,CAAA;AACxD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}