🙋 Feeedback
Feeedback is a JavaScript widget to easily collect feedback from your users. It's small, accessible, and customizable.
⭐ Getting started
Install the library as a dependency:
npm install feeedback
Or, if you're using Yarn:
yarn add feeedback
Then import the library:
;
And initialize it with an optional settings object:
const widget = { // Send feedback to your server ; };;
You can also use a CDN:
When you want to open the feedback modal, you can do:
widget;
🛠️ Development
Start development server with HMR and prettier:
yarn start
Production
Build a production version:
yarn build
💡 Examples
Google Analytics
The easiest way to collect feedback to to use Google Analytics as a backend. If you already have GA loaded on your webpage:
; const widget = { ; ; };;
Custom backend
const widget = ;;
Events
Feeedback emits events which you can listen to:
const widget = ;widget;
You can use .off()
to stop listening to an event, and "*"
to subscribe to all events. Events emitted are, in order of lifecycle:
ready
beforeCreate
created
open
andclose
reset
beforeSubmit
submit
orerror
finish
📝 License
MIT © Anand Chowdhary