orxapi.plugins.popin

The popin plugin library for orxapi.

Getting Started

If you haven't used NodeJs before, be sure to have install the LTS version on your desktop ! Check your version with this command:

node -v
v10.15.1

Installation

npm install orxapi.plugins.popin --save

dependencies

• jQuery

Usage

This library is written in TypeScript, but you can use JavaScript.

Warning version 2 vs 1

This is the version 2, the initialization has changed and not compatible with version 1. See below for more detail.

Direct download

Download the script here and include it (unless you are packaging scripts somehow else):

Standalone: You can use the standalone version into bundle directory. The bundle contains a minimized version of the popin plugins with a Fuse Box Quantum API.

  <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.29/jquery.min.js"></script>
  <script type="text/javascript" src="../bundle/standalone/orxapi.plugins.popin.min.js"></script>

Min: If you want use other orxapi tools or plugins choose the min bundle and add external api.

  <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
  <script type="text/javascript" src="../bundle/min/api.js"></script>
  <script type="text/javascript" src="../bundle/min/orxapi.plugins.popin.min.js"></script>

  ...

Package Managers

Plugins popin supports npm under the name "orxapi.plugins.popin".

Check the default.html page to see some exemples and more informations

Methods

// Example initialize popin with some options
const popin = new Popin({
  width: "456px",
  popinClass: "is-popin-link",
  isVerticalAlign: true
});

close() - close the popin

Trigger

It is possible to call functions related to the actions on the popin plugin, with the triggers.

// Example add beforeClick trigger
popin.on("beforeClick", (link) => {
    // toto something
});

beforeClick(link)
@param link gives the link of the trigger popin link

afterClick(link)
@param link gives the link of the trigger popin link

open(link)
@param link gives the link of the trigger popin link

cancelButton(btn, popin)
@param btn Gives you the Jquery infos of this cancel button
@param popin gives you the info of the popin

acceptButton(btn, popin)
@param btn Gives you the Jquery infos of this cancel button
@param popin gives you the info of the popin

close(this)
@param this gives the popin instance

See docs for more information

This library was designed to work with ES 5+

TODO

• [x] Add multi instance compatibility
• [ ] Add examples
• [x] Add unit tests
• [x] Add functional tests
• [ ] Add documentation of the optional parameters
• [x] Improve the documentation