Rating

Usage

import { Rating } from "@devvy-ui/react";

<Rating label="Your rating" name="rating" max={5} />

API reference

Native HTML attributes, className, style and a forwarded ref are supported. Component-specific props:

Prop	Type	Default	Description
max	number	5	Number of choices, 1–10.
value / defaultValue	number	—	Selected rating.
onValueChange	(rating: number) => void	—	Selection callback.

Source ownership

Run npx @devvy-ui/cli init once in your React project, then add the source:

npx @devvy-ui/cli add rating

Make the source yours.

Start from the canonical implementation used by the package and registry. Change the code, keep the MIT notice, and build the behavior your project needs.

Rating.tsxREACT / TSX

import { forwardRef, type FieldsetHTMLAttributes } from 'react';
import { RadioGroup } from './RadioGroup';
export interface RatingProps
  extends Omit<FieldsetHTMLAttributes<HTMLFieldSetElement>, 'value' | 'defaultValue' | 'onChange'> {
  label: string;
  max?: number;
  value?: number;
  defaultValue?: number;
  onValueChange?: (value: number) => void;
  required?: boolean;
}
export const Rating = forwardRef<HTMLFieldSetElement, RatingProps>(function Rating(
  { label, max = 5, value, defaultValue, onValueChange, ...props },
  ref,
) {
  const count = Number.isFinite(max) ? Math.max(1, Math.min(10, Math.floor(max))) : 5;
  return (
    <RadioGroup
      {...props}
      ref={ref}
      label={label}
      className={['dvy-rating', props.className].filter(Boolean).join(' ')}
      orientation="horizontal"
      value={value === undefined ? undefined : String(value)}
      defaultValue={defaultValue === undefined ? undefined : String(defaultValue)}
      onValueChange={(v) => onValueChange?.(Number(v))}
      items={Array.from({ length: count }, (_, i) => ({
        value: String(i + 1),
        label: (
          <>
            <span aria-hidden="true">{'★'.repeat(i + 1)}</span>
            <span className="dvy-sr-only">
              {i + 1} of {count} stars
            </span>
          </>
        ),
      }))}
    />
  );
});

Edit your own copy. Downloaded source uses your changes; the component preview above uses the shipped version. Run the source installer first to include shared helpers.

Interactive preview

Usage

API reference

Accessibility & behavior

Platform Behavior & Guidelines

Source ownership

Make the source yours.