1.0.1 • Published 7 months ago

feedjet-demo v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
7 months ago

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,
        },
    };
});
  1. Ajoutez le conteneur dans un composant Vue :
<template>
  <div id="feedback-widget"></div>
</template>

Options disponibles

Paramètres de Feedback

ParamètreTypeDescriptionObligatoire
targetIdstringID du conteneur HTML où le widget sera renduOui
feedjetProjectIdstringIdentifiant unique de projet FeedjetOui
apiUrlstringURL de l'API pour envoyer les feedbacksOui
tokenstringToken d’authentification pour sécuriser les requêtesOui
userobjectInformations sur l'utilisateur (ID et nom complet)Non

Licence

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

1.0.1

7 months ago

1.0.0

7 months ago