Package Exports
- react-slack-feedback
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-slack-feedback) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
React Slack Feedback
React component for gathering user feedback to send to slack.
Usage
Install via NPM:
npm install react-slack-feedback
To use the component, import it and render in your app's global component, or individual components (if you don't want it on every page).
NOTE Your Slack Webhook URL should never be available on the front end. For this reason you must have a server which sends the request to slack. This component will produce the JSON object to send to Slack but it won't send the request for you.
import SlackFeedback from 'react-slack-feedback';
<SlackFeedback
// required
channel="#general"
// NOTE: The `onSubmit` method is called with the SlackFeedback context which
// allows you to call `this.sent()` in the sendToSlack method. If you use
// `payload => sendToSlack(payload)` or `sendToSlack.bind(this)` then you must
// use a ref to call the sent method. i.e `this.refs.SlackFeedback.sent();`
onSubmit={sendToSlack}
onImageUpload={uploadImage}
disabled={true} // completely disable the component (default = false)
user="Users Name" // The logged in user (default = "Unknown User")
emoji="🐛" // default = :speaking_head_in_silhouette:
/>
/**
* Send the Slack message to your server
* @param {Object} payload
* @return {null}
*/
function sendToSlack(payload) {
$.post('/api/slack', {
data: payload
}).then(res => {
// The `onSubmit` prop function is called with the SlackFeedback component
// context (this.props.onSubmit.call(this, payload)), meaning the component
// methods are available from this function. You should call the `sent`
// method if the request was successfully sent to Slack.
this.sent();
}, this.error);
}
/**
* Upload image to server
* @method uploadImage
* @param {File} image
* @return {null}
*/
function uploadImage(image) {
var form = new FormData();
form.append('image', image);
$.post('/api/upload', { data: form })
.then(
// It is important that you call the `imageUploaded` method or
// the component will load indefinitely.
//
// If you've called the `uploadImage` function with `image => uploadImage(image)`,
// you'll have to use a ref on the SlackFeedback component to access the
// 'imageUploaded' and 'error' methods
res => this.imageUploaded(),
err => this.error(err)
);
}
Props
Prop | Type | Default | Required | Description |
---|---|---|---|---|
channel | string | required | The Slack channel to send messages. Note: All slack channels are lowercase. The string should be identical to the channel name e.g '#feedback' | |
onSubmit | function | required | A JSON payload object will be returned when the user submits the form. | |
onImageUpload | function | Method that will be called with a file argument | ||
user | string | "Unknown User" | The logged in user's name (if applicable) | |
emoji | string | 🗣 | The emoji that will show in place of the users avatar on Slack | |
buttonText | string | "Slack Feedback" | The text for the trigger button |
Running Locally
To run this module locally:
- Clone the repo:
git clone https://github.com/markmur/react-slack-feedback.git
- Install the node modules
npm install
- Create an ENV file with your
WEBHOOK_URL
./env.js
module.exports = {
WEBHOOK_URL: 'YOUR_SLACK_WEBHOOK_URL'
};
- Run the
Procfile
withforeman
:
nf start
This will start the webpack-dev-server
and an express
backend server.
The component will be available at http://localhost:3000