The TypeScript popin plugin library for orxapi
shell
node -v
v10.15.1
`
Installation
`shell
npm install orxapi.plugins.popin --save
`
$3
* 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.
$3
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.
`html
`
Min: If you want use other orxapi tools or plugins choose the min bundle and add external api.
`html
...
`
$3
Plugins popin supports npm under the name "orxapi.plugins.popin".
Check the default.html page to see some exemples and more informations
Methods
`Javascript
// Example initialize popin with some options
const popin = new Popin({
width: "456px",
popinClass: "is-popin-link",
isVerticalAlign: true
});
`
close() - close the popin
$3
It is possible to call functions related to the actions on the popin plugin,
with the triggers.
`Javascript
// 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