README

A lightweight PHP package for embedding the ITK Feedback Collector widget on Symfony and Drupal sites.

The client automatically injects the widget script tag before </body> on all HTML responses. No database, no routes ??? just a script tag and an API key.

Installation

composer require itk-dev/itk-feedback-client

Symfony

Register the bundle in config/bundles.php:

return [
    // ...
    ItkDev\ItkFeedbackClientBundle\ItkFeedbackClientBundle::class => ['all' => true],
];

Drupal

Enable the module:

drush en itk_feedback_client

Configuration

Set these environment variables in your .env.local (Symfony) or hosting environment (Drupal):

# Required ??? the URL of your Itk Feedback Collector instance
ITK_FEEDBACK_CLIENT_URL=https://your-collector-domain.com

# Required ??? the API key for your website (from the collector admin)
ITK_FEEDBACK_CLIENT_API_KEY=your-api-key-here

# Optional ??? set to "true" to disable widget injection entirely
ITK_FEEDBACK_CLIENT_DISABLE=false

# Optional ??? regex pattern for paths where the widget should not appear
ITK_FEEDBACK_CLIENT_DISABLE_PATTERN=

How it works

The client listens to the kernel.response event and injects the following script tag before </body> on successful HTML responses:

<script src="https://your-collector-domain.com/build/widget/widget.js"
        data-api-key="your-api-key-here"></script>

The widget handles everything else ??? UI, screenshots, and posting feedback to the collector API.