[CircularProgress] Backport simplified determinate style & deprecate …

…static (#22094) Co-authored-by: Marija Najdova <mnajdova@gmail.com> Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>
mui · Aug 13, 2020 · 70aaac4 · 70aaac4
1 parent 1d351a8
commit 70aaac4
Show file tree

Hide file tree

Showing 9 changed files with 76 additions and 48 deletions.
diff --git a/docs/pages/api-docs/circular-progress.md b/docs/pages/api-docs/circular-progress.md
@@ -37,7 +37,7 @@ The `MuiCircularProgress` name can be used for providing [default props](/custom
 | <span class="prop-name">disableShrink</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | If `true`, the shrink animation is disabled. This only works if variant is `indeterminate`. |
 | <span class="prop-name">size</span> | <span class="prop-type">number<br>&#124;&nbsp;string</span> | <span class="prop-default">40</span> | The size of the circle. If using a number, the pixel unit is assumed. If using a string, you need to provide the CSS unit, e.g '3rem'. |
 | <span class="prop-name">thickness</span> | <span class="prop-type">number</span> | <span class="prop-default">3.6</span> | The thickness of the circle. |
-| <span class="prop-name">value</span> | <span class="prop-type">number</span> | <span class="prop-default">0</span> | The value of the progress indicator for the determinate and static variants. Value between 0 and 100. |
+| <span class="prop-name">value</span> | <span class="prop-type">number</span> | <span class="prop-default">0</span> | The value of the progress indicator for the determinate variant. Value between 0 and 100. |
 | <span class="prop-name">variant</span> | <span class="prop-type">'determinate'<br>&#124;&nbsp;'indeterminate'<br>&#124;&nbsp;'static'</span> | <span class="prop-default">'indeterminate'</span> | The variant to use. Use indeterminate when there is no progress value. |
 
 The `ref` is forwarded to the root element.
@@ -51,12 +51,14 @@ Any other props supplied will be provided to the root element (native element).
 | <span class="prop-name">root</span> | <span class="prop-name">.MuiCircularProgress-root</span> | Styles applied to the root element.
 | <span class="prop-name">static</span> | <span class="prop-name">.MuiCircularProgress-static</span> | Styles applied to the root element if `variant="static"`.
 | <span class="prop-name">indeterminate</span> | <span class="prop-name">.MuiCircularProgress-indeterminate</span> | Styles applied to the root element if `variant="indeterminate"`.
+| <span class="prop-name">determinate</span> | <span class="prop-name">.MuiCircularProgress-determinate</span> | Styles applied to the root element if `variant="determinate"`.
 | <span class="prop-name">colorPrimary</span> | <span class="prop-name">.MuiCircularProgress-colorPrimary</span> | Styles applied to the root element if `color="primary"`.
 | <span class="prop-name">colorSecondary</span> | <span class="prop-name">.MuiCircularProgress-colorSecondary</span> | Styles applied to the root element if `color="secondary"`.
 | <span class="prop-name">svg</span> | <span class="prop-name">.MuiCircularProgress-svg</span> | Styles applied to the `svg` element.
 | <span class="prop-name">circle</span> | <span class="prop-name">.MuiCircularProgress-circle</span> | Styles applied to the `circle` svg path.
 | <span class="prop-name">circleStatic</span> | <span class="prop-name">.MuiCircularProgress-circleStatic</span> | Styles applied to the `circle` svg path if `variant="static"`.
 | <span class="prop-name">circleIndeterminate</span> | <span class="prop-name">.MuiCircularProgress-circleIndeterminate</span> | Styles applied to the `circle` svg path if `variant="indeterminate"`.
+| <span class="prop-name">circleDeterminate</span> | <span class="prop-name">.MuiCircularProgress-circleDeterminate</span> | Styles applied to the `circle` svg path if `variant="determinate"`.
 | <span class="prop-name">circleDisableShrink</span> | <span class="prop-name">.MuiCircularProgress-circleDisableShrink</span> | Styles applied to the `circle` svg path if `disableShrink={true}`.
 
 You can override the style of the component thanks to one of these customization points:

diff --git a/...ges/components/progress/CircularStatic.js → ...omponents/progress/CircularDeterminate.js b/...ges/components/progress/CircularStatic.js → ...omponents/progress/CircularDeterminate.js
@@ -11,7 +11,7 @@ const useStyles = makeStyles((theme) => ({
   },
 }));
 
-export default function CircularStatic() {
+export default function CircularDeterminate() {
   const classes = useStyles();
   const [progress, setProgress] = React.useState(0);
 
@@ -27,11 +27,11 @@ export default function CircularStatic() {
 
   return (
     <div className={classes.root}>
-      <CircularProgress variant="static" value={25} />
-      <CircularProgress variant="static" value={50} />
-      <CircularProgress variant="static" value={75} />
-      <CircularProgress variant="static" value={100} />
-      <CircularProgress variant="static" value={progress} />
+      <CircularProgress variant="determinate" value={25} />
+      <CircularProgress variant="determinate" value={50} />
+      <CircularProgress variant="determinate" value={75} />
+      <CircularProgress variant="determinate" value={100} />
+      <CircularProgress variant="determinate" value={progress} />
     </div>
   );
 }
diff --git a/...es/components/progress/CircularStatic.tsx → ...mponents/progress/CircularDeterminate.tsx b/...es/components/progress/CircularStatic.tsx → ...mponents/progress/CircularDeterminate.tsx
@@ -13,7 +13,7 @@ const useStyles = makeStyles((theme: Theme) =>
   }),
 );
 
-export default function CircularStatic() {
+export default function CircularDeterminate() {
   const classes = useStyles();
   const [progress, setProgress] = React.useState(0);
 
@@ -29,11 +29,11 @@ export default function CircularStatic() {
 
   return (
     <div className={classes.root}>
-      <CircularProgress variant="static" value={25} />
-      <CircularProgress variant="static" value={50} />
-      <CircularProgress variant="static" value={75} />
-      <CircularProgress variant="static" value={100} />
-      <CircularProgress variant="static" value={progress} />
+      <CircularProgress variant="determinate" value={25} />
+      <CircularProgress variant="determinate" value={50} />
+      <CircularProgress variant="determinate" value={75} />
+      <CircularProgress variant="determinate" value={100} />
+      <CircularProgress variant="determinate" value={progress} />
     </div>
   );
 }
diff --git a/docs/src/pages/components/progress/CircularWithValueLabel.js b/docs/src/pages/components/progress/CircularWithValueLabel.js
@@ -7,7 +7,7 @@ import Box from '@material-ui/core/Box';
 function CircularProgressWithLabel(props) {
   return (
     <Box position="relative" display="inline-flex">
-      <CircularProgress variant="static" {...props} />
+      <CircularProgress variant="determinate" {...props} />
       <Box
         top={0}
         left={0}
@@ -28,7 +28,7 @@ function CircularProgressWithLabel(props) {
 
 CircularProgressWithLabel.propTypes = {
   /**
-   * The value of the progress indicator for the determinate and static variants.
+   * The value of the progress indicator for the determinate variant.
    * Value between 0 and 100.
    */
   value: PropTypes.number.isRequired,
@@ -39,7 +39,7 @@ export default function CircularStatic() {
 
   React.useEffect(() => {
     const timer = setInterval(() => {
-      setProgress((prevProgress) => (prevProgress >= 100 ? 10 : prevProgress + 10));
+      setProgress((prevProgress) => (prevProgress >= 100 ? 0 : prevProgress + 10));
     }, 800);
     return () => {
       clearInterval(timer);

diff --git a/docs/src/pages/components/progress/CircularWithValueLabel.tsx b/docs/src/pages/components/progress/CircularWithValueLabel.tsx
@@ -6,7 +6,7 @@ import Box from '@material-ui/core/Box';
 function CircularProgressWithLabel(props: CircularProgressProps & { value: number }) {
   return (
     <Box position="relative" display="inline-flex">
-      <CircularProgress variant="static" {...props} />
+      <CircularProgress variant="determinate" {...props} />
       <Box
         top={0}
         left={0}
@@ -30,7 +30,7 @@ export default function CircularStatic() {
 
   React.useEffect(() => {
     const timer = setInterval(() => {
-      setProgress((prevProgress) => (prevProgress >= 100 ? 10 : prevProgress + 10));
+      setProgress((prevProgress) => (prevProgress >= 100 ? 0 : prevProgress + 10));
     }, 800);
     return () => {
       clearInterval(timer);

diff --git a/docs/src/pages/components/progress/progress.md b/docs/src/pages/components/progress/progress.md
@@ -22,7 +22,7 @@ When displaying progress for a sequence of processes, indicate overall progress
 
 ### Circular determinate
 
-{{"demo": "pages/components/progress/CircularStatic.js"}}
+{{"demo": "pages/components/progress/CircularDeterminate.js"}}
 
 ### Interactive integration
 

diff --git a/packages/material-ui/src/CircularProgress/CircularProgress.d.ts b/packages/material-ui/src/CircularProgress/CircularProgress.d.ts
@@ -27,7 +27,7 @@ export interface CircularProgressProps
    */
   thickness?: number;
   /**
-   * The value of the progress indicator for the determinate and static variants.
+   * The value of the progress indicator for the determinate variant.
    * Value between 0 and 100.
    */
   value?: number;
@@ -41,12 +41,14 @@ export interface CircularProgressProps
 export type CircularProgressClassKey =
   | 'root'
   | 'static'
+  | 'determinate'
   | 'indeterminate'
   | 'colorPrimary'
   | 'colorSecondary'
   | 'svg'
   | 'circle'
   | 'circleStatic'
+  | 'circleDeterminate'
   | 'circleIndeterminate'
   | 'circleDisableShrink';
 

diff --git a/packages/material-ui/src/CircularProgress/CircularProgress.js b/packages/material-ui/src/CircularProgress/CircularProgress.js
@@ -7,21 +7,6 @@ import capitalize from '../utils/capitalize';
 
 const SIZE = 44;
 
-function getRelativeValue(value, min, max) {
-  return (Math.min(Math.max(min, value), max) - min) / (max - min);
-}
-
-function easeOut(t) {
-  t = getRelativeValue(t, 0, 1);
-  // https://gist.github.com/gre/1650294
-  t = (t -= 1) * t * t + 1;
-  return t;
-}
-
-function easeIn(t) {
-  return t * t;
-}
-
 export const styles = (theme) => ({
   /* Styles applied to the root element. */
   root: {
@@ -35,6 +20,10 @@ export const styles = (theme) => ({
   indeterminate: {
     animation: '$circular-rotate 1.4s linear infinite',
   },
+  /* Styles applied to the root element if `variant="determinate"`. */
+  determinate: {
+    transition: theme.transitions.create('transform'),
+  },
   /* Styles applied to the root element if `color="primary"`. */
   colorPrimary: {
     color: theme.palette.primary.main,
@@ -64,6 +53,10 @@ export const styles = (theme) => ({
     strokeDasharray: '80px, 200px',
     strokeDashoffset: '0px', // Add the unit to fix a Edge 16 and below bug.
   },
+  /* Styles applied to the `circle` svg path if `variant="determinate"`. */
+  circleDeterminate: {
+    transition: theme.transitions.create('stroke-dashoffset'),
+  },
   '@keyframes circular-rotate': {
     '0%': {
       // Fix IE 11 wobbly
@@ -122,16 +115,8 @@ const CircularProgress = React.forwardRef(function CircularProgress(props, ref)
     const circumference = 2 * Math.PI * ((SIZE - thickness) / 2);
     circleStyle.strokeDasharray = circumference.toFixed(3);
     rootProps['aria-valuenow'] = Math.round(value);
-
-    if (variant === 'static') {
-      circleStyle.strokeDashoffset = `${(((100 - value) / 100) * circumference).toFixed(3)}px`;
-      rootStyle.transform = 'rotate(-90deg)';
-    } else {
-      circleStyle.strokeDashoffset = `${(easeIn((100 - value) / 100) * circumference).toFixed(
-        3,
-      )}px`;
-      rootStyle.transform = `rotate(${(easeOut(value / 70) * 270).toFixed(3)}deg)`;
-    }
+    circleStyle.strokeDashoffset = `${(((100 - value) / 100) * circumference).toFixed(3)}px`;
+    rootStyle.transform = 'rotate(-90deg)';
   }
 
   return (
@@ -140,6 +125,7 @@ const CircularProgress = React.forwardRef(function CircularProgress(props, ref)
         classes.root,
         {
           [classes[`color${capitalize(color)}`]]: color !== 'inherit',
+          [classes.determinate]: variant === 'determinate',
           [classes.indeterminate]: variant === 'indeterminate',
           [classes.static]: variant === 'static',
         },
@@ -154,6 +140,7 @@ const CircularProgress = React.forwardRef(function CircularProgress(props, ref)
       <svg className={classes.svg} viewBox={`${SIZE / 2} ${SIZE / 2} ${SIZE} ${SIZE}`}>
         <circle
           className={clsx(classes.circle, {
+            [classes.circleDeterminate]: variant === 'determinate',
             [classes.circleIndeterminate]: variant === 'indeterminate',
             [classes.circleStatic]: variant === 'static',
             [classes.circleDisableShrink]: disableShrink,
@@ -217,15 +204,25 @@ CircularProgress.propTypes = {
    */
   thickness: PropTypes.number,
   /**
-   * The value of the progress indicator for the determinate and static variants.
+   * The value of the progress indicator for the determinate variant.
    * Value between 0 and 100.
    */
   value: PropTypes.number,
   /**
    * The variant to use.
    * Use indeterminate when there is no progress value.
    */
-  variant: PropTypes.oneOf(['determinate', 'indeterminate', 'static']),
+  variant: chainPropTypes(PropTypes.oneOf(['determinate', 'indeterminate', 'static']), (props) => {
+    const { variant } = props;
+
+    if (variant === 'static') {
+      throw new Error(
+        'Material-UI: `variant="static"` was deprecated. Use `variant="determinate"` instead.',
+      );
+    }
+
+    return null;
+  }),
 };
 
 export default withStyles(styles, { name: 'MuiCircularProgress', flip: false })(CircularProgress);
diff --git a/packages/material-ui/src/CircularProgress/CircularProgress.test.js b/packages/material-ui/src/CircularProgress/CircularProgress.test.js
@@ -1,5 +1,7 @@
 import * as React from 'react';
+import * as PropTypes from 'prop-types';
 import { expect } from 'chai';
+import { stub } from 'sinon';
 import { createClientRender } from 'test/utils/createClientRender';
 import { getClasses } from '@material-ui/core/test-utils';
 import createMount from 'test/utils/createMount';
@@ -77,6 +79,15 @@ describe('<CircularProgress />', () => {
   });
 
   describe('prop: variant="static', () => {
+    beforeEach(() => {
+      PropTypes.resetWarningCache();
+      stub(console, 'error');
+    });
+
+    afterEach(() => {
+      console.error.restore();
+    });
+
     it('should set strokeDasharray of circle', () => {
       const { container } = render(<CircularProgress variant="static" value={70} />);
       const circularProgress = container.firstChild;
@@ -93,6 +104,22 @@ describe('<CircularProgress />', () => {
       );
       expect(circularProgress).to.have.attribute('aria-valuenow', '70');
     });
+
+    it('issues a warning for variant="static"', () => {
+      PropTypes.checkPropTypes(
+        CircularProgress.Naked.propTypes,
+        {
+          variant: 'static',
+        },
+        'props',
+        'Avatar',
+      );
+
+      expect(console.error.callCount).to.equal(1);
+      expect(console.error.firstCall.args[0]).to.equal(
+        'Warning: Failed props type: Material-UI: `variant="static"` was deprecated. Use `variant="determinate"` instead.',
+      );
+    });
   });
 
   describe('prop: variant="determinate"', () => {
@@ -119,7 +146,7 @@ describe('<CircularProgress />', () => {
         'should have strokeDasharray set',
       );
       expect(circle.style.strokeDashoffset).to.equal(
-        '11.423px',
+        '38.076px',
         'should have strokeDashoffset set',
       );
       expect(circularProgress).to.have.attribute('aria-valuenow', '70');