How do I install Rating?

Rating is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/rating. It copies rating.tsx into components/ui and installs motion, clsx, tailwind-merge.

Is Rating free for commercial use?

Rating needs a Charcoal UI Pro seat, monthly or a one-time lifetime price. A seat covers unlimited personal and commercial projects, including client work, and every future Pro component.

Does Rating work with Next.js?

Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.

Can an AI coding agent install Rating?

Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Rating's props and get_install_command returns the exact command.

Rating

Star rating with a hover preview. Picking a score pops the stars in a ripple from the left.

Category: Inputs
Licence: Charcoal UI Pro
Built with: React 19, Tailwind CSS 4, Motion
Dependencies: motion, clsx, tailwind-merge

Examples

Rating

API reference

Prop	Type	Default
`value / defaultValue`	`number`	—
`onValueChange`	`(value: number) => void`	—
`max`	`number`	`5`
`size`	`number`	`28`
`readOnly`	`boolean`	`false`

About Rating

Rating is a star input that previews the score as you hover and, when you pick, pops the stars in a quick ripple from the left. It also works read-only for showing average scores on cards and reviews.

Rating is an input component for React 19, styled with Tailwind CSS 4 and animated with Motion. It drops into Next.js, Vite, Remix or Astro through the shadcn CLI as a single file you own.

When to use Rating

Product and service reviews.
Feedback prompts after a purchase or a support chat.
Displaying average ratings on cards.
Internal tools for scoring leads or content.

How it works

Each star is a radio button in a group, so the keyboard works and screen readers announce the value. The ripple is a staggered spring on each star's scale; readOnly turns it into a static display with a text equivalent.

It is a real form control: it has an accessible name, works with the keyboard alone, shows a visible focus ring and announces its state to screen readers. With prefers-reduced-motion on, it holds still or settles instantly instead of animating.

Customizing Rating

Every prop is documented in the API reference above with its type and default. The ones you will reach for first are listed here.

The Customize panel next to the preview lets you change max, size, readOnly live, and the Code tab updates to match, so the snippet you copy already carries your values.

value / defaultValue (number).
max (number, default 5).
size (number, default 28).
readOnly (boolean, default false).

Goes well with Rating

Rating is already composed into 5 ready-made sections, so you can see it in context or install the whole block.

Hero Rotating: Hero section
Hero App: Hero section
Testimonials Wall: Testimonials section
Testimonials Rating: Testimonials section
Magnetic: Make any React element lean toward the pointer and spring home: a magnetic hover in one wrapper
Color Picker: An animated React swatch colour picker with a ring that glides to the selection
File Dropzone: An animated React file dropzone that lifts on hover and lists uploads with progress
Like Button: An animated React like button: the heart pops, sparks burst and the count rolls
Hold to Confirm: A React hold-to-confirm button for destructive actions: hold while it fills, let go to cancel

Install Rating

npx shadcn@latest add @charcoal/rating

Rating is part of Charcoal UI Pro. One seat unlocks all 300 Pro components, 107 landing-page sections and 100 full templates, for every personal and client project, with updates included. Add the @charcoal registry once with your access token, then the command above copies rating.tsx into components/ui and installs clsx, tailwind-merge.

You own the file you install: no runtime package, no lock-in, nothing to keep in sync. Change it however your product needs.

See Charcoal UI Pro pricing · Pro setup

Frequently asked questions

How do I install Rating?: Rating is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/rating. It copies rating.tsx into components/ui and installs motion, clsx, tailwind-merge.
Is Rating free for commercial use?: Rating needs a Charcoal UI Pro seat, monthly or a one-time lifetime price. A seat covers unlimited personal and commercial projects, including client work, and every future Pro component.
Does Rating work with Next.js?: Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.
Can an AI coding agent install Rating?: Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Rating's props and get_install_command returns the exact command.

Rating as Markdown · llms.txt