@yemredurur/feedback-app
v1.1.0
Published
This project is a feedback system for websites. It enables customers to provide feedback and saves it to Firebase.
Downloads
19
Readme
Feedback Component App
This project is a feedback system for websites. It enables customers to provide feedback and saves it to Firebase.
Installation
To install, you can use npm or yarn:
$ npm install --save @yemredurur/feedback-app
$ yarn add @yemredurur/feedback-app
Component Properties
| Properties | Type | Req | Default | Desc | ------------- |:-------------:|:-------------:|:-------------:|:-------------:| | title | string | false | Please Send Your FeedBack | Feedback modal title | rootId | string | true | null | Feedback modal appends that root | companyId | number | true | null | Company special id | companyName | number | true | null | Company name that user whant | maxTextLength | number | false | 2000 | Max text for feedback | minTextLength | number | false | 10 | Min text for feedback | showCountLeftText | boolean | false | true | Shows how many letters has left | successMessage | string | false | WE HAVE GOT YOUR FEEDBACK | Success message when feedback send | errorMessage | string | false | There is a problem please try again! | Error message when service error | onClickEvent | func | false | () => void | Event function when user clicks feedback icon | onSendEvent | func | false | () => void | Event function when user clicks send button | onCloseEvent | func | false | () => void | Event function when user closes feedback modal
Useage Example
import React from 'react';
import FeedBack from '@yemredurur/feedback-app';
function App() {
const buttonClick = () => [
console.log('Button Click')
]
const onSend = () => [
console.log('On send')
]
const onClose = () => [
console.log('On close')
]
return (
<>
<FeedBack
rootId='root'
title={TITLE}
companyId={COMPANY_ID}
companyName={COMPANY_NAME}
onClickEvent={buttonClick}
onSendEvent={onSend}
onCloseEvent={onClose}
/>
</>
)
}
Technologies Used
This project was built with the following technologies:
- React - A JavaScript library for building user interfaces.
- TypeScript - TypeScript is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.
- Jest - A delightful JavaScript testing framework with a focus on simplicity.
- Firebase - Firebase is an app development platform that helps you build and grow apps and games users love. Backed by Google and trusted by millions of businesses around the world.