Skip to content

ernesto/glowy-plugin

 
 

Repository files navigation

CircleCI Bundlephobia JSDelivr

Glowy Plugin

Add Glowy to your website using our plugin

Installation

Script tag

Via jsDelivr

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@glowy/plugin@latest/dist/glowy-plugin.min.js" async defer></script>

Via unpkg

<script type="text/javascript" src="https://unpkg.com/@glowy/plugin/dist/glowy-plugin.min.js" async defer></script>

NPM

$ npm i -S @glowy/plugin
import glowy from '@glowy/plugin'

Getting started

Once Glowy Plugin is installed it will detect the presence of any Glowy Frame div in the DOM so you just have to add the div wherever you want the Glowy Frame to appear.

<div class="glowy-frame" [option-attributes]></div>

Option attributes

The option attributes are data-* attributes of which values will be passed to the Glowy Frame.

The possible attributes are:

Attribute Type Required? Default Description
data-provider string (uuid) true The Provider ID of which Glowy will retrieve merchant information
data-media desktop or mobile false desktop The media in which the frame is being inserted
data-screen list or my-appointments false list The screen which the frame will start at
data-token string (uuid) true The authentication token to identify the user
data-back-button-label string false Início The back button label
data-back-button-url string (url) false The back button URL
data-scroll-offset number false Offset difference when scroll automatically

Packages

No packages published

Languages

  • TypeScript 80.3%
  • JavaScript 14.5%
  • HTML 5.2%