Bruit.io
BRuit is a User Issues Tool
Bruit is a webComponent for user review ...
Getting started
Table of Contents
usage
configuration
types
customization
about
install
npm install xxx --save
usage
<bruit-io> element to click </bruit-io>
with properties:
- config (required)
- .. (optional)
- ... (optional)
Integration frameworks: Angular ... ReacJS
BrtConfig
| attribute | type | about | required | default value |
|---|---|---|---|---|
| apiKey | string | your personal api key | yes | - |
| form | array of field | your personal api key | yes | - |
| closeModalOnSubmit | boolean | true for close modal directly on submit form and send feedback in background | no | false |
| durationBeforeClosing | number | time ( milliseconds ) before closing modal after sending | no | 1500 |
| labels | labels object | labels of the modal (title/button/...) | no | |
| logs | logs object | type and number of log to send | no | all - 100 lines |
| colors | colors object | modal theming | no | |
| apiUrl | string | if you want use you own api for send feedback | no | api.bruit.io |
If using Typescript : import { BrtConfig } from '@moventes/bruit';
BrtField
- description
- format
- default value
- import if using Typescript :
import { BrtConfig } from '@moventes/bruit';
BrtLabels
BrtColors
BrtLogLevels
Contributing
xxx
Having troubles ?
- issues Github
- stackoverflow