Skip to content

Commit 6dc131d

Browse files
committed
chore: format
1 parent ce6d472 commit 6dc131d

File tree

1 file changed

+24
-12
lines changed

1 file changed

+24
-12
lines changed
Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Ontrack Component review
22

33
## Team Member Name
4+
45
Shounak Bhalerao | S224743249
56

67
## Component Name
@@ -11,51 +12,62 @@ Shounak Bhalerao | S224743249
1112

1213
## Component purpose
1314

14-
The purpose of `grade-icon` is to provide a unified simple component, for displaying the grade student is expecting.
15-
This item, can only be seen on screens with Tutor or higher permissions.
15+
The purpose of `grade-icon` is to provide a unified simple component, for displaying the grade
16+
student is expecting. This item, can only be seen on screens with Tutor or higher permissions.
1617

1718
## Component outcomes and interactions
18-
Users can hover over this icon to get what grade student is targeting.
19-
It's a Visual component with no interactivity or subcomponents.
19+
20+
Users can hover over this icon to get what grade student is targeting. It's a Visual component with
21+
no interactivity or subcomponents.
2022

2123
## Interaction with other components
24+
2225
### Input
26+
2327
Any Component which wants to invoke this components need the following inputs
28+
2429
```typescript
2530
@Input grade: string; // project.targetGrade
2631
```
2732

2833
### Current Usages
29-
I noticed that this component was used in `student-list` model.
30-
In order to view this model we need to log in using the following credentials.
34+
35+
I noticed that this component was used in `student-list` model. In order to view this model we need
36+
to log in using the following credentials.
37+
3138
> username: atutor
3239
3340
> password: password
3441
3542
![grade-icon-usage](Resources/grade-icon-usage.png)
3643

3744
## Component Migration Plan
38-
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.
39-
I will be using the following as reference: [comments-modal](comments-modal.md)
45+
46+
will be following doubtfire-web's Migration Guide and refer to existing components already migrated
47+
to TypeScript to ensure my code follows the same code style & conventions. I will be using the
48+
following as reference: [comments-modal](comments-modal.md)
4049

4150
### Original (Image):
51+
4252
![grade-icon](Resources/grade-icon.png)
4353

4454
### Post-Migration (Image)
55+
4556
![migrated-grade-icon](Resources/migrated-grade-icon.png)
4657

4758
### Original (Hover)
59+
4860
![grade-icon-hover](Resources/grade-icon-hover.png)
4961

5062
### Post-Migration (Hover)
63+
5164
![migrated-grade-icon-hover](Resources/migrated-grade-icon-hover.png)
5265

53-
> Note:
54-
> There is a small change in the way the hover block looks
55-
> since previously we were using Bootstrap, and now we shifted to
56-
> Angular Material.
66+
> Note: There is a small change in the way the hover block looks since previously we were using
67+
> Bootstrap, and now we shifted to Angular Material.
5768
5869
## Referenes
70+
5971
- Doubtfire-web Pull Request: https://github.com/thoth-tech/doubtfire-web/pull/258
6072

6173
## Status of operations: PR in REVIEW

0 commit comments

Comments
 (0)