An open API service indexing awesome lists of open source software.

https://github.com/electron-elements/send-feedback

send-feedback electron element - that could be used to get user feedback from electron app
https://github.com/electron-elements/send-feedback

custom-elements electron electron-elements

Last synced: 11 months ago
JSON representation

send-feedback electron element - that could be used to get user feedback from electron app

Awesome Lists containing this project

README

          

# send-feedback
[![npm](https://img.shields.io/npm/v/@electron-elements/send-feedback.svg?style=flat-square)](https://npmjs.org/package/@electron-elements/send-feedback)
[![Travis](https://img.shields.io/travis/electron-elements/send-feedback.svg?style=flat-square)](https://travis-ci.org/electron-elements/send-feedback)
[![Greenkeeper badge](https://img.shields.io/badge/Greenkeeper-enabled-blue.svg?style=flat-square)](https://greenkeeper.io/)

This [electron-element](https://github.com/electron-elements/electron-elements#electron-elements) can be used to
send feedback from an electron app to a website. Currently this works well for reporting
issue to github's issue tracker, or any website that could accept user input sent from the app

## Install

```bash
npm i --save @electron-elements/send-feedback
```

## Usage

Basic Usage:
```javascript
const SendFeedback = require('@electron-elements/send-feedback');
customElements.define('send-feedback', SendFeedback);

const sendFeedback = document.createElement('send-feedback');
document.body.appendChild(sendFeedback);
```

The default design of this element, right out of the box looks like:


send feedback design

The design of the element can be futher customized to fit your needs. See the [docs for usage and documentation to customize your send feedback element.](./docs/index.md)

Lastly, you need to configure how the send-feedback will report the feedback back to you. We support
reporting the feedback to email, github, or the brower. Additionally, you can also do a post request
to your server with the feedback. You can also add you own reporter if the the reporters we also provide
do not fit you needs. See the [reporter docs for more info](./docs/reporters.md).

## Changelog

See releases page it will contains all the [changelogs and info about new releases.](https://github.com/electron-elements/send-feedback/releases)

Do you have an electron element you want to add to this org?
If so follow this guide at [electron-elements repo](https://github.com/electron-elements/electron-elements/blob/master/guides/add-an-electron-element-to-org.md)