Skip to content

Update the readme #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
josephine-njooi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update the readme #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ document.getElementById("languageButton").addEventListener("click", (e) => {
| `show-comment-disclaimer` | A boolean that can be used to determine whether disclaimer text should be displayed in the feedback widget when users are prompted to submit a comment. This disclaimer will direct users to a separate contact form link if they have specific questions. | `"true"` or `"false"` | `"true"` | N/A | N/A |
| `skip-email-step` | A boolean that can be used to determine whether to prompt the user to enter their email to join a testing group after submitting a comment. | `"true"` or `"false"` | `"false"` | N/A | N/A |

### Backend

This frontend component is meant for use on New Jersey pages, and is hardcoded to sent feedback to a running instance of the [Feedback Widget API](https://github.com/newjersey/feedback-api/) hosted by the Platform Team. To access the feedback collected by the frontend widget for, please contact the Platform Team.

## How to add this to your website

### With Node/NPM
Expand All @@ -60,7 +64,7 @@ document.getElementById("languageButton").addEventListener("click", (e) => {
import "@newjersey/feedback-widget/feedback-widget.min.js";
```

3. If using TypeScript, add the following type definition to the same file you imported
3. If using TypeScript, add the following type definition to the file where you added the import

```typescript
declare global {
Expand Down