Preview

Rate this component

Click a star or use arrow keys to set a rating.

Half-star precision

Step = 0.5 enables half-star increments.

Read-only display

Non-interactive display of an existing rating.

Size variants

Controls

Theme

Surface

Direction

Viewport

Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.

Installation

terminal

php artisan ui:add rating

Behavior layer (Alpine)

This component installs a self-registering Alpine module to resources/js/ui/rating.js. Import the behavior layer once from your bundle so it loads (it hooks alpine:init):

resources/js/ui/index.js JS

import './rating.js';

Registry contract

Install confidence

php artisan ui:add rating writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version: 1.1.0
License: open
Stability: stable
Contract: v2
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/components/ui/rating.blade.php
js	resources/js/ui/rating.js

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Visible exclusive selection

Choose one option from a small visible set.

Use when

Use for a small set of mutually exclusive options that users should compare visibly before choosing. Do not hide a small option set in a dropdown when recognition and comparison matter.

Avoid when

Avoid using rating as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.

Task length: micro
Interaction cost: low
Interruptiveness: none
Input precision: constrained
Mobile / touch risk: low
Accessibility risk: medium
Needs background context: No
Comparison needed: Yes

Preferred alternatives

Select or combobox for long option sets

Anti-patterns

Hiding a small comparable set in a dropdown

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
value	int	0	Declared by @props in the registry Blade source.
max	int	5	Declared by @props in the registry Blade source.
step	int	1	Declared by @props in the registry Blade source.
readOnly	bool	false	Declared by @props in the registry Blade source.
name	mixed\|null	null	Declared by @props in the registry Blade source.
size	string	md	Declared by @props in the registry Blade source.

Slots

Components use the default Blade slot unless a documented subcomponent is installed by the registry item.

Data slots

rating rating-star

Capabilities

wcag-2.2-aa-target interactive responsive rtl darkMode localized

Behavior

Uses server-rendered Blade and semantic HTML.
Installs a JavaScript behavior module when the registry item includes resources/js/ui files.
Declares registry capability flags: a11y, interactive, responsive, rtl, darkMode, localized.

Usage

previews.components.rating.default.blade.php Blade

<div class="flex flex-col gap-6">
    {{-- Interactive rating with form value --}}
    <div class="flex flex-col gap-2">
        <label class="text-sm font-medium text-foreground">{{ __('Rate this component') }}</label>
        <x-ui.rating :value="3" name="rating" />
        <p class="text-xs text-muted-foreground">{{ __('Click a star or use arrow keys to set a rating.') }}</p>
    </div>

    {{-- Half-star mode --}}
    <div class="flex flex-col gap-2">
        <label class="text-sm font-medium text-foreground">{{ __('Half-star precision') }}</label>
        <x-ui.rating :value="3.5" :step="0.5" name="rating_half" />
        <p class="text-xs text-muted-foreground">{{ __('Step = 0.5 enables half-star increments.') }}</p>
    </div>

    {{-- Read-only display --}}
    <div class="flex flex-col gap-2">
        <label class="text-sm font-medium text-foreground">{{ __('Read-only display') }}</label>
        <x-ui.rating :value="4" :readOnly="true" />
        <p class="text-xs text-muted-foreground">{{ __('Non-interactive display of an existing rating.') }}</p>
    </div>

    {{-- Size variants --}}
    <div class="flex flex-col gap-2">
        <label class="text-sm font-medium text-foreground">{{ __('Size variants') }}</label>
        <div class="flex flex-col gap-2">
            <x-ui.rating :value="3" size="sm" :readOnly="true" />
            <x-ui.rating :value="3" size="md" :readOnly="true" />
            <x-ui.rating :value="3" size="lg" :readOnly="true" />
        </div>
    </div>
</div>

Accessibility & localization

WCAG 2.2 AA RTL-ready data-slot Keyboard focus-visible Localized labels

Accessibility target: wcag-2.2-aa-target.
Uses semantic HTML and a stable data-slot attribute for styling/scripting hooks.
Focus-visible rings use the ring token so keyboard focus is always visible.
Disabled and invalid states are conveyed to assistive tech, not by color alone.
Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces above.
Labels go through __() and the component uses logical properties (ms-*, text-start, start-*) so it mirrors correctly — flip the preview to RTL to confirm.

Source

The exact, editable file ui:add writes into your app — copy it or own the whole thing. Previews render this same code; there are no preview-only components.

Changelog

Current version: v1.1.0. See the site changelog for the full release history.

Rating