Skip to main content

Modals

@interopio/modals-api 4.4.0

The @interopio/modals-api library provides a way to create and manage dialogs and alerts within the io.Connect platforms.

The Modals API is accessible via the io.modals object.

Available since io.Connect Desktop 9.9 and io.Connect Browser 4.0.

The following example demonstrates enabling the Modals API in an io.Connect Desktop app:

import IODesktop from "@interopio/desktop";
import IOModals from "@interopio/modals-api";

const initializeIOConnect = async () => {
    // Initializing the Modals API.
    const initOptions = {
        libraries: [IOModals],
    };

    const io = await IODesktop(initOptions);

    const alertOptions = {
        variant: "success",
        text: "Successfully initialized the Modals API!",
    };

    await io.modals.alerts.request(alertOptions);
};

initializeIOConnect().catch(console.error);

The following example demonstrates enabling the Modals API in an io.Connect Browser app:

import IOBrowser from "@interopio/browser";
import IOModals from "@interopio/modals-api";

const initializeIOConnect = async () => {
    // Initializing the Modals API.
    const initOptions = {
        libraries: [IOModals],
    };

    const io = await IOBrowser(initOptions);

    const alertOptions = {
        variant: "success",
        text: "Successfully initialized the Modals API!",
    };

    await io.modals.alerts.request(alertOptions);
};

initializeIOConnect().catch(console.error);