@openfin/workspace-platform
    TypeScript icon, indicating that this package has built-in type declarations

    5.0.0 • Public • Published

    Workspace Platform API

    The Workspace Platform Client APIs allow integrators to create their own Workspace platforms.

    This API is experimental.

    Installation

    Run npm i -E @openfin/workspace-platform.

    Workspace Platform API documentation

    Code examples

    Initilaize a Workspace Platform

    import * as WorkspacePlatform from '@openfin/workspace-platform';
    
    const customThemes: WorkspacePlatform.CustomThemes = [
        {
            label: "OpenFin's Custom Theme",
            palette: {
                brandPrimary: #F51F63, // required
                brandSecondary: #1FF58A’, // required
                backgroundPrimary: #F8E71C’, // required - hex, rgb/rgba, hsl/hsla only - no string colors: ‘red’
                background2: #7D808A’ // any of the optional colors
            }
        }
    ];
    
    const overrideCallback: WorkspacePlatform.BrowserOverrideCallback = async (WorkspacePlatformProvider) => {
        class Override extends WorkspacePlatformProvider {
            async quit(payload, callerIdentity) {
                return super.quit(payload, callerIdentity);
            }
        }
        return new Override();
    };
    
    await WorkspacePlatform.init({
        browser: { overrideCallback },
        theme: customThemes
    });

    Install

    npm i @openfin/workspace-platform

    DownloadsWeekly Downloads

    160

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    269 kB

    Total Files

    80

    Last publish

    Collaborators

    • eugeneross-openfin
    • adartulloch
    • imansuri
    • arvidh97
    • manamiueda
    • sakibahmad
    • shahossain
    • daveashton
    • openfinbrandon
    • richardgutan
    • pierrebaize
    • noyangunday
    • michaelmcoates
    • johnmandia-openfin
    • rdepena
    • tgoc99
    • wenjunche
    • harsimran.openfin.singh
    • luiemilio
    • patopenfin
    • tarsillon1
    • licui3936
    • rp-openfin
    • ljopenfin
    • connormccafferty
    • adam.saland
    • openfin-ci
    • chrishobsonexpero
    • vacunafin
    • richbrowne-openfin
    • nedwardsof
    • lomteslie
    • doomsauce
    • azizyok
    • openfin-gavin
    • themetaterran
    • dewin.pena
    • oblarg
    • yongji.chen
    • tony.fong