README

A Laravel plugin that allows users to leave reactions on posts using Livewire, similar to the functionality in spatie/laravel-comments.

Features

Flexible Reaction Types: Define multiple reaction types with custom names and icons through the configuration file.
Model-Specific Reaction Types: Configure different reaction sets for different model types (e.g., thumbs up/down for comments, like/love for posts).
User and Guest Reactions: Allow both authenticated users and guests to leave reactions. Configurable to restrict reactions to only users, only guests, or both.
Customizable Reaction Limits: Set the maximum number of reactions a user or guest can leave on a single post through the configuration file.
Dynamic Reaction Display: Utilize a Livewire component to dynamically display reaction buttons with real-time updates.
Remove Reactions: Users and guests can remove their reactions. Configurable to set a time limit within which reactions can be removed.
Reaction Count Display: Display the count of each reaction type for a given post.
Total Reaction Count: Retrieve the total count of reactions for a given post.
Grouped Reaction Count: Retrieve a count of all reactions for a given post, grouped by reaction type.
Custom User Model: Easily configure the user model to be used for reactions.
Easy Integration: Simple integration with any Laravel model using the HasReactions trait.

Example configuration for reaction types:

return [
    // Default reaction types (used when no model-specific types are defined)
    'types' => [
        ['type' => 'like', 'name' => 'Like', 'icon' => '👍'],
        ['type' => 'love', 'name' => 'Love', 'icon' => '❤️'],
        ['type' => 'haha', 'name' => 'Haha', 'icon' => '😂'],
        ['type' => 'wow', 'name' => 'Wow', 'icon' => '😮'],
        ['type' => 'sad', 'name' => 'Sad', 'icon' => '😢'],
        ['type' => 'angry', 'name' => 'Angry', 'icon' => '😡'],
    ],
    
    // Model-specific reaction types
    // Define different reaction sets for different model classes
    'model_types' => [
        'App\Models\Post' => [
            ['type' => 'like', 'name' => 'Like', 'icon' => '👍'],
            ['type' => 'love', 'name' => 'Love', 'icon' => '❤️'],
        ],
        'App\Models\Comment' => [
            ['type' => 'thumbs_up', 'name' => 'Thumbs Up', 'icon' => '👍'],
            ['type' => 'thumbs_down', 'name' => 'Thumbs Down', 'icon' => '👎'],
        ],
    ],
    
    'allowed_users' => ['user', 'guest'], // Possible values: 'user', 'guest', 'both'
    'max_reactions_per_user' => 1,
    'table_name' => 'custom_reactions', // Table name
    'user_model' => null, // Default user model - null
    'removal_window_hours' => null, // Number of hours within which reactions can be removed, null means no limit
];

Installation

composer require broqit/laravel-reactions

Database Migration

php artisan vendor:publish --provider="Broqit\Laravel\Reactions\ReactionsServiceProvider" --tag=migrations
php artisan migrate

Vendor publishing

php artisan vendor:publish --provider="Broqit\Laravel\Reactions\ReactionsServiceProvider"

Style publishing

php artisan vendor:publish --provider="Broqit\Laravel\Reactions\ReactionsServiceProvider" --tag="public"

Configuration

You can optionally publish the config file with:

php artisan vendor:publish --provider="Broqit\Laravel\Reactions\ReactionsServiceProvider" --tag="config"

Usage

Add the HasReactions trait to your model:

use Broqit\Reactions\Traits\HasReactions;

class Post extends Model
{
    use HasReactions;

    // Your model code
}

Add the Livewire component to your view:

<!-- Default styled component -->
<livewire:reaction-button :model="$post" />

<!-- Tailwind CSS styled component -->
<livewire:reaction-button :model="$post" style="tailwind" />

Note: The Tailwind styled version requires Tailwind CSS to be installed and configured in your project. No additional CSS files are needed for this variant.

Retrieve reaction counts:

// Get the total count of reactions for a post
$totalReactions = $post->getTotalReactionsCount();

// Get the number of 'like' reactions for a post
$likeReactions = $post->getReactionsCountByType('like');

// Get the count of all reactions for a post, grouped by type
$groupedReactions = $post->getReactionsCountGroupedByType();

// Get the available reaction types for a model (returns model-specific types if defined)
$reactionTypes = $post->getReactionTypes();

Model-Specific Reaction Types

You can configure different reaction sets for different model types. This is useful when you want different reactions for different content types (e.g., thumbs up/down for comments, like/love for posts).

To configure model-specific reactions, add them to the model_types array in your configuration file:

'model_types' => [
    'App\Models\Post' => [
        ['type' => 'like', 'name' => 'Like', 'icon' => '👍'],
        ['type' => 'love', 'name' => 'Love', 'icon' => '❤️'],
    ],
    'App\Models\Comment' => [
        ['type' => 'thumbs_up', 'name' => 'Thumbs Up', 'icon' => '👍'],
        ['type' => 'thumbs_down', 'name' => 'Thumbs Down', 'icon' => '👎'],
    ],
],

When a model has specific reaction types defined, the ReactionButton component will automatically use those types. If no model-specific types are defined, it will fall back to the default types configuration.

Testing

To run the tests, first install the development dependencies:

composer install --dev

Then run PHPUnit:

vendor/bin/phpunit

The test suite includes:

Tests for the HasReactions trait, including the getReactionTypes() method
Tests for the ReactionButton Livewire component
Tests for model-specific reaction types configuration

broqit / laravel-reactions

Maintainers

Details