@interopio/home-ui-react

The @interopio/home-ui-react library offers React components and hooks for building a Home App for io.Connect Browser projects.

Installation

To install the @interopio/home-ui-react library in your project, execute the following command:

npm install @interopio/home-ui-react

Usage

The following example demonstrates initializing the @interopio/home-ui-react library with basic configuration:

import { IOConnectHome } from "@interopio/home-ui-react";
import "@interopio/workspaces-ui-react/dist/styles/workspaces.css";
import "@interopio/home-ui-react/src/index.css";

const getConfig = () => {
    // Platform configuration.
    const platformConfig = {
        browserPlatform: {
            factory: IOBrowserPlatform,
            config: {
                // Required license key.
                licenseKey: "my-license-key",
                // Workspaces App configuration.
                workspaces: {
                    src: "/",
                    isFrame: true
                }
            }
        }
    };

    return platformConfig;
};

// Configuration for the `<IOConnectHome />` component.
const config = {
    // Retrieve the platform configuration.
    getIOConnectConfig: getConfig
};

export function App() {
    return <IOConnectHome config={config} />
};

export default App;

For more details on using the library, see the official documentation of io.Connect Browser.