@instructure/ui-rating 11.7.2-snapshot-19 → 11.7.2-snapshot-21

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

@@ -0,0 +1,39 @@
+import { Component } from 'react';
+import { RatingIcon } from '../../RatingIcon/v2';
+import type { RatingProps } from './props';
+/**
+---
+category: components
+---
+**/
+declare class Rating extends Component<RatingProps> {
+    static readonly componentId = "Rating";
+    static allowedProps: readonly (keyof {
+        label: string;
+        formatValueText?: (filled: number, iconCount: number) => string;
+        iconCount?: 3 | 5;
+        size?: "small" | "medium" | "large";
+        valueMax?: number;
+        valueNow?: number;
+        animateFill?: boolean;
+        margin?: import("@instructure/emotion").Spacing;
+    })[];
+    static defaultProps: {
+        animateFill: boolean;
+        formatValueText: (filled: number, iconCount: number) => string;
+        iconCount: number;
+        size: string;
+        valueNow: number;
+    };
+    static Icon: typeof RatingIcon;
+    ref: Element | null;
+    handleRef: (el: Element | null) => void;
+    componentDidMount(): void;
+    componentDidUpdate(): void;
+    get filled(): number;
+    get empty(): number;
+    render(): import("@emotion/react/jsx-runtime").JSX.Element;
+}
+export default Rating;
+export { Rating };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Rating/v2/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAKjC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAGhD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAG1C;;;;GAIG;AACH,cACM,MAAO,SAAQ,SAAS,CAAC,WAAW,CAAC;IACzC,MAAM,CAAC,QAAQ,CAAC,WAAW,YAAW;IAEtC,MAAM,CAAC,YAAY;;;;;;;;;SAAe;IAElC,MAAM,CAAC,YAAY;;kCAES,MAAM,aAAa,MAAM;;;;MAKpD;IAED,MAAM,CAAC,IAAI,oBAAa;IAExB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,GAAI,IAAI,OAAO,GAAG,IAAI,UAE9B;IAED,iBAAiB;IAIjB,kBAAkB;IAIlB,IAAI,MAAM,WAcT;IAED,IAAI,KAAK,WAER;IAED,MAAM;CAoCP;AAED,eAAe,MAAM,CAAA;AACrB,OAAO,EAAE,MAAM,EAAE,CAAA"}

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

@@ -0,0 +1,46 @@
+import type { Spacing, WithStyleProps, ComponentStyle } from '@instructure/emotion';
+import type { OtherHTMLAttributes } from '@instructure/shared-types';
+type RatingOwnProps = {
+    /**
+     * A label is required for accessibility
+     */
+    label: string;
+    /**
+     * 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;
+};
+type PropKeys = keyof RatingOwnProps;
+type AllowedPropKeys = Readonly<Array<PropKeys>>;
+type RatingProps = RatingOwnProps & WithStyleProps<null, RatingStyle> & OtherHTMLAttributes<RatingOwnProps>;
+type RatingStyle = ComponentStyle<'rating'>;
+declare const allowedProps: AllowedPropKeys;
+export type { RatingProps, RatingStyle };
+export { allowedProps };
+//# sourceMappingURL=props.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/Rating/v2/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAEpE,KAAK,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,KAAK,QAAQ,GAAG,MAAM,cAAc,CAAA;AAEpC,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,WAAW,GAAG,cAAc,GAC/B,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,GACjC,mBAAmB,CAAC,cAAc,CAAC,CAAA;AAErC,KAAK,WAAW,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA;AAC3C,QAAA,MAAM,YAAY,EAAE,eASnB,CAAA;AAED,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,CAAA;AACxC,OAAO,EAAE,YAAY,EAAE,CAAA"}

package/types/Rating/v2/styles.d.ts

@@ -0,0 +1,14 @@
+import type { RatingStyle } from './props';
+/**
+ * ---
+ * private: true
+ * ---
+ * Generates the style object from the theme and provided additional information
+ * @param  {Object} componentTheme The theme variable object.
+ * @param  {Object} props the props of the component, the style is applied to
+ * @param  {Object} state the state of the component, the style is applied to
+ * @return {Object} The final style object, which will be used in the component
+ */
+declare const generateStyle: () => RatingStyle;
+export default generateStyle;
+//# sourceMappingURL=styles.d.ts.map

package/types/Rating/v2/styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../../src/Rating/v2/styles.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE1C;;;;;;;;;GASG;AACH,QAAA,MAAM,aAAa,QAAO,WAOzB,CAAA;AAED,eAAe,aAAa,CAAA"}

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

@@ -0,0 +1,39 @@
+import { Component } from 'react';
+import type { RequestAnimationFrameType } from '@instructure/ui-dom-utils';
+import type { RatingIconProps, RatingIconState } from './props';
+/**
+---
+parent: Rating
+id: Rating.Icon
+---
+**/
+declare class RatingIcon extends Component<RatingIconProps, RatingIconState> {
+    static readonly componentId = "Rating.Icon";
+    static allowedProps: readonly (keyof {
+        animationDelay?: number;
+        animateFill?: boolean;
+        filled?: boolean;
+        size?: "small" | "medium" | "large";
+    })[];
+    static defaultProps: {
+        animationDelay: number;
+        animateFill: boolean;
+        filled: boolean;
+        size: string;
+    };
+    ref: HTMLSpanElement | null;
+    constructor(props: RatingIconProps);
+    _timeouts: ReturnType<typeof setTimeout>[];
+    _animation: RequestAnimationFrameType | undefined;
+    componentDidMount(): void;
+    componentDidUpdate(prevProps: RatingIconProps): void;
+    componentWillUnmount(): void;
+    makeStyleProps: () => {
+        filled: boolean;
+    };
+    fill: () => void;
+    render(): import("@emotion/react/jsx-runtime").JSX.Element;
+}
+export default RatingIcon;
+export { RatingIcon };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/RatingIcon/v2/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAIjC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAA;AAK1E,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAS/D;;;;;GAKG;AACH,cACM,UAAW,SAAQ,SAAS,CAAC,eAAe,EAAE,eAAe,CAAC;IAClE,MAAM,CAAC,QAAQ,CAAC,WAAW,iBAAgB;IAE3C,MAAM,CAAC,YAAY;;;;;SAAe;IAElC,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;CA2BP;AAED,eAAe,UAAU,CAAA;AACzB,OAAO,EAAE,UAAU,EAAE,CAAA"}

package/types/RatingIcon/v2/props.d.ts

@@ -0,0 +1,19 @@
+import type { RatingIconTheme } from '@instructure/shared-types';
+import type { WithStyleProps, ComponentStyle } from '@instructure/emotion';
+type RatingIconOwnProps = {
+    animationDelay?: number;
+    animateFill?: boolean;
+    filled?: boolean;
+    size?: 'small' | 'medium' | 'large';
+};
+export type RatingIconState = {
+    filled: boolean;
+};
+type PropKeys = keyof RatingIconOwnProps;
+type AllowedPropKeys = Readonly<Array<PropKeys>>;
+type RatingIconProps = RatingIconOwnProps & WithStyleProps<RatingIconTheme, RatingIconStyle>;
+type RatingIconStyle = ComponentStyle<'ratingIcon' | 'icon'>;
+declare const allowedProps: AllowedPropKeys;
+export type { RatingIconProps, RatingIconStyle };
+export { allowedProps };
+//# sourceMappingURL=props.d.ts.map

package/types/RatingIcon/v2/props.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../src/RatingIcon/v2/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1E,KAAK,kBAAkB,GAAG;IACxB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,kBAAkB,CAAA;AAExC,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,eAAe,GAAG,kBAAkB,GACvC,cAAc,CAAC,eAAe,EAAE,eAAe,CAAC,CAAA;AAElD,KAAK,eAAe,GAAG,cAAc,CAAC,YAAY,GAAG,MAAM,CAAC,CAAA;AAC5D,QAAA,MAAM,YAAY,EAAE,eAKnB,CAAA;AAED,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,CAAA"}

package/types/RatingIcon/v2/styles.d.ts

@@ -0,0 +1,15 @@
+import type { NewComponentTypes, SharedTokens } from '@instructure/ui-themes';
+import type { RatingIconProps, RatingIconState, RatingIconStyle } from './props';
+/**
+ * ---
+ * private: true
+ * ---
+ * Generates the style object from the theme and provided additional information
+ * @param  {Object} componentTheme The theme variable object.
+ * @param  {Object} props the props of the component, the style is applied to
+ * @param  {Object} state the state of the component, the style is applied to
+ * @return {Object} The final style object, which will be used in the component
+ */
+declare const generateStyle: (componentTheme: NewComponentTypes["RatingIcon"], _props: RatingIconProps, state: RatingIconState, _sharedTokens: SharedTokens) => RatingIconStyle;
+export default generateStyle;
+//# sourceMappingURL=styles.d.ts.map

package/types/RatingIcon/v2/styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../../src/RatingIcon/v2/styles.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAC7E,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAEhF;;;;;;;;;GASG;AACH,QAAA,MAAM,aAAa,GACjB,gBAAgB,iBAAiB,CAAC,YAAY,CAAC,EAC/C,QAAQ,eAAe,EACvB,OAAO,eAAe,EACtB,eAAe,YAAY,KAC1B,eA0BF,CAAA;AAED,eAAe,aAAa,CAAA"}

package/types/exports/b.d.ts

@@ -0,0 +1,5 @@
+export { Rating } from '../Rating/v2';
+export { RatingIcon } from '../RatingIcon/v2';
+export type { RatingProps } from '../Rating/v2/props';
+export type { RatingIconProps } from '../RatingIcon/v2/props';
+//# sourceMappingURL=b.d.ts.map

package/types/exports/b.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"b.d.ts","sourceRoot":"","sources":["../../src/exports/b.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACrD,YAAY,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA"}