JsDoc across all project files

This commit is contained in:
Rishi Ghan
2026-04-15 11:31:52 -04:00
parent 6deab0b87e
commit 2dc38b6c95
28 changed files with 999 additions and 50 deletions

View File

@@ -1,5 +1,16 @@
/**
* @fileoverview Reusable alert card component for displaying status messages.
* Supports multiple variants (error, warning, info, success) with consistent
* styling and optional dismiss functionality.
* @module components/shared/AlertCard
*/
import { ReactElement, ReactNode } from "react";
/**
* Visual style variants for the alert card.
* @typedef {"error"|"warning"|"info"|"success"} AlertVariant
*/
export type AlertVariant = "error" | "warning" | "info" | "success";
interface AlertCardProps {

View File

@@ -1,5 +1,15 @@
/**
* @fileoverview Reusable progress bar component with percentage display.
* Supports animated shimmer effect for active states and customizable labels.
* @module components/shared/ProgressBar
*/
import { ReactElement } from "react";
/**
* Props for the ProgressBar component.
* @interface ProgressBarProps
*/
interface ProgressBarProps {
/** Current progress value */
current: number;

View File

@@ -1,5 +1,15 @@
/**
* @fileoverview Reusable stats card component for displaying numeric metrics.
* Used for dashboards and import statistics displays.
* @module components/shared/StatsCard
*/
import { ReactElement } from "react";
/**
* Props for the StatsCard component.
* @interface StatsCardProps
*/
interface StatsCardProps {
/** The main numeric value to display */
value: number;