Download the PHP package mydnic/laravel-kustomer without Composer
On this page you can find all versions of the php package mydnic/laravel-kustomer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mydnic/laravel-kustomer
More information about mydnic/laravel-kustomer
Files in mydnic/laravel-kustomer
Package laravel-kustomer
Short Description A fully featured feedback component for Laravel, gather user feedbacks, chat, etc
License MIT
Homepage https://github.com/mydnic/volet
Informations about the package laravel-kustomer
An extensible customer feedback widget for Laravel
Volet is a highly customizable customer interaction widget for Laravel applications that provides a flexible feature system. It comes with one built-in feature: feedback messages collection. But it allows you to create your own custom features.
- 🎨 Fully customizable theme using CSS variables (or by using your own css)
- 🧩 Extensible feature system
- 📝 Built-in feedback message collection
- 🎯 Simple integration with Laravel
- 🛠️ Built with VueJS
- 🔧 Easy to create custom features, or install community made features
Table of contents
- Introduction
- Installation
- Quickstart
- Style customization
- Creating Custom Features
- Built-in Features
- Feedback Messages
- Community Features
Introduction
Volet is an open-source widget-like component that you drop on your website to interact with your website's visitors. It's like Crisp, Zendesk, Intercom, Tawkto, etc.
First this package was named Laravel Kustomer. But due to a stupid copyright infringement, I had to rename this package to 'laravel-feedback-component'.
After several years I finally decided to take the time to rebuild it from scratch. It's now called Volet, which means "a panel that can be opened or closed" in French.
At it's core, it's simply a panel that opens up when you click the floating button. Inside that panel, you will decide what options you want to give your users. It can be a simple form, or a chatbot, or anything you want.
By default, Volet comes with one built-in feature: feedback messages collection, which is a simple way for your users to send you a single message.
What's great about Volet is that it's extensible. You can create custom features, or install community made features. If you want to make your own chatbot, you can integrate it to Volet! Or if someone else made one, you can install it and use it.
Volet is built using VueJS, but is meant to render any Web Component. So you can build your own Web Component (super easy with vuejs, btw), and implement them in Volet. Examples below.
This package does not come with any chat out of the box (yet ?).
Demo
Installation
You can install the package via composer:
Publish the assets with:
You can publish and run the migrations with:
You can publish the config file with:
Have a quick look at config/volet.php
and update anything you want.
Upgrade
If you're upgrading from an older version, you should run:
Optionally, you can add this to your composer.json
to automatically update the assets when you update the package:
Quickstart
First, create a service provider to configure your Volet features. You can publish our pre-configured provider:
This will create app/Providers/VoletServiceProvider.php
with some example features already configured.
Register your new service provider in bootstrap/providers.php
(if you're using Laravel 12 or above):
In your VoletServiceProvider
, register and configure your features:
What's great with this configuration approach is that you can easily add or remove features, based on your needs, for example enable or disable a feature for a specific type of users.
Then add the Volet component to your blade view:
In the <head>
section:
Right before the closing body tag:
If you are planning to use your own CSS theme, you can skip adding the @voletStyles
directive and add your own CSS file to your <head>
section.
Style customization
Volet's default style uses CSS variables for styling. So you can already set your own variables to customize the look and feel of your Volet app.
Add this after the @voletStyles
directive:
All variables are listed here : https://github.com/mydnic/volet/blob/2.x/resources/css/volet.css#L4
Creating Custom Features
You can create your own features by extending the BaseFeature
class:
Create a Web Component for your feature's UI, then compile it to a ready to use JS file.
Here's a simple example made with VueJS:
As we are working with Web Components, you can use any framework to build your component, with any CSS framework.
That's it ! Volet will automatically load your feature and display it in the panel, as long as the feature is registered and enabled.
Built-in Features
Feedback Messages
The feedback messages feature allows users to submit feedback in different categories. Configure the table name in your config/volet.php
:
Configure the feature in your VoletServiceProvider
:
You can enable/disable the feature:
Notifications
You can easily use Laravel model's events to send notifications when a new feedback message is submitted:
Admin Panel
I've made a filament plugin to easily manage the feedback messages. You can find it here.
Community Features
- FeatureBoard (mydnic/volet-feature-board): Add a Feature Request/Feature Board to Volet
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Clément Rigo
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-kustomer with dependencies
spatie/laravel-package-tools Version ^1.16
illuminate/contracts Version ^10.0||^11.0||^12.0