Skip to main content

Rating

Rating is a React Native star rating: tap a star, or drag across the row and let go. Use it to ask for a review, or with readOnly to show a score such as 4.3.

The stars are a ★ character, so there is no SVG or image to install; pass renderIcon for hearts, thumbs or your own icon. On the web the pointer previews the rating a click would pick.

import { Rating } from 'patine-ui';
Loading…
<View style={{ gap: 8, alignItems: 'center' }}>
  <Rating value={stars} onValueChange={setStars} accessibilityLabel="Rate your stay" />
  <Text>{stars ? `${stars} of 5` : 'Tap a star'}</Text>
</View>

Try the props​

Props
step
max
<Rating value={stars} onValueChange={setStars} />

Example: rate a delivery​

A food app's post-delivery screen: the stars come first, then the follow-up question depends on the score, so a low rating asks what went wrong and a high one asks what was good.

Loading…
<Box border radius="lg" padding="lg" gap="md" style={{ width: '100%', maxWidth: 400 }}>
  <VStack gap="xs" align="center">
    <Text weight="semibold">How was your order from Pho Saigon?</Text>
    <Rating
      value={stars}
      onValueChange={(v) => {
        setStars(v);
        setReason(null);
      }}
      size={36}
      accessibilityLabel="Rate your order"
    />
    <Text color="textSecondary">{stars ? WORDS[stars] : 'Tap a star'}</Text>
  </VStack>
  {stars ? (
    <VStack gap="sm">
      <Text weight="medium">{stars >= 4 ? 'What was good?' : 'What went wrong?'}</Text>
      <ChipGroup items={reasons.map((r) => ({ label: r, value: r }))} value={reason} onValueChange={setReason} accessibilityLabel="Reason" />
    </VStack>
  ) : null}
  <Button disabled={!stars} onPress={() => setSent(true)}>
    Send rating
  </Button>
</Box>

Half stars​

step={0.5} picks half stars: the left half of a star gives .5, the right half the whole star. A drag shows the value as it moves and calls onValueChange once, when the finger lifts.

Loading…
<Rating step={0.5} value={stars} onValueChange={setStars} style={{ alignSelf: 'center' }} />

Showing a score​

readOnly shows any value, filling part of a star for a fraction, and takes no touches. Screen readers hear Rating, 4.3 of 5.

Loading…
<View style={{ flexDirection: 'row', alignItems: 'center', justifyContent: 'center', gap: 8 }}>
  <Rating value={4.3} readOnly size={20} accessibilityLabel="Average rating" />
  <Text>4.3 · 1,284 reviews</Text>
</View>

Your own icon​

renderIcon draws each icon twice, empty and filled, and the filled one is cut to the rating, so half steps and fractions work with any icon. It gets { index, filled, color, size }.

Loading…
<Rating
  defaultValue={3}
  color="#E0245E"
  style={{ alignSelf: 'center' }}
  renderIcon={({ color, size }) => <Text style={{ color, fontSize: size, lineHeight: size }}>♥</Text>}
/>

Colour your icon with the color it receives: the filled stars get color (gold by default) and the empty ones emptyColor (the theme's border colour).

Accessibility​

The row is one adjustable control, as a slider is: swipe up or down with VoiceOver or TalkBack to change the rating by a step. On the web, arrow keys step it, and Home and End go to 0 and to max. With readOnly, it's text: the label and the score.

Props​

PropTypeDefaultDescription
valuenumber—The rating (controlled).
defaultValuenumber0Starting rating when value isn't set.
onValueChange(value: number) => void—On a tap, when a drag ends on a new value, or on a key or screen-reader step.
maxnumber5How many stars.
stepnumber1The value moves in steps this big: 0.5 for half stars.
readOnlybooleanfalseShows the value, any fraction, and takes no touches or keys.
disabledbooleanfalseDims the stars and ignores touches and keys.
sizenumber32Each star's width and height.
colorstringgold, #FFB400The filled stars.
emptyColorstringtheme borderThe empty stars.
renderIcon(info: RatingIconInfo) => ReactNode★Your own icon, drawn empty and filled.
formatValue(value: number, max: number) => string'3 of 5'The value as screen readers hear it.
accessibilityLabelstring'Rating'What screen readers call the rating.
theme / designSee Theming and Designs.
styleStyleProp<ViewStyle>—The row. It stretches with its parent like any View, the stars at its start; taps after the last star do nothing. Centre it with alignSelf: 'center'.
styles{ container, item, icon }—Slot styles: the row, each star's box, and the ★ text.
testIDstring—On the row; star i gets ${testID}-star-${i}.

Types​

interface RatingIconInfo {
index: number; // 0 for the first star
filled: boolean;
color: string; // color or emptyColor
size: number;
}