refactor(typescript): Add Typescript types to ProgressBar

.all-contributorsrc

@@ -1388,6 +1388,15 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "mattborghi",
+      "name": "Matias Borghi",
+      "avatar_url": "https://avatars.githubusercontent.com/u/11933424?v=4",
+      "profile": "https://mattborghi.github.io/",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "commitConvention": "none"

README.md

@@ -271,6 +271,7 @@ check out our [Contributing Guide](/.github/CONTRIBUTING.md) and our
     <td align="center"><a href="https://samuelechinellato.com/#/"><img src="https://avatars.githubusercontent.com/u/49278203?v=4?s=100" width="100px;" alt=""/><br /><sub><b>SamChinellato</b></sub></a><br /><a href="https://github.com/carbon-design-system/carbon/commits?author=SamChinellato" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/stevenpatrick009"><img src="https://avatars.githubusercontent.com/u/106097350?v=4?s=100" width="100px;" alt=""/><br /><sub><b>stevenpatrick009</b></sub></a><br /><a href="https://github.com/carbon-design-system/carbon/commits?author=stevenpatrick009" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/xalc"><img src="https://avatars.githubusercontent.com/u/18441947?v=4?s=100" width="100px;" alt=""/><br /><sub><b>HunterXalc</b></sub></a><br /><a href="https://github.com/carbon-design-system/carbon/commits?author=xalc" title="Code">💻</a></td>
+    <td align="center"><a href="https://mattborghi.github.io/"><img src="https://avatars.githubusercontent.com/u/11933424?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Matias Borghi</b></sub></a><br /><a href="https://github.com/carbon-design-system/carbon/commits?author=mattborghi" title="Code">💻</a></td>
   </tr>
 </table>
 

packages/react/src/components/ProgressBar/ProgressBar.js → packages/react/src/components/ProgressBar/ProgressBar.tsx

@@ -5,14 +5,61 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import React, { useRef } from 'react';
+import React, { ReactSVGElement, useRef } from 'react';
 import PropTypes from 'prop-types';
 import classNames from 'classnames';
 import { CheckmarkFilled, ErrorFilled } from '@carbon/icons-react';
 import { useId } from '../../internal/useId';
 import { usePrefix } from '../../internal/usePrefix';
 import useIsomorphicEffect from '../../internal/useIsomorphicEffect';
 
+interface ProgressBarProps {
+  /**
+   * Additional CSS class names.
+   */
+  className?: string;
+
+  /**
+   * The current progress as a textual representation.
+   */
+  helperText?: string;
+
+  /**
+   * Whether the label should be visually hidden.
+   */
+  hideLabel?: boolean;
+
+  /**
+   * A label describing the progress bar.
+   */
+  label: string;
+
+  /**
+   * The maximum value.
+   */
+  max?: number;
+
+  /**
+   * Specify the size of the ProgressBar.
+   */
+  size?: 'small' | 'big';
+
+  /**
+   * Specify the status.
+   */
+  status?: 'active' | 'finished' | 'error';
+
+  /**
+   * Defines the alignment variant of the progress bar.
+   */
+  type?: 'default' | 'inline' | 'indented';
+
+  /**
+   * The current value.
+   */
+  value?: number;
+}
+
 function ProgressBar({
   className,
   helperText,
@@ -23,7 +70,7 @@ function ProgressBar({
   status = 'active',
   type = 'default',
   value,
-}) {
+}: ProgressBarProps) {
   const labelId = useId('progress-bar');
   const helperId = useId('progress-bar-helper');
   const helperTextId = useId('progress-bar-helper-text');
@@ -36,10 +83,10 @@ function ProgressBar({
     !isFinished && !isError && (value === null || value === undefined);
 
   let cappedValue = value;
-  if (cappedValue > max) {
+  if (cappedValue && cappedValue > max) {
     cappedValue = max;
   }
-  if (cappedValue < 0) {
+  if (cappedValue && cappedValue < 0) {
     cappedValue = 0;
   }
   if (isError) {
@@ -48,7 +95,7 @@ function ProgressBar({
     cappedValue = max;
   }
 
-  const percentage = cappedValue / max;
+  const percentage = (cappedValue ?? NaN) / max;
 
   const wrapperClasses = classNames(
     `${prefix}--progress-bar`,
@@ -66,24 +113,34 @@ function ProgressBar({
     [`${prefix}--visually-hidden`]: hideLabel,
   });
 
-  let StatusIcon = null;
+  let StatusIcon: React.ForwardRefExoticComponent<
+    React.RefAttributes<ReactSVGElement> & { className?: string }
+  > | null = null;
 
   if (isError) {
-    StatusIcon = React.forwardRef(function ErrorFilled16(props, ref) {
+    StatusIcon = React.forwardRef(function ErrorFilled16(
+      props,
+      ref: React.Ref<ReactSVGElement>
+    ) {
       return <ErrorFilled ref={ref} size={16} {...props} />;
     });
   } else if (isFinished) {
-    StatusIcon = React.forwardRef(function CheckmarkFilled16(props, ref) {
+    StatusIcon = React.forwardRef(function CheckmarkFilled16(
+      props,
+      ref: React.Ref<ReactSVGElement>
+    ) {
       return <CheckmarkFilled ref={ref} size={16} {...props} />;
     });
   }
 
-  const ref = useRef();
+  const ref = useRef<HTMLDivElement>(null);
   useIsomorphicEffect(() => {
-    if (!isFinished && !isError) {
-      ref.current.style.transform = `scaleX(${percentage})`;
-    } else {
-      ref.current.style.transform = null;
+    if (ref.current) {
+      if (!isFinished && !isError) {
+        ref.current.style.transform = `scaleX(${percentage})`;
+      } else {
+        ref.current.style.transform = '';
+      }
     }
   }, [percentage, isFinished, isError]);
 
@@ -103,9 +160,9 @@ function ProgressBar({
         aria-invalid={isError}
         aria-labelledby={labelId}
         aria-describedby={helperText ? helperTextId : undefined}
-        aria-valuemin={!indeterminate ? 0 : null}
-        aria-valuemax={!indeterminate ? max : null}
-        aria-valuenow={!indeterminate ? cappedValue : null}>
+        aria-valuemin={!indeterminate ? 0 : undefined}
+        aria-valuemax={!indeterminate ? max : undefined}
+        aria-valuenow={!indeterminate ? cappedValue : undefined}>
         <div className={`${prefix}--progress-bar__bar`} ref={ref} />
       </div>
       {helperText && (