@interopio/components-react

Overview

The @interopio/components-react library enables you to create your own Components App that will provide system apps for Glue42 Enterprise (Channel Selector, dialogs, notifications and more). The library allows complete customization of the Glue42 Enterprise system apps. The provided default components can be replaced or extended with your custom ones.

Customized Notification Panel for Glue42 Enterprise with custom header, footer and custom text on the buttons for clearing notifications:

Contents

• src/assets - contains common asset files;
• src/components - contains default components for shared UI elements like buttons, forms, icons and more;
• src/contexts - contains context provider components that are used across the Glue42 Enterprise system apps;
• src/features - contains the default components and hooks for all customizable Glue42 Enterprise system apps;
• src/hooks - contains hooks that are used across the Glue42 Enterprise system apps;

Prerequisites

For a Glue42 Enterprise project, you must have Glue42 Enterprise 3.20 or later.

Install

Components Library

To use the @interopio/components-react library in your project, execute the following command:

npm install @interopio/components-react

Storybook

Storybook is integrated into the project and the currently supported components are added to it. You can use it during development to test components and visualize states more easily.

To build Storybook:

npm run build-storybook

To run Storybook:

npm run storybook

Usage

The @interopio/components-react library provides default components and hooks which you can use to build your own Components App for Glue42 Enterprise by using, modifying or replacing the available components and functionalities.

The following example demonstrates how to provide customized components for the Channel Selector and the dialogs apps of Glue42 Enterprise:

import React, { Suspense, lazy } from "react";
import { RouterProvider, createHashRouter } from "react-router-dom";
import { DialogsProvider } from "@interopio/components-react";
// Using the default Glue42 themes.
import "@interopio/theme/dist/t42bootstrap.bundle.css";

// Your custom Channel Selector.
const CustomChannelSelector = lazy(() => import("./my-components/CustomChannelSelector"));

// Your custom dialog component.
const CustomDialog = () => {
    const Dialog = lazy(() => import("./my-components/CustomDialog"));

    return (
        <DialogsProvider>
            <Dialog />
        </DialogsProvider>
    );
};

const Loading = () => <div>Loading...</div>

// Routes used by Glue42 Enterprise for loading the system apps.
const routes = [
    {
        path: "channel-selector",
        element: <CustomChannelSelector />,
    },
    {
        path: "dialogs",
        element: <CustomDialog />
    }
];

// By default, Glue42 Enterprise loads its system apps from the file system.
// If your custom apps are hosted remotely, use `createBrowserRouter()` instead.
const router = createHashRouter(routes);

const App = () => {
    return (
        <Suspense fallback={<Loading />}>
            <RouterProvider router={router} />
        </Suspense>
    );
};

export default App;

To replace the default Components App of Glue42 Enterprise, you must build your app and place it in the %LocalAppData%\Tick42\GlueDesktop\assets\components folder.

Features

The @interopio/components-react library currently contains default components and hooks for the following Glue42 Enterprise system apps:

• Channel Selector - UI allowing the user to switch between the Glue42 Channels;
• Dialogs - app used for the system dialogs of Glue42 Enterprise and for showing dialogs programmatically;

License

MIT ©