Giter VIP home page Giter VIP logo

web-feedback's Introduction

Web Feedback

Helps in better and quicker user feedback for native web components, with ability to capture a screenshot with a single click and submitting feedback component for javascript projects.

Instillation

npm i @raralabs/web-feedback

Usages

import { Snipping } from '@raralabs/web-feedback';
import '@raralabs/web-feedback/dist/css/style.css'; // stylesheet

let snap = new Snipping({
  buttonLabel: 'Send Feedback',
  initialMarkMode: 'mark',
  fileName: 'feedbackScreenshot.png'
  /** other configs **/
});

/*
 * initialize on app start
 * it also return callback with screenshot data as
 * image : image as file type
 * base64Image: image as base64
 */
snap.init((data) => {
  const { image, base64Image } = data;
});

Configs

Common config you may want to specify include:

  • button : boolean - enable or disable floating snapper button
  • buttonLabel: string - text label for floating snapper button
  • initialMarkMode: enum[ 'mark' | 'censored' | 'text' ] - Initial mark mode for the snipper
  • buttonPostion: enum[ 'left' | 'right' ] - Position of floating snapper button
  • fileName: string - file name for the screenshot

Contributing

Want to contribute? Please check the guidelines Contributing.md. All PRs and issues are welcome.

web-feedback's People

Contributors

mrsudarshanrai avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.