Skip to content
Snippets Groups Projects
Unverified Commit ef0be7ed authored by John Smith's avatar John Smith Committed by GitHub
Browse files

chore: add readme

parent 1a9dc4bf
Branches
Tags
No related merge requests found
# feedback
Feedback tool similar to Google's.
This is a very early alpha version, with a couple of [known issues](#known-issues), a complete rewrite. Should be more performant and less buggy (hopefully).
### Installing
```
npm i @ivoviz/feedback-js
```
### Usage
Import and create an instance of `Feedback`:
```ts
import { Feedback } from '@ivoviz/feedback.js';
.
.
.
const feedback = new Feedback();
feedback.open();
```
At the moment only two functions are exposed: `open` and `close`, although the latter shouldn't be needed.
Import the stylesheet:
```scss
@import "~@ivoviz/feedback.js/dist/lib/feedback.css";
```
There are two optional parameters, `FeedbackOptions` and `HTML2CanvasOptions`.
Currently, the only options supported by `FeedbackOptions` are:
`endpoint`: The url where you want to post the form data. The data will be sent as `json`:
```json
{
"description": "some text",
"screenshot": "base64 png"
}
```
`allowedTags` _(optional)_: A string array containing the name of the nodes you want to be able to be highlighted on mouseover.
You can read about `HTML2CanvasOptions` here: http://html2canvas.hertzen.com/configuration.
### Known issues
- Missing tooltips for buttons
- Missing loading animations while sending data or creating screenshot
- Missing icons
- Default texts should be written appropriately
- Not many options at the moment
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment