Feedjet Feedback

Feedjet Feedback est une librairie JavaScript pour intégrer un widget de feedback personnalisé à votre application. Elle permet aux utilisateurs de soumettre des problèmes, des suggestions, ou des améliorations via un formulaire interactif.

Fonctionnalités

• Collecte de feedback utilisateur avec un formulaire personnalisable.
• Capture d’écran automatique incluse dans les feedbacks.
• Gestion des erreurs de validation.
• Sécurisation des requêtes avec un token d'authentification.
• URL d'API configurable pour s'adapter à votre environnement.

Installation

Ajoutez la librairie à votre projet en utilisant npm ou yarn :

npm install feedjet

ou

yarn add feedjet

Utilisation

Intégration basique

Ajoutez le widget dans votre projet en initialisant la classe Feedback.

import { Feedback } from 'feedjet';

const feedback = new Feedback({
    targetId: 'feedback-widget',
    feedjetProjectId: '12345',
    apiUrl: 'https://api.example.com/api/import_feedback',
    token: 'your-secure-token',
    user: {
        id: '1',
        fullName: 'John Doe',
    },
});

Ajoutez le conteneur HTML dans votre page :

<div id="feedback-widget"></div>

Le widget sera automatiquement rendu dans le conteneur avec l'ID feedback-widget.

Exemple avec Nuxt 3

Si vous utilisez Nuxt 3, configurez le widget dans un plugin client.

1. Créez un fichier dans plugins/feedjet.client.ts :

import { Feedback } from 'feedjet';

export default defineNuxtPlugin(() => {
    const feedback = new Feedback({
        targetId: 'feedback-widget',
        feedjetProjectId: '12345',
        apiUrl: 'https://api.example.com/api/import_feedback',
        token: 'your-secure-token',
        user: {
            id: '1',
            fullName: 'John Doe',
        },
    });
    return {
        provide: {
            feedback,
        },
    };
});

2. Ajoutez le conteneur dans un composant Vue :

<template>
  <div id="feedback-widget"></div>
</template>

Options disponibles

Paramètres de Feedback

| Paramètre | Type | Description | Obligatoire | |--------------------|-----------------|-----------------------------------------------------------------------------|-------------| | targetId | string | ID du conteneur HTML où le widget sera rendu | Oui | | feedjetProjectId | string | Identifiant unique de projet Feedjet | Oui | | apiUrl | string | URL de l'API pour envoyer les feedbacks | Oui | | token | string | Token d’authentification pour sécuriser les requêtes | Oui | | user | object | Informations sur l'utilisateur (ID et nom complet) | Non |

Licence

Cette librairie est sous licence MIT. Consultez le fichier LICENSE pour plus d'informations.