@bruit/component

Bruit.io

BRuit is a User Issues Tool

Bruit is a webComponent for user review ...

Getting started

start on bruit.io

Table of Contents

Install
Usage
Configuration
    BrtConfig
    BrtField
    BrtLabels
    BrtColors
    BrtLogLevels
    BrtData
    BrtError
Contributing
Having troubles ?

Install

npm install @moventes/bruit --save

or

<script src="https://unpkg.com/@moventes/bruit/dist/bruit.js"></script>

Usage

<bruit-io> element to click </bruit-io>

with properties :

• config (required)
• data (optional)
• dataFn (optional)
• onError (event) (optional)

Integration frameworks :

Configuration

bruit-io webComponent has a config property.

config property take a BrtConfig value.

BrtConfig

BrtConfig is a JSON for configure and customize bruit component

attribute	type	description	required	default value
apiKey	string	your personal api key	yes	-
form	array	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	BrtLabels	labels of the modal (title/button/...)	no	see
logLevels	BrtLogLevels	type and number of log to send	no	see
maxLogLines	number	number of log to send	no	100
colors	BrtColors	modal theming	no	see
apiUrl	string	if you want use your own api for send feedback	no	https://api.bruit.io/feedback

• import if using Typescript :

import { BrtConfig } from '@moventes/bruit';

BrtField

• description

• format

• default value :

• import if using Typescript :

import { BrtField } from '@moventes/bruit';

BrtLabels

• default value :

{
  "title": "bruit.io",
  "introduction": "send a feedback",
  "button": "send"
}

• import if using Typescript :

import { BrtLabels } from '@moventes/bruit';

BrtColors

• default value :

{
  "header": "#2D8297",
  "body": "#eee",
  "background": "#444444ee",
  "errors": "#c31313",
  "focus": "#1f5a69"
}

• import if using Typescript :

import { BrtColors } from '@moventes/bruit';

BrtLogLevels

• default value :

{
  "log": true,
  "debug": true,
  "info": true,
  "warn": true,
  "error": true,
  "network": true,
  "click": true,
  "url": true
}

• import if using Typescript :

import { BrtLogLevels } from '@moventes/bruit';

BrtData

• import if using Typescript :

import { BrtData } from '@moventes/bruit';

BrtError

• import if using Typescript :

import { BrtError } from '@moventes/bruit';

Integration frameworks

HTML

Angular

React

Ember

Contributing

xxx

Having troubles ?

• issues Github
• stackoverflow