Skip to main content

Rating

A star rating component for collecting and displaying user ratings and reviews.

Installation

import { Rating } from "@/core/components/Rating";

Basic Usage

import React from "react";
import { Rating } from "@/core/components/Rating";

export default function RatingExample() {
return <Rating value={4} max={5} />;
}

Props

PropTypeDefaultDescription
valuenumber-Required. Current rating value
maxnumber5Maximum rating value
size"sm" | "md" | "lg""md"Size of the rating stars
colorstring-Color of filled stars
readonlybooleanfalseWhether the rating is read-only
onRatingChange(rating: number) => void-Callback when rating changes
allowHalfbooleanfalseWhether to allow half-star ratings
styleStyleProp<ViewStyle>-Additional styles

Usage Examples

Basic Rating

<Rating value={3.5} />

Interactive Rating

<Rating value={0} onRatingChange={(rating) => console.log("Rating:", rating)} />

Half Star Ratings

<Rating value={3.5} allowHalf />

Read-only Rating

<Rating value={4} readonly />