PHPackages mydnic/laravel-kustomer - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. mydnic/laravel-kustomer ActiveLibrary[Utility & Helpers](/categories/utility) mydnic/laravel-kustomer ======================= A fully featured feedback component for Laravel, gather user feedbacks, chat, etc v2.2.1(3mo ago)41049.2k↓27.8%351MITPHPPHP ^8.3CI passing Since Nov 12Pushed 1mo ago5 watchersCompare [ Source](https://github.com/mydnic/volet)[ Packagist](https://packagist.org/packages/mydnic/laravel-kustomer)[ Docs](https://github.com/mydnic/volet)[ GitHub Sponsors](https://github.com/Mydnic)[ RSS](/packages/mydnic-laravel-kustomer/feed)WikiDiscussions 2.x Synced 1mo ago READMEChangelog (10)Dependencies (8)Versions (40)Used By (1) An extensible customer feedback widget for Laravel ================================================== [](#an-extensible-customer-feedback-widget-for-laravel) [![Latest Version on Packagist](https://camo.githubusercontent.com/a837437434a4ad0dc09f11fbed73d50bfef87b0b7ad7bef16dc33d48e4602fa4/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d79646e69632f766f6c65742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/mydnic/volet)[![GitHub Tests Action Status](https://camo.githubusercontent.com/c8582cd831cd212d34c6e6147eddfd7deed22a89d0af7bbace27c37c6d13bbfc/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f6d79646e69632f766f6c65742f72756e2d74657374732e796d6c3f6272616e63683d322e78266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/mydnic/volet/actions?query=workflow%3Arun-tests+branch%3A2.x)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/b82fb0287afb6d2c85854c516ee386708b395bdeb2c7538f5c06545025b0e25a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f6d79646e69632f766f6c65742f7068702d63732d66697865722e796d6c3f6272616e63683d322e78266c6162656c3d636f64652532307374796c65267374796c653d666c61742d737175617265)](https://github.com/mydnic/volet/actions?query=workflow%3A%22Fix+PHP+code+style+issues%22+branch%3A2.x)[![Total Downloads](https://camo.githubusercontent.com/eb152b77f48bdfc218b44fb9d15682af3a9633b2285e61e38e281473ac6f7677/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6d79646e69632f766f6c65742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/mydnic/volet) 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 ================= [](#table-of-contents) - [Introduction](#introduction) - [Installation](#installation) - [Quickstart](#quickstart) - [Style customization](#style-customization) - [Creating Custom Features](#creating-custom-features) - [Features](#features) Introduction ------------ [](#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](#creating-custom-features). This package does not come with any chat out of the box (yet ?). Demo ---- [](#demo) [![Demo of Volet Panel](demo.gif)](demo.gif) Installation ------------ [](#installation) You can install the package via composer: ``` composer require mydnic/volet ``` Publish the assets with: ``` php artisan vendor:publish --tag="volet-assets" --force ``` You can publish and run the migrations with: ``` php artisan vendor:publish --tag="volet-migrations" php artisan migrate ``` You can publish the config file with: ``` php artisan vendor:publish --tag="volet-config" ``` Have a quick look at `config/volet.php` and update anything you want. ### Upgrade [](#upgrade) If you're upgrading from an older version, you should run: ``` php artisan vendor:publish --tag="volet-config" --force php artisan vendor:publish --tag="volet-assets" --force ``` Optionally, you can add this to your `composer.json` to automatically update the assets when you update the package: ``` { "scripts": { "post-package-update": [ "@php artisan vendor:publish --tag=volet-assets --force" ] } } ``` Quickstart ---------- [](#quickstart) First, create a service provider to configure your Volet features. You can publish our pre-configured provider: ``` php artisan vendor:publish --tag="volet-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): ``` return [ // ... App\Providers\VoletServiceProvider::class, ]; ``` In your `VoletServiceProvider`, register and configure your features: ``` namespace App\Providers; use Illuminate\Support\ServiceProvider; use Mydnic\Volet\Features\FeedbackMessages; use Mydnic\Volet\Features\FeatureManager; class VoletServiceProvider extends ServiceProvider { public function boot(FeatureManager $volet): void { // Register and configure the Feedback Messages feature $this->registerFeedbackMessagesFeature($volet); // Example of registering a custom feature // $volet->register(new YourCustomFeature()); } private function registerFeedbackMessagesFeature(FeatureManager $volet): void { $volet->register( (new FeedbackMessages) // Configure feature display ->setLabel('Send us feedback') ->setIcon('https://api.iconify.design/lucide:message-square.svg?color=%23888888') // Add feedback categories ->addCategory( slug: 'general', name: 'General Feedback', icon: 'https://api.iconify.design/lucide:smile.svg?color=%23888888' ) ->addCategory( slug: 'improvement', name: 'Improvement', icon: 'https://api.iconify.design/lucide:lightbulb.svg?color=%23888888' ) ->addCategory( slug: 'bug', name: 'Bug Report', icon: 'https://api.iconify.design/lucide:bug.svg?color=%23888888' ) ); } } ``` 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 `` section: ``` @voletStyles ``` Right before the closing body tag: ``` @volet ``` 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 `` section. ### Style customization [](#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: ``` @voletStyles :root { --volet-background: #FF2D20; } ``` All variables are listed here : Creating Custom Features ------------------------ [](#creating-custom-features) You can create your own features by extending the `BaseFeature` class: ``` namespace App\Volet\Features; use Mydnic\Volet\Features\BaseFeature; class CustomFeature extends BaseFeature { public function getId(): string { return 'custom-chatbot'; } public function getLabel(): string { return 'Talk with our chatbot'; } public function getIcon(): string { return 'https://api.iconify.design/lucide:star.svg?color=%23888888'; } public function getComponentName(): ?string { return 'custom-feature'; // Name of your Web Component } public function getScripts(): ?string { $scriptUrl = asset('volet-custom-feature.js'); return ""; } public function getConfig(): array { return [ 'routes' => [ 'store' => route('custom-feature.store'), ], 'labels' => [ 'placeholder' => 'Enter your message...', 'button' => 'Submit', 'success' => 'Thank you!', ], // Add any other configuration your component needs ]; } } ``` 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: ``` Click me defineProps({ config: { type: Object, required: true, }, }) /** * Add your custom CSS here */ ``` ``` // resources/js/volet-custom-feature.js import { defineCustomElement } from 'vue' import CustomFeatureComponent from './components/CustomFeatureComponent.ce.vue' const Element = defineCustomElement(CustomFeatureComponent) customElements.define('custom-feature', Element) ``` ``` // vite.config.js import { defineConfig } from 'vite'; import vue from '@vitejs/plugin-vue'; import { resolve } from 'path'; export default defineConfig({ plugins: [ vue({ template: { compilerOptions: { isCustomElement: (tag) => tag.includes('custom-feature'), } } }) ], define: { 'process.env.NODE_ENV': JSON.stringify('production'), }, build: { lib: { entry: resolve(__dirname, 'resources/js/volet-custom-feature.js'), name: 'CustomFeature', fileName: () => `volet-custom-feature.js`, formats: ['iife'], }, outDir: 'public/', } }); ``` 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. Want to create a package ? Check out the skeleton here: Features -------- [](#features) You can install multiple features in your Volet instance. Here's a list of available features: - [FeedbackMessages (out of the box)](https://github.com/mydnic/volet/tree/2.x/docs/FeedbackMessages.md): Allows users to submit simple text messages - Filament Plugin : [mydnic/volet-feedback-messages-filament-plugin](https://github.com/mydnic/volet-feedback-messages-filament-plugin) - [FeatureBoard (mydnic/volet-feature-board)](https://github.com/mydnic/volet-feature-board): Feature Request/Feature Board Want to create a feature for Volet ? Check out the skeleton here: Testing ------- [](#testing) ``` composer test ``` Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](CONTRIBUTING.md) for details. Security Vulnerabilities ------------------------ [](#security-vulnerabilities) Please review [our security policy](../../security/policy) on how to report security vulnerabilities. Credits ------- [](#credits) - [ClΓ©ment Rigo](https://github.com/mydnic) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 66 β€” FairBetter than 99% of packages Maintenance84 Actively maintained with recent releases Popularity49 Moderate usage in the ecosystem Community26 Small or concentrated contributor base Maturity88 Battle-tested with a long release history Bus Factor1 Top contributor holds 51.5% of commits β€” single point of failure How is this calculated?**Maintenance (25%)** β€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** β€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** β€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** β€” Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~74 days Total 37 Last Release 54d ago Major Versions v0.3 β†’ v1.02018-11-23 v1.11.0 β†’ v2.0.0-beta12025-03-28 PHP version history (5 changes)v0.1PHP ^7.1 v1.4PHP ^7.2 v1.7.0PHP ^7.2|^8.0 v1.8.0PHP >=8.0 v2.0.0-beta1PHP ^8.3 ### Community Maintainers ![](https://www.gravatar.com/avatar/bc52c3eeee29c610da76c047b3cec562c062ebb747e5e3ef097677373269b7e4?d=identicon)[mydnic](/maintainers/mydnic) --- Top Contributors [![mydnic](https://avatars.githubusercontent.com/u/2733767?v=4)](https://github.com/mydnic "mydnic (238 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (106 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (58 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (49 commits)")[![laravel-shift](https://avatars.githubusercontent.com/u/15991828?v=4)](https://github.com/laravel-shift "laravel-shift (4 commits)")[![serwin35](https://avatars.githubusercontent.com/u/4369427?v=4)](https://github.com/serwin35 "serwin35 (2 commits)")[![Joel-Jensen](https://avatars.githubusercontent.com/u/60270137?v=4)](https://github.com/Joel-Jensen "Joel-Jensen (1 commits)")[![IrfanHasani](https://avatars.githubusercontent.com/u/18289646?v=4)](https://github.com/IrfanHasani "IrfanHasani (1 commits)")[![clarkewing](https://avatars.githubusercontent.com/u/7689302?v=4)](https://github.com/clarkewing "clarkewing (1 commits)")[![nidhalkratos](https://avatars.githubusercontent.com/u/10298337?v=4)](https://github.com/nidhalkratos "nidhalkratos (1 commits)")[![pepijnolivier](https://avatars.githubusercontent.com/u/2015108?v=4)](https://github.com/pepijnolivier "pepijnolivier (1 commits)") --- Tags chatcustomerfeedbacklaravellaravel-kustomervoletvuejsmydnicvoletlaravel-volet ### Code Quality TestsPest Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/mydnic-laravel-kustomer/health.svg) ``` [![Health](https://phpackages.com/badges/mydnic-laravel-kustomer/health.svg)](https://phpackages.com/packages/mydnic-laravel-kustomer) ``` ### Alternatives [mydnic/volet A fully featured feedback component for Laravel, gather user feedbacks, chat, etc 41015.1k2](/packages/mydnic-volet)[guava/calendar Adds support for vkurko/calendar to Filament PHP. 298241.0k3](/packages/guava-calendar)[tonysm/rich-text-laravel Integrates Trix content with Laravel 46577.8k1](/packages/tonysm-rich-text-laravel)[hydrat/filament-table-layout-toggle Filament plugin adding a toggle button to tables, allowing user to switch between Grid and Table layouts. 6292.3k1](/packages/hydrat-filament-table-layout-toggle)[ralphjsmit/laravel-helpers A package containing handy helpers for your Laravel-application. 13704.6k2](/packages/ralphjsmit-laravel-helpers)[spatie/laravel-screenshot Take screenshots of web pages in Laravel apps 7615.9k2](/packages/spatie-laravel-screenshot) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)