Commands
Commands are instructions issued by the parent window to the iframed flipbook. Commands can be invoked by calling magic methods, which can be accessed directly from the API instance.
Commands are issued from the parent window (your website) to the JavaScript API. The API then relays the command via
window.postMessage() to the iframed flipbook.It is possible to dictate how the iframed flipbook should handle events when they have been triggered. The method accepts a single argument that is an object containing the following keys, which references events that the v2 Flipbook API listens to:
The keys should contain an object of the following format:
{ preventDefault: <boolean> }, where <boolean> is true or false. When preventDefault is set to true, the flipbook will perform the default action associated with each event. If set to false, the default action will be skipped.Event | Default action taking place in the flipbook |
|---|---|
Opens the shop basket | |
Adds the item to the shop basket.
Triggered by any enrichment that adds a shop item (e.g. shop variant menu). | |
Adds the item to the shop basket.
Triggered by clicking on an enrichment with shop item action. |
An example use:
// Disable opening of shop basket AND page element click on shop items
iPaperAPI.updateEventSettings({
onBasketClick: { preventDefault: true },
onPageElementClick: { preventDefault: true }
});
Navigate to a specific page: the page number is to be provided as the one and only argument of the function. For example:
iPaperAPI.goToPage(4);
Go to the previous spread (if flipbook has a spread-based layout), or the previous page (if flipbook has a page-based layout). This method accepts no arguments:
iPaperAPI.goToPreviousPage();
Go to the next spread (if flipbook has a spread-based layout), or the next page (if flipbook has a page-based layout). This method accepts no arguments:
iPaperAPI.goToNextPage();
Programmatically adds a custom item to the basket. This method accepts a single argument, consisting of properties of the shop item entity.
Property | Type | Description |
|---|---|---|
title | string | Shop item title |
description | string | Shop item description |
productID | string | Shop item product ID |
originPage | number | Page number where the shop item is located |
price | number | Shop item price |
quantity | number | Number of items added |
Example use:
iPaperAPI.addItem({
title: 'My product',
description: 'Product description',
productID: 'PROD-25B',
price: '29.95',
originPage: 6,
quantity: 1
});
If you are accustomed to the
.trigger() regime (such as that implemented in JQuery), you can also use it as such:iPaperAPI.trigger('goToPage', 4);
Last modified 9mo ago