Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.5 KB

how-to-customize-the-bootstrapping-process.md

File metadata and controls

60 lines (41 loc) · 2.5 KB

ℹ️ OpenFin Workspace: OpenFin Workspace is a commercial product and this repo is for evaluation purposes (See LICENSE.MD). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin (see manifest). Please contact us if you would like to request a developer evaluation key or to discuss a production license.

<- Back to Table Of Contents

How To Customize The Bootstrapping Process

The bootstrapping process has a number of options to determine what the application should initialize on startup.

"bootstrap": {
    "home": true,
    "store": true,
    "dock": true,
    "notifications": true,
    "autoShow": ["home"]
}

The home, store, dock, and notifications options determine if a provider for each of those workspace components is registered. You can find more details on how to configure the providers for each of the component in their own sections.

A provider can be initialized without being displayed, so to automatically show the components on starting the app you can use the autoShow field. For example to show home and dock.

"bootstrap": {
    ...
    "autoShow": ["home", "dock"]
}

If you do not provide and autoShow property the first registered component in the order listed above will be used.

If the platform is already running and the user double clicks the desktop shortcut or shortcut in program files (or clicks on the platform icon in the dock if on a mac) then the components configured in "autoShow" will be shown.

Lifecycle

Lifecycle events are raised during the bootstrapping process.

After all of the workspace components have been initialized the after-bootstrap event is fired. When the application is closing down the before-quit event is fired.

If you don't want to display any of the built-in workspace components on startup you can set the config as follows:

"bootstrap": {
    ...
    "autoShow": ["none"]
}

You could then subscribe to the after-bootstrap event and launch your own view.

Source Reference

<- Back to Table Of Contents