Northeastern-Electric-Racing / Northeastern-Electric-Racing/FinishLine
[Bay Dashboard] - Create List of Available Widgets
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 36
- Forks
- 9
- Avg merge
- 4d 21h
- Merged PRs (30d)
- 11
Description
Description
On the frontend we want to create a list of every dashboard widget that exists and what sizes it can exist as. For example, the calendar widget could exist as a large widget or as a medium widget
In the future both the bay dashboard and the admin tools widget previews will read from this list
Acceptance Criteria
src/frontend/src/utils/bayDashboard.utils.tsx
- list of widgets
- getWidgetsForSize function that takes in a size and returns the widgets that can be that size
- getWidget function that takes in a widget type and returns that widget, or undefined
Proposed Solution
Create a const BAY_DASHBOARD_WIDGETS that is an array of all existing widgets
Create a widget interface with type, displayName, sizes, and the React component itself
{
type: BayDashboardWidgetType.CALENDAR,
displayName: 'Calendar',
sizes: [BayDashboardSlot.LARGE, BayDashboardSlot.MEDIUM],
component: CalendarWidget
}
Widgets to include
- CALENDAR
- OVERDUE_WORK_PACKAGES
- TEXT_FIELD
- COUNTDOWN
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in src/frontend/src/utils/bayDashboard.utils.tsx and inspect the existing dashboard widget types, sizes, and components referenced by the issue. Define the widget list for CALENDAR, OVERDUE_WORK_PACKAGES, TEXT_FIELD, and COUNTDOWN, then verify that getWidgetsForSize filters by size and getWidget returns the matching widget or undefined.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 85/100