Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ivansotelo/vuefeedbackreaction
Helps you to collect feedback and leads using the most spoken language in the world: the emoji.
https://github.com/ivansotelo/vuefeedbackreaction
emoji feedback reaction vue
Last synced: about 17 hours ago
JSON representation
Helps you to collect feedback and leads using the most spoken language in the world: the emoji.
- Host: GitHub
- URL: https://github.com/ivansotelo/vuefeedbackreaction
- Owner: IvanSotelo
- License: mit
- Created: 2019-08-06T15:46:28.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T01:10:47.000Z (12 months ago)
- Last Synced: 2024-09-25T01:23:47.118Z (about 19 hours ago)
- Topics: emoji, feedback, reaction, vue
- Language: Vue
- Homepage: https://ivansotelo.github.io/VueFeedbackReaction/
- Size: 4.35 MB
- Stars: 106
- Watchers: 6
- Forks: 21
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# VueFeedbackReaction
> Helps you to collect feedback and leads using the most spoken language in the world: the emoji.
[](https://www.codacy.com/manual/IvanSotelo/VueFeedbackReaction?utm_source=github.com&utm_medium=referral&utm_content=IvanSotelo/VueFeedbackReaction&utm_campaign=Badge_Grade)
[](http://npmjs.com/package/vue-feedback-reaction) [](https://github.com/IvanSotelo/VueFeedbackReaction/stargazers) [](https://madewithvuejs.com/p/vuefeedbackreaction/shield-link) [](https://travis-ci.org/IvanSotelo/VueFeedbackReaction) [](https://npmjs.com/package/vue-feedback-reaction)
[](https://github.com/IvanSotelo/VueFeedbackReaction/actions)
This project is inspired by [Feedback Reactions](https://dribbble.com/shots/4793955-Feedback-Reactions) from [Mohammad Amiri](https://dribbble.com/pixelamiri)
## Installation
``` bash
# Install with npm
$ npm i -S vue-feedback-reaction
# or yarn
$ yarn add vue-feedback-reaction
```
**Note:** This project exports two components, VueFeedBackReaction, which is the feedback component itself, and VueReactionEmoji, if you'd like to use a single emoji. If you install using `Vue.use`, you will **only** get VueFeedbackReaction component.
## Usage
### VueFeedbackReaction
``` vue
import { VueFeedbackReaction } from 'vue-feedback-reaction';
export default {
name: 'demo',
components: {
VueFeedbackReaction
},
data: () => ({
feedback: ''
})
};
```
### Props
| Property name | Type | Default | Description |
|-----------------|-----------------------|---------|------------------------------------------------------------------------------------|
| value | String, Number | '' | Input value (v-model) |
| labels | Array | [] | Array of strings that set labels below each emoji reaction, starting from the left |
| labelClass | Object, Array, String | '' | Only works if you are using the labels prop. Set a v-bind:class to all the labels |
| emojiWidth | String, Number | '' | Set a width for all emojis |
| emojiHeight | String, Number | '' | Set a height for all emojis |
| containerWidth | String, Number | '' | Set the containers width |
| containerHeight | String, Number | '' | Set the containers height |
### VueReactionEmoji
``` vue
import { VueReactionEmoji } from 'vue-feedback-reaction';
export default {
name: 'demo',
components: {
VueReactionEmoji
},
data: () => ({
reaction: 'natural',
isActive: false,
isDisabled: false
})
};
```
### Props
| Property name | Type | Default | Description |
|-----------------|----------------|-----------|------------------------------------------------------------------------------------------------|
| reaction | String | 'natural' | Reaction of the emoji. Must be either `hate`, `disappointed`, `natural`, `good` or `excellent` |
| is-active | Boolean | false | If you want the emoji to start with it's active state, set it to `true` |
| is-disabled | Boolean | false | If you want the emoji to have **no** hover or click state, set it to `true` |
| width | String, Number | '' | Set the emojis width |
| height | String, Number | '' | Set the emojis height |
### Events
It emits an `@input` event when you click an emoji, if `is-disabled` is set to `false`.
## License
```
The MIT License (MIT)
Copyright (c) 2019 Ivan Sotelo Vargas
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```