Rating
A component for displaying and collecting star ratings.
Installation
npm install @cleartrip/ct-design-rating
# or
pnpm add @cleartrip/ct-design-rating
Peer dependencies
# Required for all targets
npm install react
# Web only
npm install react-dom
# React Native only
npm install react-native
Usage
Basic
import { Rating } from '@cleartrip/ct-design-rating';
function Example() {
return (
<Rating>
{/* Basic usage */}
</Rating>
);
}
Props
| Prop | Type | Default | Required | Description |
|---|---|---|---|---|
rating | number | — | Yes | rating property |
maxRating | number | — | No | maxRating property |
size | RatingSizeType | — | No | size property |
activeColor | string | — | No | activeColor property |
inActiveColor | string | — | No | inActiveColor property |
styleConfig | { | — | No | styleConfig property |
root | Styles[] | — | No | root property |
ratingContainer | Styles[] | — | No | ratingContainer property |
RatingSize
XS— xsSM— smMD— mdLG— lgXL— xlXXL— xxl
Accessibility
- The component follows accessibility best practices
- Ensure proper ARIA attributes are provided where needed
- Test with screen readers to ensure usability
Migration
If migrating from a previous version:
- import { Rating } from 'yagami/core/components';
+ import { Rating } from '@cleartrip/ct-design-rating';