@instructure/ui-rating 8.19.1-snapshot.8 → 8.20.0

package/types/Rating/index.d.ts

@@ -7,40 +7,33 @@ import type { RatingProps } from './props';
 ---
 category: components
 ---
+@tsProps
 **/
 declare class Rating extends Component<RatingProps> {
     static readonly componentId = "Rating";
     static allowedProps: readonly (keyof {
         label: string;
-        formatValueText?: ((...args: any[]) => any) | undefined;
+        formatValueText?: ((filled: number, iconCount: number) => string) | undefined;
         iconCount?: 3 | 5 | undefined;
         size?: "small" | "medium" | "large" | undefined;
         valueMax?: number | undefined;
         valueNow?: number | undefined;
         animateFill?: boolean | undefined;
-        margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined; /**
-        ---
-        category: components
-        ---
-        **/
+        margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
     })[];
     static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
         label: string;
-        formatValueText?: ((...args: any[]) => any) | undefined;
+        formatValueText?: ((filled: number, iconCount: number) => string) | undefined;
         iconCount?: 3 | 5 | undefined;
         size?: "small" | "medium" | "large" | undefined;
         valueMax?: number | undefined;
         valueNow?: number | undefined;
         animateFill?: boolean | undefined;
-        margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined; /**
-        ---
-        category: components
-        ---
-        **/
+        margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
     }>;
     static defaultProps: {
         animateFill: boolean;
-        formatValueText: (filled: any, iconCount: any) => string;
+        formatValueText: (filled: number, iconCount: number) => string;
         iconCount: number;
         size: string;
         valueNow: number;
@@ -50,7 +43,7 @@ declare class Rating extends Component<RatingProps> {
     handleRef: (el: Element | null) => void;
     componentDidMount(): void;
     componentDidUpdate(): void;
-    get filled(): number | undefined;
+    get filled(): number;
     get empty(): number;
     render(): jsx.JSX.Element;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Rating/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAMjC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAErD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAG1C;;;;GAIG;AACH,cAEM,MAAO,SAAQ,SAAS,CAAC,WAAW,CAAC;IACzC,MAAM,CAAC,QAAQ,CAAC,WAAW,YAAW;IAEtC,MAAM,CAAC,YAAY;;;;;;;;0GAVrB;;;;WAIG;SAMiC;IAClC,MAAM,CAAC,SAAS;;;;;;;;0GAXlB;;;;WAIG;OAO2B;IAE5B,MAAM,CAAC,YAAY;;;;;;MAOlB;IAED,MAAM,CAAC,IAAI,oBAAa;IAExB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,iBAAiB;IAIjB,kBAAkB;IAIlB,IAAI,MAAM,uBAiBT;IAED,IAAI,KAAK,WAGR;IAED,MAAM;CA6CP;AAED,eAAe,MAAM,CAAA;AACrB,OAAO,EAAE,MAAM,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Rating/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAMjC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAErD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAG1C;;;;;GAKG;AACH,cAEM,MAAO,SAAQ,SAAS,CAAC,WAAW,CAAC;IACzC,MAAM,CAAC,QAAQ,CAAC,WAAW,YAAW;IAEtC,MAAM,CAAC,YAAY;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;kCAES,MAAM,aAAa,MAAM;;;;MAKpD;IAED,MAAM,CAAC,IAAI,oBAAa;IAExB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,iBAAiB;IAIjB,kBAAkB;IAIlB,IAAI,MAAM,WAcT;IAED,IAAI,KAAK,WAER;IAED,MAAM;CAmCP;AAED,eAAe,MAAM,CAAA;AACrB,OAAO,EAAE,MAAM,EAAE,CAAA"}

package/types/Rating/props.d.ts

@@ -1,13 +1,39 @@
 import type { Spacing, WithStyleProps, ComponentStyle } from '@instructure/emotion';
 import type { OtherHTMLAttributes, PropValidators } from '@instructure/shared-types';
 declare type RatingOwnProps = {
+    /**
+     * A label is required for accessibility
+     */
     label: string;
-    formatValueText?: (...args: any[]) => any;
+    /**
+     * A function that returns the current value formatted for screen readers
+     */
+    formatValueText?: (filled: number, iconCount: number) => string;
+    /**
+     * Choose from a 0-3 or 0-5 rating system
+     */
     iconCount?: 3 | 5;
+    /**
+     * Choose from different rating icon sizes
+     */
     size?: 'small' | 'medium' | 'large';
+    /**
+     * The maximum rating (defaults to iconCount)
+     */
     valueMax?: number;
+    /**
+     * The current rating
+     */
     valueNow?: number;
+    /**
+     * Set to make the icons animate when they become filled
+     */
     animateFill?: boolean;
+    /**
+     * Valid values are `0`, `none`, `auto`, `xxx-small`, `xx-small`, `x-small`,
+     * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
+     * familiar CSS-like shorthand. For example: `margin="small auto large"`.
+     */
     margin?: Spacing;
 };
 declare type PropKeys = keyof RatingOwnProps;

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

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Rating/props.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAElC,aAAK,cAAc,GAAG;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,eAAe,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACzC,SAAS,CAAC,EAAE,CAAC,GAAG,CAAC,CAAA;IACjB,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,cAAc,CAAA;AAEpC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,WAAW,GAAG,cAAc,GAC/B,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,GACjC,mBAAmB,CAAC,cAAc,CAAC,CAAA;AAErC,aAAK,WAAW,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA;AAE3C,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAmCvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eASnB,CAAA;AAED,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Rating/props.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAElC,aAAK,cAAc,GAAG;IACpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,MAAM,CAAA;IAC/D;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,GAAG,CAAC,CAAA;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,cAAc,CAAA;AAEpC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,WAAW,GAAG,cAAc,GAC/B,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,GACjC,mBAAmB,CAAC,cAAc,CAAC,CAAA;AAErC,aAAK,WAAW,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA;AAE3C,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CASvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eASnB,CAAA;AAED,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}

package/types/RatingIcon/index.d.ts

@@ -8,6 +8,7 @@ import type { RatingIconProps, RatingIconState } from './props';
 parent: Rating
 id: Rating.Icon
 ---
+@tsProps
 **/
 declare class RatingIcon extends Component<RatingIconProps, RatingIconState> {
     static readonly componentId = "Rating.Icon";
@@ -29,9 +30,9 @@ declare class RatingIcon extends Component<RatingIconProps, RatingIconState> {
         filled: boolean;
         size: string;
     };
-    ref: Element | null;
-    constructor(props: any);
-    _timeouts: never[];
+    ref: HTMLSpanElement | null;
+    constructor(props: RatingIconProps);
+    _timeouts: ReturnType<typeof setTimeout>[];
     _animation: RequestAnimationFrameType | undefined;
     componentDidMount(): void;
     componentDidUpdate(prevProps: RatingIconProps): void;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/RatingIcon/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAIjC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAA;AAG1E,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAGrD,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAG/D;;;;;GAKG;AACH,cACM,UAAW,SAAQ,SAAS,CAAC,eAAe,EAAE,eAAe,CAAC;IAClE,MAAM,CAAC,QAAQ,CAAC,WAAW,iBAAgB;IAE3C,MAAM,CAAC,YAAY;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;MAKlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;gBAGd,KAAK,KAAA;IASjB,SAAS,UAAK;IACd,UAAU,EAAE,yBAAyB,GAAG,SAAS,CAAA;IAEjD,iBAAiB;IAQjB,kBAAkB,CAAC,SAAS,EAAE,eAAe;IAW7C,oBAAoB;IAKpB,cAAc;;MAEb;IAED,IAAI,aAMH;IAED,MAAM;CAuBP;AAED,eAAe,UAAU,CAAA;AACzB,OAAO,EAAE,UAAU,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/RatingIcon/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAIjC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAA;AAG1E,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAGrD,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAG/D;;;;;;GAMG;AACH,cACM,UAAW,SAAQ,SAAS,CAAC,eAAe,EAAE,eAAe,CAAC;IAClE,MAAM,CAAC,QAAQ,CAAC,WAAW,iBAAgB;IAE3C,MAAM,CAAC,YAAY;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;OAAY;IAE5B,MAAM,CAAC,YAAY;;;;;MAKlB;IAED,GAAG,EAAE,eAAe,GAAG,IAAI,CAAO;gBAEtB,KAAK,EAAE,eAAe;IAQlC,SAAS,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,EAAE,CAAK;IAC/C,UAAU,EAAE,yBAAyB,GAAG,SAAS,CAAA;IAEjD,iBAAiB;IAOjB,kBAAkB,CAAC,SAAS,EAAE,eAAe;IAW7C,oBAAoB;IAKpB,cAAc;;MAEb;IAED,IAAI,aAMH;IAED,MAAM;CAuBP;AAED,eAAe,UAAU,CAAA;AACzB,OAAO,EAAE,UAAU,EAAE,CAAA"}

package/LICENSE.md

@@ -1,27 +0,0 @@
----
-title: The MIT License (MIT)
-category: Getting Started
-order: 9
----
-
-# The MIT License (MIT)
-
-Copyright (c) 2015 Instructure, Inc.
-
-**Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions.**
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.