Rating

A star rating you can choose with a mouse, touch or arrow keys.

Usage

tsx

"use client";

import { useState } from "react";
import { Rating } from "mizu-ui";

export function Example() {
  const [value, setValue] = useState(3);
  return (
    <Rating
      label="How useful was this?"
      value={value}
      onValueChange={setValue}
    />
  );
}

It starts with "use client" because it keeps state or passes functions to components, so it pastes into a Next.js page as it is. Other React setups ignore the directive.

Source & setup

Add this component to your project with the shadcn CLI. The command copies its source into your configured UI directory, with base.css, Mizu’s tokens, and the stylesheets that hold its rules. Each rule lives in one stylesheet, so components you add together never repeat CSS. In a project without a components.json, run npx shadcn@latest init 0xuser64bit/mizu/preset first: plain init installs shadcn’s theme into your global CSS. Then load the fonts.

npx shadcn@latest add 0xuser64bit/mizu/rating

Every component imports from its own path, its name in kebab case. Its source, forms/Selection.tsx, also holds RadioGroup, SegmentedControl, NumberField and ColorPicker. Each has its own command and path; adding one after this copies only its small entry file. To paste the example, replace its mizu-ui import with:

tsx

import { Rating } from "@/components/ui/mizu/rating";

For npm imports, import mizu-ui/styles.css once. Fonts are optional via mizu-ui/fonts.css. Override --mizu-* tokens or use className for local styling. Uses native React and CSS; install the package peers for root imports. A Client Component: its source starts with “use client”.

Inspect forms/Selection.tsx

Source is included in the npm package under src/forms/Selection.tsx.

Open full source ↗

Props

Prop	Type	Default	Description
value / onValueChange	number / function	—	Controlled selected score.
max	number	5	One to ten stars.

Accessibility

Native radio choices announce each score and support arrow keys. Decoration is hidden from readers.

Motion

CSS transitions explain state changes. Reduced motion removes travel.

Works alongside

DateRangeField OneTimeCode FormField TextField