1.0.4 • Published 1 year ago

@serhatyilmaz/feedbacky v1.0.4

Weekly downloads
-
License
-
Repository
-
Last release
1 year ago

Feedbacky

Feedbacky allows you to add a simple feedback widget to your website. Feedbacky adds a button to the bottom of your website, and when the button is clicked, it opens a modal containing a form for users to send feedback.

It is lightweight, (40.4kb) simple, and easy to integrate.

Feedbacky built with lit.dev.

You can check out the demo page to see how the package works.

Installation

Use the package manager npm to install feedbacky.

npm install @serhatyilmaz/feedbacky

Props

PropertyTypeDescriptionDefault Value
apiKeystring - requiredPredefined unique key of the customer''
spreadSheetIdstring - requiredID of the spreadsheet where the data is expected to be written (Ex. https://docs.google.com/spreadsheets/d/{spreadSheetId})''
sheetNamestring - requiredPage name of the where the data is expected to be written''
modalTitlestringTitle text displayed top of the formSend Your Feedback
submitButtonTextstringText of the submit button in the formSubmit
loadingTextstringButton's text when http request was pendingLoading...
submitSuccessTextstringSuccess message Success message displayed after form submissionWe Have Got Your Feedback

Usage

import feedbacky-widget

// You can use the element
<feedbacky-widget
spreadSheetId="Your spreadSheetId"
sheetName="Your sheetName"
apiKey="Your apiKey"
></feedbacky-widget>

Development

Feedbacky is developed using lit.dev and TypeScript. You can build and start development by following these steps

npm run build:watch
npm run serve

Testing

Feedbacky using web-test-runner you can test with the following code

npm run test
npm run test:watch

Code Coverage

FileStatementsFunctionsLines
feedback-widget.ts98.37%100%302/307

License

This project is licensed under the MIT License. For more information, see the LICENSE file.

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago