README

Add a feedback form to your TALL stack application to collect feedback from your visitors.

Demo

Installation

This package comes without any styles. It assumes you have the styles for tailwind, tailwindui and AlpineJs installed.

You can install the package via composer:

composer require pschocke/laravel-feedback-modal

You can publish and run the migrations with:

php artisan vendor:publish --provider="pschocke\FeedbackModal\FeedbackModalServiceProvider" --tag="migrations"
php artisan migrate

This package comes with translation files. You can publish them using:

php artisan vendor:publish --provider="pschocke\FeedbackModal\FeedbackModalServiceProvider" --tag="translations"

You should publish the livewire component using:

php artisan vendor:publish --provider="pschocke\FeedbackModal\FeedbackModalServiceProvider" --tag="views"

Customization

Changing the radio group items

You can customize the feedback-types that are available in the radio group by changing the corresponding array in your previously published translations:

return [
    //...,
    'feedback' => [
            'type' => 'Type of feedback',
            'types' => [
                // every array key is an option in the radio group. You can customize them however you want.
                'error' => [
                    'title' => 'i found a mistake',
                    'description' => 'You found a bug that you want to report to us'
                ],
            ]
        ],
];

Changing the style

After publishing the livewire component, you can edit it in any way you want.

Usage

Just include the laravel livewire component:

<body>
    ...
    @livewire('feedback-modal')
</body>

Usage with purgecss

If you use purgecss to minify your css (I highly recommend you do!), you should publish the component to keep the classes used in the component from getting purged.

Getting the submitted feedback

You can get the submitted feedback using the eloquent model provided with this package:

$feedbacks = \pschocke\FeedbackModal\AnonymousFeedback::all();

Adding fields to the Feedback Model

You can add more fields to the model simply by adding them to the migration.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email patrick@ausbildung-ms.de instead of using the issue tracker.

Credits

License

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

pschocke / laravel-feedback-modal

Maintainers

Details