Skip to content

Commit 22bc3a4

Browse files
authored
refactor(dashboard): add JSDoc to ProfileCard component props (JhaSourav07#1243)
## Description Fixes JhaSourav07#334 ## Pillar - [ ] 🎨 Pillar 1 β€” New Theme Design - [ ] πŸ“ Pillar 2 β€” Geometric SVG Improvement - [ ] πŸ• Pillar 3 β€” Timezone Logic Optimization - [x] πŸ› οΈ Other (Bug fix, refactoring, docs, testing) ## Visual Preview No visual changes (Codebase documentation enhancement using TSDoc blocks). ## Checklist before requesting a review: - [x] I have read the `CONTRIBUTING.md` file. - [x] I have tested these changes locally. - [x] I have run the isolated file prettier formatter. - [x] My commits follow the Conventional Commits format (`refactor(dashboard): ...`). - [x] I have made sure that I have only one clean commit to merge in this PR.
2 parents 292db5e + 5942c7e commit 22bc3a4

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

β€Žcomponents/dashboard/ProfileCard.tsxβ€Ž

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,26 @@ import { motion } from 'framer-motion';
55
import { MapPin, Calendar, GitBranch, Users, UserPlus, Star, Share2 } from 'lucide-react';
66
import type { DashboardExportData, UserProfile } from '@/types/dashboard';
77
import ShareSheet from './ShareSheet';
8-
8+
/**
9+
* Properties for the ProfileCard component.
10+
*/
911
interface ProfileCardProps {
12+
/**
13+
* The GitHub user profile data containing avatar details, name, bio,
14+
* location metrics, and developer tracking score attributes.
15+
*/
1016
user: UserProfile;
17+
18+
/**
19+
* The aggregated dashboard state data compiled for image export engines.
20+
* This object is passed down to the `ShareSheet` component to render social share layouts.
21+
*/
1122
exportData: DashboardExportData;
23+
24+
/**
25+
* Optional collection of decorative text strings representing earned system awards
26+
* or user achievements shown on the profile card header segment.
27+
*/
1228
badges?: string[];
1329
}
1430

0 commit comments

Comments
Β (0)