Skip to content

Add documentation for ReviewHeader.tsx #405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ggsawatyanon wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add documentation for ReviewHeader.tsx #405

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions frontend/src/components/Review/ReviewHeader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,18 @@ type Props = {
readonly aveRatingInfo: RatingInfo[];
};

/**
* ReviewHeader – Displays the visualization for the ratings of different review categories.
*
* @remarks
* This component is used to present the ratings for reviews and pages for different categories
* such as Communication and Location etc.
*
* @param {RatingInfo[]} props.aveRatingInfo – An array of average rating data where each contains
* the category name (`feature`) and its rating (`rating`).
*
* @return {ReactElement} – The responsive layout displaying the labeled rating bars for each category.
*/
export default function ReviewHeader({ aveRatingInfo }: Props): ReactElement {
const [isMobile, setIsMobile] = useState<boolean>(false);

Expand Down
Loading