@instructure/ui-rating 8.8.1-snapshot.3 → 8.9.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [8.9.0](https://github.com/instructure/instructure-ui/compare/v8.8.0...v8.9.0) (2021-09-15)
+
+### Bug Fixes
+
+- fix shared-types TS errors ([7b83164](https://github.com/instructure/instructure-ui/commit/7b83164f4c5872f3a217e010563f59bf584ae4fc))
+
 # [8.8.0](https://github.com/instructure/instructure-ui/compare/v8.7.0...v8.8.0) (2021-08-27)
 
 **Note:** Version bump only for package @instructure/ui-rating

package/es/Rating/index.js

@@ -26,34 +26,38 @@ var _dec, _dec2, _class, _class2, _temp;
 
 /** @jsx jsx */
 import { Component } from 'react';
-import PropTypes from 'prop-types';
 import { View } from '@instructure/ui-view';
 import { ScreenReaderContent } from '@instructure/ui-a11y-content';
 import { omitProps } from '@instructure/ui-react-utils';
 import { testable } from '@instructure/ui-testable';
 import { RatingIcon } from '../RatingIcon';
-import { withStyle, jsx, ThemeablePropTypes } from '@instructure/emotion';
+import { withStyle, jsx } from '@instructure/emotion';
 import generateStyle from './styles';
-
+import { allowedProps, propTypes } from './props';
 /**
 ---
 category: components
 ---
 **/
+
 let Rating = (_dec = withStyle(generateStyle), _dec2 = testable(), _dec(_class = _dec2(_class = (_temp = _class2 = class Rating extends Component {
   componentDidMount() {
-    this.props.makeStyles();
+    var _this$props$makeStyle, _this$props;
+
+    (_this$props$makeStyle = (_this$props = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props);
   }
 
-  componentDidUpdate(prevProps, prevState, snapshot) {
-    this.props.makeStyles();
+  componentDidUpdate() {
+    var _this$props$makeStyle2, _this$props2;
+
+    (_this$props$makeStyle2 = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props2);
   }
 
   get filled() {
-    const _this$props = this.props,
-          valueNow = _this$props.valueNow,
-          iconCount = _this$props.iconCount,
-          valueMax = _this$props.valueMax; // prevent divide by zero errors
+    const _this$props3 = this.props,
+          valueNow = _this$props3.valueNow,
+          iconCount = _this$props3.iconCount,
+          valueMax = _this$props3.valueMax; // prevent divide by zero errors
 
     const max = valueMax > 0 ? valueMax : iconCount;
     const filledIcons = Math.round(valueNow * iconCount / max); // Handle edge case where valueNow is greater than valueMax
@@ -70,17 +74,19 @@ let Rating = (_dec = withStyle(generateStyle), _dec2 = testable(), _dec(_class =
   }
 
   render() {
-    const _this$props2 = this.props,
-          iconCount = _this$props2.iconCount,
-          animateFill = _this$props2.animateFill,
-          size = _this$props2.size,
-          margin = _this$props2.margin,
-          label = _this$props2.label,
-          formatValueText = _this$props2.formatValueText;
+    var _this$props$styles;
+
+    const _this$props4 = this.props,
+          iconCount = _this$props4.iconCount,
+          animateFill = _this$props4.animateFill,
+          size = _this$props4.size,
+          margin = _this$props4.margin,
+          label = _this$props4.label,
+          formatValueText = _this$props4.formatValueText;
     const valueText = label + ' ' + formatValueText(this.filled, iconCount);
     const passthroughProps = View.omitViewProps(omitProps(this.props, Rating.propTypes), Rating);
     return jsx(View, Object.assign({}, passthroughProps, {
-      css: this.props.styles.rating,
+      css: (_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.rating,
       margin: margin,
       display: "inline-block"
     }), jsx(ScreenReaderContent, null, valueText), [...Array(this.filled)].map((x, i) => jsx(RatingIcon, {
@@ -95,60 +101,12 @@ let Rating = (_dec = withStyle(generateStyle), _dec2 = testable(), _dec(_class =
     })));
   }
 
-}, _class2.displayName = "Rating", _class2.componentId = 'Rating', _class2.propTypes = {
-  /**
-   * A label is required for accessibility
-   */
-  label: PropTypes.string.isRequired,
-
-  /**
-   * A function that returns the current value formatted for screen readers
-   */
-  formatValueText: PropTypes.func,
-
-  /**
-   * Choose from a 0-3 or 0-5 rating system
-   */
-  iconCount: PropTypes.oneOf([3, 5]),
-
-  /**
-   * Choose from different rating icon sizes
-   */
-  size: PropTypes.oneOf(['small', 'medium', 'large']),
-
-  /**
-   * The maximum rating (defaults to iconCount)
-   */
-  valueMax: PropTypes.number,
-
-  /**
-   * The current rating
-   */
-  valueNow: PropTypes.number,
-
-  /**
-   * Set to make the icons animate when they become filled
-   */
-  animateFill: PropTypes.bool,
-
-  /**
-   * 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: ThemeablePropTypes.spacing,
-  // eslint-disable-next-line react/require-default-props
-  makeStyles: PropTypes.func,
-  // eslint-disable-next-line react/require-default-props
-  styles: PropTypes.object
-}, _class2.defaultProps = {
+}, _class2.displayName = "Rating", _class2.componentId = 'Rating', _class2.allowedProps = allowedProps, _class2.propTypes = propTypes, _class2.defaultProps = {
   animateFill: false,
   formatValueText: (filled, iconCount) => `${filled} / ${iconCount}`,
   iconCount: 3,
   size: 'medium',
-  valueNow: 0,
-  margin: void 0,
-  valueMax: void 0
+  valueNow: 0
 }, _class2.Icon = RatingIcon, _temp)) || _class) || _class);
 export default Rating;
 export { Rating };

package/es/Rating/props.js

@@ -0,0 +1,70 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present 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.
+ */
+import PropTypes from 'prop-types';
+import { ThemeablePropTypes } from '@instructure/emotion';
+const propTypes = {
+  /**
+   * A label is required for accessibility
+   */
+  label: PropTypes.string.isRequired,
+
+  /**
+   * A function that returns the current value formatted for screen readers
+   */
+  formatValueText: PropTypes.func,
+
+  /**
+   * Choose from a 0-3 or 0-5 rating system
+   */
+  iconCount: PropTypes.oneOf([3, 5]),
+
+  /**
+   * Choose from different rating icon sizes
+   */
+  size: PropTypes.oneOf(['small', 'medium', 'large']),
+
+  /**
+   * The maximum rating (defaults to iconCount)
+   */
+  valueMax: PropTypes.number,
+
+  /**
+   * The current rating
+   */
+  valueNow: PropTypes.number,
+
+  /**
+   * Set to make the icons animate when they become filled
+   */
+  animateFill: PropTypes.bool,
+
+  /**
+   * 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: ThemeablePropTypes.spacing
+};
+const allowedProps = ['label', 'formatValueText', 'iconCount', 'size', 'valueMax', 'valueNow', 'animateFill', 'margin'];
+export { propTypes, allowedProps };

package/es/RatingIcon/index.js

@@ -26,20 +26,20 @@ var _dec, _class, _class2, _temp;
 
 /** @jsx jsx */
 import { Component } from 'react';
-import PropTypes from 'prop-types';
 import { IconStarSolid, IconStarLightSolid } from '@instructure/ui-icons';
 import { requestAnimationFrame } from '@instructure/ui-dom-utils';
 import { Transition } from '@instructure/ui-motion';
 import { withStyle, jsx } from '@instructure/emotion';
 import generateStyle from './styles';
 import generateComponentTheme from './theme';
-
+import { allowedProps, propTypes } from './props';
 /**
 ---
 parent: Rating
 id: Rating.Icon
 ---
 **/
+
 let RatingIcon = (_dec = withStyle(generateStyle, generateComponentTheme), _dec(_class = (_temp = _class2 = class RatingIcon extends Component {
   constructor(props) {
     super();
@@ -66,19 +66,23 @@ let RatingIcon = (_dec = withStyle(generateStyle, generateComponentTheme), _dec(
   }
 
   componentDidMount() {
-    this.props.makeStyles(this.makeStyleProps());
+    var _this$props$makeStyle, _this$props;
+
+    (_this$props$makeStyle = (_this$props = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props, this.makeStyleProps());
 
     if (this.props.animateFill) {
       this._timeouts.push(setTimeout(this.fill, this.props.animationDelay));
     }
   }
 
-  componentDidUpdate(prevProps, prevState, snapshot) {
+  componentDidUpdate(prevProps) {
+    var _this$props$makeStyle2, _this$props2;
+
     if (this.props.animateFill && this.props.filled && this.props.filled !== prevProps.filled) {
       this.fill();
     }
 
-    this.props.makeStyles(this.makeStyleProps());
+    (_this$props$makeStyle2 = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props2, this.makeStyleProps());
   }
 
   componentWillUnmount() {
@@ -88,31 +92,24 @@ let RatingIcon = (_dec = withStyle(generateStyle, generateComponentTheme), _dec(
   }
 
   render() {
+    var _this$props$styles, _this$props$styles2, _this$props$styles3;
+
     const animateFill = this.props.animateFill;
     const Icon = this.state.filled ? IconStarSolid : IconStarLightSolid;
     return jsx("span", {
-      css: this.props.styles.ratingIcon
+      css: (_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.ratingIcon
     }, jsx("span", null, this.state.filled && animateFill ? jsx(Transition, {
       in: true,
       transitionOnMount: true,
       type: "scale"
     }, jsx(Icon, {
-      css: this.props.styles.icon
+      css: (_this$props$styles2 = this.props.styles) === null || _this$props$styles2 === void 0 ? void 0 : _this$props$styles2.icon
     })) : jsx(Icon, {
-      css: this.props.styles.icon
+      css: (_this$props$styles3 = this.props.styles) === null || _this$props$styles3 === void 0 ? void 0 : _this$props$styles3.icon
     })));
   }
 
-}, _class2.displayName = "RatingIcon", _class2.componentId = 'Rating.Icon', _class2.propTypes = {
-  animationDelay: PropTypes.number,
-  animateFill: PropTypes.bool,
-  filled: PropTypes.bool,
-  size: PropTypes.oneOf(['small', 'medium', 'large']),
-  // eslint-disable-next-line react/require-default-props
-  makeStyles: PropTypes.func,
-  // eslint-disable-next-line react/require-default-props
-  styles: PropTypes.object
-}, _class2.defaultProps = {
+}, _class2.displayName = "RatingIcon", _class2.componentId = 'Rating.Icon', _class2.allowedProps = allowedProps, _class2.propTypes = propTypes, _class2.defaultProps = {
   animationDelay: 200,
   animateFill: false,
   filled: false,

package/{src/RatingIcon/types.ts → es/RatingIcon/props.js}

@@ -21,16 +21,12 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-
-export type RatingIconProps = {
-  animationDelay?: number
-  animateFill?: boolean
-  filled?: boolean
-  size?: 'small' | 'medium' | 'large'
-  makeStyles?: (...args: any[]) => any
-  styles?: any
-}
-
-export type RatingIconState = {
-  filled: boolean
-}
+import PropTypes from 'prop-types';
+const propTypes = {
+  animationDelay: PropTypes.number,
+  animateFill: PropTypes.bool,
+  filled: PropTypes.bool,
+  size: PropTypes.oneOf(['small', 'medium', 'large'])
+};
+const allowedProps = ['animationDelay', 'animateFill', 'filled', 'size'];
+export { propTypes, allowedProps };

package/lib/Rating/index.js

@@ -9,8 +9,6 @@ exports.Rating = exports.default = void 0;
 
 var _react = require("react");
 
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _View = require("@instructure/ui-view/lib/View");
 
 var _ScreenReaderContent = require("@instructure/ui-a11y-content/lib/ScreenReaderContent");
@@ -25,6 +23,8 @@ var _emotion = require("@instructure/emotion");
 
 var _styles = _interopRequireDefault(require("./styles"));
 
+var _props = require("./props");
+
 var _dec, _dec2, _class, _class2, _temp;
 
 /**
@@ -34,18 +34,22 @@ category: components
 **/
 let Rating = (_dec = (0, _emotion.withStyle)(_styles.default), _dec2 = (0, _testable.testable)(), _dec(_class = _dec2(_class = (_temp = _class2 = class Rating extends _react.Component {
   componentDidMount() {
-    this.props.makeStyles();
+    var _this$props$makeStyle, _this$props;
+
+    (_this$props$makeStyle = (_this$props = this.props).makeStyles) === null || _this$props$makeStyle === void 0 ? void 0 : _this$props$makeStyle.call(_this$props);
   }
 
-  componentDidUpdate(prevProps, prevState, snapshot) {
-    this.props.makeStyles();
+  componentDidUpdate() {
+    var _this$props$makeStyle2, _this$props2;
+
+    (_this$props$makeStyle2 = (_this$props2 = this.props).makeStyles) === null || _this$props$makeStyle2 === void 0 ? void 0 : _this$props$makeStyle2.call(_this$props2);
   }
 
   get filled() {
-    const _this$props = this.props,
-          valueNow = _this$props.valueNow,
-          iconCount = _this$props.iconCount,
-          valueMax = _this$props.valueMax; // prevent divide by zero errors
+    const _this$props3 = this.props,
+          valueNow = _this$props3.valueNow,
+          iconCount = _this$props3.iconCount,
+          valueMax = _this$props3.valueMax; // prevent divide by zero errors
 
     const max = valueMax > 0 ? valueMax : iconCount;
     const filledIcons = Math.round(valueNow * iconCount / max); // Handle edge case where valueNow is greater than valueMax
@@ -62,19 +66,21 @@ let Rating = (_dec = (0, _emotion.withStyle)(_styles.default), _dec2 = (0, _test
   }
 
   render() {
-    const _this$props2 = this.props,
-          iconCount = _this$props2.iconCount,
-          animateFill = _this$props2.animateFill,
-          size = _this$props2.size,
-          margin = _this$props2.margin,
-          label = _this$props2.label,
-          formatValueText = _this$props2.formatValueText;
+    var _this$props$styles;
+
+    const _this$props4 = this.props,
+          iconCount = _this$props4.iconCount,
+          animateFill = _this$props4.animateFill,
+          size = _this$props4.size,
+          margin = _this$props4.margin,
+          label = _this$props4.label,
+          formatValueText = _this$props4.formatValueText;
     const valueText = label + ' ' + formatValueText(this.filled, iconCount);
 
     const passthroughProps = _View.View.omitViewProps((0, _omitProps.omitProps)(this.props, Rating.propTypes), Rating);
 
     return (0, _emotion.jsx)(_View.View, Object.assign({}, passthroughProps, {
-      css: this.props.styles.rating,
+      css: (_this$props$styles = this.props.styles) === null || _this$props$styles === void 0 ? void 0 : _this$props$styles.rating,
       margin: margin,
       display: "inline-block"
     }), (0, _emotion.jsx)(_ScreenReaderContent.ScreenReaderContent, null, valueText), [...Array(this.filled)].map((x, i) => (0, _emotion.jsx)(_RatingIcon.RatingIcon, {
@@ -89,60 +95,12 @@ let Rating = (_dec = (0, _emotion.withStyle)(_styles.default), _dec2 = (0, _test
     })));
   }
 
-}, _class2.displayName = "Rating", _class2.componentId = 'Rating', _class2.propTypes = {
-  /**
-   * A label is required for accessibility
-   */
-  label: _propTypes.default.string.isRequired,
-
-  /**
-   * A function that returns the current value formatted for screen readers
-   */
-  formatValueText: _propTypes.default.func,
-
-  /**
-   * Choose from a 0-3 or 0-5 rating system
-   */
-  iconCount: _propTypes.default.oneOf([3, 5]),
-
-  /**
-   * Choose from different rating icon sizes
-   */
-  size: _propTypes.default.oneOf(['small', 'medium', 'large']),
-
-  /**
-   * The maximum rating (defaults to iconCount)
-   */
-  valueMax: _propTypes.default.number,
-
-  /**
-   * The current rating
-   */
-  valueNow: _propTypes.default.number,
-
-  /**
-   * Set to make the icons animate when they become filled
-   */
-  animateFill: _propTypes.default.bool,
-
-  /**
-   * 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: _emotion.ThemeablePropTypes.spacing,
-  // eslint-disable-next-line react/require-default-props
-  makeStyles: _propTypes.default.func,
-  // eslint-disable-next-line react/require-default-props
-  styles: _propTypes.default.object
-}, _class2.defaultProps = {
+}, _class2.displayName = "Rating", _class2.componentId = 'Rating', _class2.allowedProps = _props.allowedProps, _class2.propTypes = _props.propTypes, _class2.defaultProps = {
   animateFill: false,
   formatValueText: (filled, iconCount) => `${filled} / ${iconCount}`,
   iconCount: 3,
   size: 'medium',
-  valueNow: 0,
-  margin: void 0,
-  valueMax: void 0
+  valueNow: 0
 }, _class2.Icon = _RatingIcon.RatingIcon, _temp)) || _class) || _class);
 exports.Rating = Rating;
 var _default = Rating;