@interopio/iframes-api

Overview

The @interopio/iframes-api library provides a convenient API for starting apps in <iframe> elements.

Installation

To install the library, execute the following command:

npm install @interopio/iframes-api

Usage

The following examples demonstrate basic initialization of the @interopio/iframes-api library in io.Connect Browser projects.

ℹ️ For more details on using the @interopio/iframes-api library in io.Connect Browser projects, see the io.Connect Browser official documentation.

io.Connect Browser

Initializing the @interopio/iframes-api library in the Main app of an io.Connect Browser project:

import IOBrowserPlatform from "@interopio/browser-platform";
import IOIFrames from "@interopio/iframes-api";

const config = {
    licenseKey: "my-license-key",
    browser: {
        libraries: [IOIFrames],
    }
};

const { io } = await IOBrowserPlatform(config);

// Now you can access the IFrames API via `io.iframes`.

Initializing the @interopio/iframes-api library in a Browser Client app of an io.Connect Browser project:

import IOBrowser from "@interopio/browser";
import IOIFrames from "@interopio/iframes-api";

const config = {
    libraries: [IOIFrames],
};

const io = await IOBrowser(config);

// Now you can access the IFrames API via `io.iframes`.