Sharing

Events

onShare

This subscription will trigger whenever a user clicks the share icon.

Note:

Once you attach your listener to the "onShare" event, iPaper's native share functionality (copying the URL to clipboard on click) will be disabled. You will have to handle sharing using your own logic.

You can revert back to using iPaper's native sharing by simply unsubscribing from the "onShare" event.

instance.share.onShare((sharePayload) => {
    // YOUR CODE HERE
});

The share payload contains all properties that can be used to link back to the Flipbook and open it on the page where the share event was invoked:

Property	Type	Description
baseUrl	string	The base URL of the shared Flipbook
url	string	The full URL of the shared Flipbook which includes the page number
page	number	The number of the page where the share event was triggered