README

Star rating input with half-star support. Built for Laravel with support for Livewire, Blade, and Alpine.js.

Installation

composer require mrshanebarron/rating

The service provider will be auto-discovered. If you need to register it manually:

// config/app.php
'providers' => [
    // ...
    MrShaneBarron\Rating\RatingServiceProvider::class,
];

Usage

Livewire Component

<livewire:ld-rating />

Blade Component

<x-ld-rating />

With Props

<x-ld-rating
    :value="0"
    :max="5"
    :allowHalf="true"
    :readonly="false"
    size='md'
/>

Props

Prop	Type	Default	Description
`value`	number	`0`	Current rating value
`max`	number	`5`	Maximum rating (number of stars)
`allowHalf`	boolean	`true`	Allow half-star ratings
`readonly`	boolean	`false`	Make rating read-only
`size`	string	`'md'`	Star size

Configuration

Publish the config file:

php artisan vendor:publish --tag=ld-rating-config

This will create a config/ld-rating.php file where you can customize default values.

Customization

Publishing Views

Customize the component appearance by publishing the views:

php artisan vendor:publish --tag=ld-rating-views

Views will be published to resources/views/vendor/ld-rating/.

Styling

The component uses Tailwind CSS classes by default. You can customize styles by:

Publishing views and modifying the Blade templates
Using the class attribute to add custom classes
Overriding default styles in your CSS

<x-ld-rating class="custom-class" />

Events

The component dispatches Livewire events you can listen to:

Event	Payload	Description
`rating:updated`	Component data	Fired when state changes
`rating:initialized`	Initial data	Fired on component mount

// In your Livewire component
protected $listeners = ['rating:updated' => 'handleUpdate'];

public function handleUpdate($data)
{
    // Handle the update
}

Alpine.js Integration

The component works seamlessly with Alpine.js:

<div x-data="{ ' }} selected: null {{ ' }">
    <x-ld-rating x-model="selected" />
    <p x-text="selected"></p>
</div>

Requirements

PHP 8.1+
Laravel 10.x, 11.x, or 12.x
Livewire 3.x
Tailwind CSS 3.x (optional, for default styling)

Testing

composer test

Changelog

Please see CHANGELOG for recent changes.

Contributing

Contributions are welcome! Please see CONTRIBUTING for details.

Security

If you discover a security vulnerability, please email shane@sbarron.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

mrshanebarron / rating

Maintainers

Details