awezapopup v3.2.1

Aweza Popup

A popup for the Aweza platform based on tippy.js

Install

Yarn

yarn add awezapopup

NPM

npm install --save awezapopup

CDN

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/awezapopup@3.1.7/dist/aweza-popup.min.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.10.0/katex.min.css"/>
<script src="https://cdn.jsdelivr.net/npm/awezapopup@3.1.7/dist/aweza-popup.min.js"></script>

Usage

AwezaPopup(options)

Options

• dataUrl: The URL of the Aweza API (optional)
• headers: An object containing custom request headers. Required for Authentication.
• preferLang: The two digit ISO 639-1 language code of the prefered language to translate to.

Examples

Using modules + SASS

import AwezaPopup from 'awezapopup';

AwezaPopup({
  headers: {
    "AWEZA-KEY": 'a9e4........d302',
    "AWEZA-SECRET": '07ecf........b375'
  }
})

@import "~awezapopup/dist/aweza-popup.min.css";
@import "~katex/dist/katex.min.css";

Using CDN

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/awezapopup@3.1.7/dist/aweza-popup.min.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.10.0/katex.min.css"/>
<script src="https://cdn.jsdelivr.net/npm/awezapopup@3.1.7/dist/aweza-popup.min.js"></script>
<script>
    window.AwezaPopup({
      headers: {
        "AWEZA-KEY": 'a9e4........d302',
        "AWEZA-SECRET": '07ecf........b375'
      }
    })
</script>

Awezification

Wrap the target in a span with a data-aweza attribute where the value is the ID of the term

<span data-aweza="3">Road</span>

Development

To run the file watchers and a php dev server, use the script provided

./dev.sh