OpenFin Workspace API
    Preparing search index...

    Interface WorkspaceComponentButtonOptions

    Allows you to hide buttons for different Workspace components in the Dock UI. By default, all components are shown.

    Use WorkspaceButtonsConfig instead. To migrate to the new configuration, any buttons that you wish to hide should be omitted from the buttons array.

    const workspaceComponentButtonOptions: WorkspaceComponentButtonOptions = {
        hideHomeButton: true,
        hideWorkspacesButton: true,
        hideNotificationsButton: true,
        hideStorefrontButton: true
    }
    interface WorkspaceComponentButtonOptions {
        hideHomeButton?: boolean;
        hideNotificationsButton?: boolean;
        hideStorefrontButton?: boolean;
        hideWorkspacesButton?: boolean;
    }
    Index
    hideHomeButton? hideNotificationsButton? hideStorefrontButton? hideWorkspacesButton?
    hideHomeButton?: boolean

    Set to true to hide the Home button from the Dock UI.

    false.
    hideNotificationsButton?: boolean

    Set to true to hide the Notifications button from the Dock UI.

    false.
    hideStorefrontButton?: boolean

    Set to true to hide the Storefront button from the Dock UI.

    false.
    hideWorkspacesButton?: boolean

    Set to true to hide the Workspaces button from the Dock UI.

    false.

    Settings

    On This Page
    Properties