Add jsdoc

WordPress · May 24, 2024 · b096ca4 · b096ca4
1 parent 1d22f24
commit b096ca4
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/packages/components/src/progress-bar/index.tsx b/packages/components/src/progress-bar/index.tsx
@@ -44,6 +44,18 @@ function UnforwardedProgressBar(
 	);
 }
 
+/* A simple horizontal progress bar component.
+ *
+ * Supports two modes: determinate and indeterminate. A progress bar is determinate when a specific progress value has been specified (from 0 to 100), and indeterminate when a value hasn't been specified.
+ *
+ * ```jsx
+ * import { ProgressBar } from '@wordpress/components';
+ *
+ * const MyLoadingComponent = () => {
+ *  return <ProgressBar />
+ * }
+ * ```
+ */
 export const ProgressBar = forwardRef( UnforwardedProgressBar );
 
 export default ProgressBar;