instabug / web-sdk-sample Goto Github PK

View Code? Open in Web Editor NEW

9.0 47.0 3.0 131 KB

Bug reporting tool for web

Home Page: https://instabug.com/

CSS 12.90% HTML 87.10%

instabug javascript-library bug-reporting bug-reporter

web-sdk-sample's Introduction

Instabug web SDK 1.2.1-beta

Overview

Instabug web sdk is a javascript library provides an easy way to report bugs from your website or webapp.

To use the sdk you need to have application_token, you can get it from your Instabug Dashboard

Installation

Requirements

Instabug Web SDK requires no special requirements, and has no dependecies on other liberaries or frameworks, and has been tested in all modern browsers with LocalStorage capability

Manual Installation

You can include instabug web sdk to your website just copy the below lines into the end of your page <body> tag

<script src='https://s3.amazonaws.com/instabug-pro/sdk_releases/instabugsdk-1.2.1-beta.min.js'></script>

`bower` installation (recommended)

You can install the SDK using

bower install instabug-sdk --save

`npm` installation

You can install the SDK using

npm install instabug-sdk --save

Initialize the SDK

After including the sdk js file, you can start it by invoke the .init() method and pass the application token as parameter

<script>
  ibgSdk.init({
     token: <INSTABUG_APP_TOKEN>
  });
</script>

API Refrence

`.init(options)`

the init function is used to used to initialize the SDK and render the report bug button.

Parameters

options: Object required - pass the application token

`.disable()`

used to hide the report bug button

`.enable()`

used to show the report bug button

`.invoke()`

show the report bug view without clicking on the report bug button,

You can use this function to start the reporting bug process programmatically from your own script, By run ibgSdk.invoke() after initialize the sdk

`.dismiss()`

cancel annotations and close all instabug sdk windows

web-sdk-sample's People

Contributors

Stargazers

Watchers

Forkers

sipike nrjain

web-sdk-sample's Issues

need to know where my console.log come from

i use console.log a lot so i can figure out if the app works as expected while development, since i enabled instabug for web my logs in the console doesn't tell me from what file it come from

This with instabug enabled

This when instabug disabled (and that what i need to have while enabling instabug)

Support webpack, ES6, babel builds

Hi,

I tried importing via:

yarn add instabug-sdk

But then I can't import it because you're only supporting direct browser fetches.

The way I got around this was to import it into index.html which is a bit messy because we keep that file light. Then use window.ibgSdk.init({...})` to make it work, which is fine temporarily but you guys only have the min files up so can you guys support imports?

Our stack is yarn + VueJS + webpack 3...

If you support in our main.js

import 'ibgSdk` from 'instabug-sdk`

Then I'm sure not just VueJS, but also Angular and React people would very much appreciate it!

Thanks

does not work on smaller screens

ibgSdk.invoke() does nothing in smaller screen resolutions.

The SSL certificate used to load resources from https://api.instabug.com will be distrusted in M70

FYI, getting this warning in Chrome 63.0.3239.132

The SSL certificate used to load resources from https://api.instabug.com will be distrusted in M70. Once distrusted, users will be prevented from loading these resources. See https://g.co/chrome/symantecpkicerts for more information.

instabug is not sending automatic report on error in agnular appications

Hello ! I integrated instabug in my angular app. It works well by using form but it does not automatically detect error in console and does not send automatic reports of errors.

How can we do this automatically?

Request header field Content-Type is not allowed by Access-Control-Allow-Headers

Failed to load https://api.instabug.com/api/sdk/v3/features?application_token=token

Request header field Content-Type is not allowed by Access-Control-Allow-Headers in preflight response.

It worked 3 days ago

Console error in react-app

When i use ibgSdk.enable() in my react web application i had this error in the console but everything still work fine

instabugsdk-1.2.1-beta.min.js:1  Uncaught TypeError: Cannot read property 'classList' of null
    at Object.removeClass (instabugsdk-1.2.1-beta.min.js:1)
    at Object.r [as enable] (instabugsdk-1.2.1-beta.min.js:1)
    at (index):64

requires extension for screenshot

requiring a browser extension to take screenshots is a bad user experience. consider that the user is already running into a bug when doing this. adding an extension on top of this is a barrier

test

this is a test issue