0.1.0 • Published 7 months ago

@blaze/customer-feedback v0.1.0

Weekly downloads
104
License
MIT
Repository
github
Last release
7 months ago

Customer Feedback

A framework free and themeable web component that captures an annotated screenshot and description of a web page.

Getting Started

Vanilla HTML

Add the following to the head of the document.

<script
  src="https://cdn.jsdelivr.net/npm/@blaze/customer-feedback/dist/customer-feedback/customer-feedback.esm.js"
  type="module"
></script>
<script
  src="https://cdn.jsdelivr.net/npm/@blaze/customer-feedback/dist/customer-feedback/customer-feedback.js"
  nomodule
></script>

Place this web component at the bottom of the body element:

<customer-feedback></customer-feedback>

Under the hood customer-feedback uses it's position in HTML and a high z-index to ensure it remains on top of the content of your web page, however you may still experience layering issues if you have similar code that overlays all content.

React

If you'd like to use this component inside a React app firstly install the package:

npm i @blaze/customer-feedback

then add the following code to the start up routine (usually index.js):

import { applyPolyfills, defineCustomElements } from 'customer-feedback/loader';

//...

await applyPolyfills();
defineCustomElements();

Further reading on integrating in other frameworks

https://stenciljs.com/docs/overview

Usage

Attributes

header - the header for the modal

intro - the text that appears above the description box

<customer-feedback header="..." intro="..."></customer-feedback>

Methods

show() - opens the modal

close() - resets the data and closes the modal

await document.querySelector('customer-feedback').show();

Events

feedback - event emitted with the description and screenshot data

document.querySelector('customer-feedback').addEventListener('feedback', function (e) {
  console.log(e.detail);
});

Run Locally

Install nvm, the rest is simple. Copy and paste the following into a terminal and press enter.

git clone git@github.com:BlazeSoftware/customer-feedback.git
cd customer-feedback
nvm use
npm i
npm start

It's as simple as that.

Contributing

Get it running locally, make changes and raise a PR 🔥

0.1.0

7 months ago

0.0.2

7 months ago

0.0.1

7 months ago