diff --git a/docs/OnTrack/UI Enhancement/Component Reviews/Resources/grade-icon-hover.png b/docs/OnTrack/UI Enhancement/Component Reviews/Resources/grade-icon-hover.png new file mode 100644 index 000000000..22f798d5d Binary files /dev/null and b/docs/OnTrack/UI Enhancement/Component Reviews/Resources/grade-icon-hover.png differ diff --git a/docs/OnTrack/UI Enhancement/Component Reviews/Resources/grade-icon-usage.png b/docs/OnTrack/UI Enhancement/Component Reviews/Resources/grade-icon-usage.png new file mode 100644 index 000000000..2a00ca975 Binary files /dev/null and b/docs/OnTrack/UI Enhancement/Component Reviews/Resources/grade-icon-usage.png differ diff --git a/docs/OnTrack/UI Enhancement/Component Reviews/Resources/grade-icon.png b/docs/OnTrack/UI Enhancement/Component Reviews/Resources/grade-icon.png new file mode 100644 index 000000000..1b6577838 Binary files /dev/null and b/docs/OnTrack/UI Enhancement/Component Reviews/Resources/grade-icon.png differ diff --git a/docs/OnTrack/UI Enhancement/Component Reviews/Resources/migrated-grade-icon-hover.png b/docs/OnTrack/UI Enhancement/Component Reviews/Resources/migrated-grade-icon-hover.png new file mode 100644 index 000000000..8aabfc471 Binary files /dev/null and b/docs/OnTrack/UI Enhancement/Component Reviews/Resources/migrated-grade-icon-hover.png differ diff --git a/docs/OnTrack/UI Enhancement/Component Reviews/Resources/migrated-grade-icon.png b/docs/OnTrack/UI Enhancement/Component Reviews/Resources/migrated-grade-icon.png new file mode 100644 index 000000000..d9491ce8e Binary files /dev/null and b/docs/OnTrack/UI Enhancement/Component Reviews/Resources/migrated-grade-icon.png differ diff --git a/docs/OnTrack/UI Enhancement/Component Reviews/grade-icon.md b/docs/OnTrack/UI Enhancement/Component Reviews/grade-icon.md new file mode 100644 index 000000000..2d2f557cc --- /dev/null +++ b/docs/OnTrack/UI Enhancement/Component Reviews/grade-icon.md @@ -0,0 +1,61 @@ +# Ontrack Component review + +## Team Member Name +Shounak Bhalerao | S224743249 + +## Component Name + +- `grade-icon.coffee` +- `grade-icon.scss` +- `grade-icon.tpl.html` + +## Component purpose + +The purpose of `grade-icon` is to provide a unified simple component, for displaying the grade student is expecting. +This item, can only be seen on screens with Tutor or higher permissions. + +## Component outcomes and interactions +Users can hover over this icon to get what grade student is targeting. +It's a Visual component with no interactivity or subcomponents. + +## Interaction with other components +### Input +Any Component which wants to invoke this components need the following inputs +```typescript + @Input grade: string; // project.targetGrade +``` + +### Current Usages +I noticed that this component was used in `student-list` model. +In order to view this model we need to log in using the following credentials. +> username: atutor + +> password: password + +![grade-icon-usage](Resources/grade-icon-usage.png) + +## Component Migration Plan +will be following doubtfire-web's Migration Guide and refer to existing components already migrated to TypeScript to ensure my code follows the same code style & conventions. +I will be using the following as reference: [comments-modal](comments-modal.md) + +### Original (Image): +![grade-icon](Resources/grade-icon.png) + +### Post-Migration (Image) +![migrated-grade-icon](Resources/migrated-grade-icon.png) + +### Original (Hover) +![grade-icon-hover](Resources/grade-icon-hover.png) + +### Post-Migration (Hover) +![migrated-grade-icon-hover](Resources/migrated-grade-icon-hover.png) + +> Note: +> There is a small change in the way the hover block looks +> since previously we were using Bootstrap, and now we shifted to +> Angular Material. + +## Referenes +- Doubtfire-web Pull Request: https://github.com/thoth-tech/doubtfire-web/pull/258 + +## Status of operations: PR in REVIEW