You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+68-12
Original file line number
Diff line number
Diff line change
@@ -5,25 +5,37 @@
5
5
6
6
# Feeder: feeder-react-feedback
7
7
8
-
Embeddable Feedback React component hooked up to an [admin dashboard](http://feeder-admin-client.now.sh/). The fastest way to start collecting feedback across your React projects! ⚡
8
+

9
+
10
+
Embeddable Feedback React component hooked up to an [admin dashboard](http://feeder.sh/). The fastest way to start collecting feedback across your React projects! ⚡
-[What is the Admin Dashboard?](#what-is-the-admin-dashboard)
35
+
-[Will this work with SSR React frameworks?](#will-this-work-with-ssr-react-frameworks)
36
+
-[Tips](#tips)
37
+
-[Default Email Value](#default-email-value)
38
+
-[Subprojects](#subprojects)
27
39
28
40
## Features
29
41
@@ -54,7 +66,7 @@ class App extends Component {
54
66
}
55
67
```
56
68
57
-
After importing the component, create an Account/Project on the [admin dashboard](http://feeder-admin-client.now.sh/) and pass in your project's `projectId` as a prop to the `Feedback` component.
69
+
After importing the component, create an Account/Project on the [admin dashboard](http://feeder.sh/) and pass in your project's `projectId` as a prop to the `Feedback` component.
58
70
59
71
## Props
60
72
@@ -74,11 +86,55 @@ After importing the component, create an Account/Project on the [admin dashboard
74
86
| textColor | Text color - can accept any value that is valid for the CSS3 `color` property (hex, rgba, etc.) | string | no | "#000000" |
75
87
| zIndex | z-index of Modal and Trigger Button | string | no | "100000000" |
76
88
89
+
---
90
+
91
+
## API
92
+
93
+
If you want to render your own Feedback form/modal, but still have access to the Feeder monitoring system/admin dashboard, you can send a `POST` request to the Feeder API directly.
94
+
95
+
### URL & Endpoint
96
+
97
+
Send a `POST` request to Feeder's "create feedback" endpoint and make sure to pass in all required endpoint fields.
The following should be passed as an object in the post request to `/feedback/create`. Requests without all the required fields will fail.
104
+
105
+
-`projectId`: required (create an account on Feeder, create a project, and copy your projectId)
106
+
-`feedbackMsg`: optional (but no reason not to have this!)
107
+
-`feedbackType`: optional
108
+
-`feedbackEmail`: optional
109
+
-`subProject`: optional
110
+
-`feedbackSrc`: optional
111
+
112
+
## Custom Styling
113
+
114
+
You can override any CSS classes in the Feedback component. Below is a list of CSS classes used in the component, but the easiest way to find specific class names and styles to override is to use the browser tools and inspect the element you are targeting.
115
+
116
+
-`frf-feedback-container`: wrapper container
117
+
-`frf-trigger-button`: main trigger button that opens up modal
118
+
-`frf-feedback-icon-open`: trigger button icon when modal is open
119
+
-`frf-feedback-icon`: trigger button icon when modal is closed
120
+
-`frf-dialog`: css transition class for fade in of modal
121
+
-`frf-modal-container`: modal content
122
+
-`frf-modal-content-container`: form content
123
+
-`frf-modal-input-group`: form input label + input
124
+
-`frf-modal-label`: form input label
125
+
-`frf-modal-input`: form input
126
+
-`frf-modal-feedback-types`: group of feedback types
127
+
-`frf-modal-feedback-type`: individual feedback type
128
+
-`frf-modal-feedback-selected`: selected feedback type
129
+
-`frf-modal-button`: main submit button
130
+
-`frf-modal-button-loader`: loading indicator when submitted
131
+
-`frf-water`: "Feedback powered by Feeder.sh" watermark (if you want to hide this, just target this selector and add a `display: none`)
132
+
77
133
## FAQs
78
134
79
135
### What is the Admin Dashboard?
80
136
81
-
The [admin dashboard](http://feeder-admin-client.now.sh/) is where all the feedback for each project is collected. Each project has a unique id that is passed as a prop to the `<Feedback/>` component.
137
+
The [admin dashboard](http://feeder.sh/) is where all the feedback for each project is collected. Each project has a unique id that is passed as a prop to the `<Feedback/>` component.
82
138
83
139
You can add collaborators to each project as well, which will give them the ability to view all the feedback for a given project. The admin dashboard also allows users to export all project-specific data to CSV.
0 commit comments