https://github.com/dulajkavinda/minimal-feedback

🗳 Blazingly fast and highly customizable component to get user feedback.
https://github.com/dulajkavinda/minimal-feedback

added bootstrap featured feedback latest minimal npm npm-package open-source react react-components reactui

Last synced: about 1 month ago
JSON representation

🗳 Blazingly fast and highly customizable component to get user feedback.

• Host: GitHub
• URL: https://github.com/dulajkavinda/minimal-feedback
• Owner: dulajkavinda
• License: mit
• Created: 2021-02-01T16:59:22.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-10-01T15:39:38.000Z (about 2 years ago)
• Last Synced: 2024-10-23T08:31:10.503Z (about 2 months ago)
• Topics: added, bootstrap, featured, feedback, latest, minimal, npm, npm-package, open-source, react, react-components, reactui
• Language: JavaScript
• Homepage: https://dulajkavinda.github.io/minimal-feedback/
• Size: 3.21 MB
• Stars: 103
• Watchers: 2
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-blazingly-fast - minimal-feedback - 🗳 minimal-feedback is a blazingly fast and highly customizable component to get user feedback. (JavaScript)

README

        
# minmal-feedback

[![NPM](https://img.shields.io/npm/v/minimal-feedback.svg)](https://www.npmjs.com/package/minimal-feedback) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [ ![downloads](https://img.shields.io/npm/dt/minimal-feedback.svg)](https://www.npmjs.com/package/minimal-feedback)

**minimal-feedback** is a blazingly fast and highly customizable component to get user feedback.



  



### Live Demo

---

[Live Demo at minimal-feedback](https://dulajkavinda.github.io/minimal-feedback/)

### Why

---

I needed a "feedback component" for my projects. Since I was unable to find one which met my requirements which is very minimal looking and user friendly ui this is what i came up with.

### Installation

---

The preferred way of using the component is via NPM

```bash

npm install --save minimal-feedback

```

### Usage

---

Here's a sample implementation that creates a custom popup on a dummy Create-React-App page.

```jsx

import React, { useState } from 'react'

import MinimalFeedback from 'minimal-feedback'

import 'minimal-feedback/dist/index.css' // don't forget to import css

const App = () => {

  const [text, settext] = useState({ feedback: '' })

  const saveFeedback = () => {

    // logic here

    console.log(text)

  }

  return (

     settext(e)}

    />

  )

}

export default App

```

### Options

---

| Option                  | Type       | Default                   | Description                                                |

| ----------------------- | ---------- | ------------------------- | ---------------------------------------------------------- |

| [`value`](#value)       | `Object`   | `{ feedback:'', type:''}` | Set this to the value you get from the `onChange` function |

| [`onChange`](#onChange) | `Function` | `()`                      | Called when user is typing something                       |

| [`save`](#save)         | `Function` | `()`                      | Called when `submit button` is clicked                     |

### Sample Usage

```jsx

 settext(e)}

/>

```

### Dev

---

The component is written in ES6 and uses [Webpack](http://webpack.github.io/) as its build tool.

#### Set up instructions

---

```

git clone https://github.com/dulajkavinda/minimal-feedback.git

cd minimal-feedback

npm install

npm start

```

### Contributing

---

Got ideas on how to make this better? Open an issue [here!](https://github.com/dulajkavinda/minimal-feedback/issues)

Issues, Pull Requests and all Comments are welcome!

## License

MIT © [dulajkavinda](https://github.com/dulajkavinda/minimal-feedback/blob/master/LICENSE)