feedbacky-library

Feedbacky: lightweight feedback collector

Feedbacky is a JS library for collecting visitor feedbacks across your web projects.

Installation

Script Tag

<script src="https://unpkg.com/feedbacky-library@0.1.4/dist/feedbacky.js"></script>

NPM Installation

npm install feedbacky-library

Usage

feedbacky.render({
  elementId: 'feedback-el-root',
  config: { projectId: 'PROJECT_ID_FROM_DASHBOARD_APP' },
});

import { render } from 'feedbacky-library';

function App() {
  useEffect(() => {
    render({
      elementId: 'feedbacky-el-root',
      config: {
        projectId: 'PROJECT_ID_FROM_DASHBOARD_APP',
        primaryColor: '#f3f779',
        textColor: 'blue',
        showEmail: true,
      },
    });
  }, []);

  return <h1>app</h1>;
}

Configuration

config	description	type	required	default
elementId	html element id that modal feecbacky modal will render	string	true	null
config	props used to customize feedbacky modal	object	true	null
config.projectId	unique project id from feedbacky dashboard app	string	true	null
config.primaryColor	color of the buttons on feedbacky modal	string	false	#764abc
config.textColor	text color of the buttons on feedbacky modal	string	false	#ffffff
config.postSubmitMessage	message that will be visible on submit button after form is submitted (hex, rgba, etc.)	string	false	"Thanks four your feedback!"
config.submitButtonMessage	form submit button text color (hex, rgba, etc.)	string	false	"Send Feedback!"
config.showEmail	whether email field is visible	boolean	false	false
config.defaultEmail	default value of email field	string	false	""
config.emailRequired	whether email field is required	boolean	false	false
config.zIndex	z-index of modal container	string	false	999999

Example

feedbacky.render({
  elementId: 'feedback-el-root',
  config: {
    projectId: 'PROJECT_ID_FROM_DASHBOARD_APP',
    primaryColor: '#000000',
    textColor: '#ffffff',
    showEmail: 'true',
    defaultEmail: '[e-mail]',
    emailRequired: 'true',
  },
});

Admin Dashboard

You have to create an account on admin dashboard to render feecbacky modal on your website. Feedbacks are directly posted to your created project on dashboard.

License

MIT