README

A configurable Livewire component for collecting feedback through a customizable form. Built on Internet Guru Laravel Common Component, inheriting its conventions for email logging, footer rendering, and styling.

Features

Pre-styled, responsive form
Attribute-based validation (name, mode, validation)
reCAPTCHA support (if configured)
Inline errors and success messaging
Sends submissions via mail to your target address

Installation

Install and configure Livewire.
Install the package via Composer:

composer require internetguru/laravel-feedback

Ensure mail configuration is working.
Optional: configure reCAPTCHA, see internetguru/laravel-common.

Usage

Minimalistic (only required attributes and button)

<livewire:ig-feedback
    id="feedback-form"
    email="support@example.com"
    name="Support Team"
/>
<button class="btn btn-primary" onclick="Livewire.dispatch('openFeedback', {id: 'feedback-form'})">
    Give Feedback
</button>

Basic (custom subject, title, and fields, multiple usages)

<livewire:ig-feedback
    id="contact-us-form"
    email="helpdesk@example.com"
    name="Helpdesk"
    subject="New Feedback"
    title="Contact Us"
    submit="Send Feedback"
    :fields="[
        ['name'=>'name', 'label'=>'Your Name', 'required' => true],
        ['name'=>'email', 'label'=>'Your Email', 'required' => true],
        ['name'=>'message', 'label'=>'Message', 'required' => true]
    ]"
/>
<button class="btn btn-primary" onclick="Livewire.dispatch('openFeedback', {id: 'contact-us-form'})">
    Contact Us
</button>
<p>
    Do you have questions or need assistance?
    <a href="#" onclick="Livewire.dispatch('openFeedback', {id: 'contact-us-form'})">
        Click here to reach our Helpdesk.
    </a>
</p>

Advanced (duplicate field names and custom validation)

<livewire:ig-feedback
    id="detailed-feedback-form"
    email="info@example.com"
    name="Info Center"
    subject="Website Feedback"
    title="Feedback Form"
    submit="Submit"
    :fields="[
        ['name'=>'name', 'label'=>'Full Name', 'required' => true],
        ['name'=>'email', 'label'=>'Work Email', 'required' => true],
        ['name'=>'email', 'label'=>'Personal Email'],
        ['name'=>'message', 'label'=>'Feedback Message', 'required' => true],
    ]"
/>
<button class="btn btn-primary" onclick="Livewire.dispatch('openFeedback', {id: 'detailed-feedback-form'})">
    Provide Feedback
</button>

Defaults

If fields are omitted, the component renders:

[
    ['name' => 'message', 'label' => 'Describe your issue', 'required' => 'true'],
    ['name' => 'name', 'label' => 'Leave your email for contact'],
]

Props

id (required) Unique identifier for the component instance. Used to target the component when opening the form.

email (required) Destination address for submitted feedback. Used as the "to" recipient.

name (required) Display name used for the sender context. Appears in email metadata.

subject (optional, default "Feedback") Subject line used for outgoing mail.

title (optional, default "Feedback") Heading shown above the form.

submit (optional, default browser value) Text for the submit button.

fields (optional) Array defining which fields to render and how to validate them. See "Field items" below.

Field items

name (required) Field name. Supported values include: name, email, message, phone. No implicit default. You must specify a name.

required (optional, default false) Whether the field is required.

label (optional) Custom label is displayed. If omitted, a reasonable label is generated. For duplicate names, labels will auto-increment when omitted, e.g. Email 1, Email 2.

Submission behavior

By default the component sends the submitted data to the configured email with the given subject. You control the payload by defining fields, required and patterns. You can listen into Livewire event to extend or replace delivery (for example, call an API, enqueue a job). Inline errors and a success state are rendered by the component.

Customization

Styling The component ships pre-styled. You can override classes by publishing the Blade view or wrapping the component in your layout.

Localization The component uses translation keys under the ig-feedback:: namespace. You can publish the language files to override them.

Custom names You can register additional field names via your standard config. Define a name key and its renderer and default pattern. Example:

// config/ig-feedback.php
return [
    'names' => [
        'name' => [
            'type' => 'text',
            'validation' => 'string|min:2|max:100',
            'label_translation_key' => 'ig-feedback::fields.name',
            'view' => 'ig-feedback::fields.name',
        ],
        'email' => [
            'type' => 'email',
            'validation' => 'email:rfc,dns|max:255',
            'label_translation_key' => 'ig-feedback::fields.email',
            'view' => 'ig-feedback::fields.email',
        ],
        'message' => [
            'type' => 'textarea',
            'validation' => 'string|min:1|max:2000',
            'label_translation_key' => 'ig-feedback::fields.message',
            'view' => 'ig-feedback::fields.message',
        ],
        // your custom type
        'company' => [
            'type' => 'text',
            'validation' => 'string|min:2|max:100',
            'label_translation_key' => 'fields.company',
            'view' => 'ig-feedback::fields.company',
        ],
    ],
];

Then use it like any other name:

:fields="[
    ['name'=>'company', 'required' => true],
]"

internetguru / laravel-feedback

Maintainers

Details