AboutSupportDeveloper GuideVersion 22.3.18

Interface WorkspaceComponentButtonOptions

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

Deprecated

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

Example: Hide all Workspace component buttons in the Dock UI.

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

Properties

hideHomeButton? hideNotificationsButton? hideStorefrontButton? hideWorkspacesButton?

Properties

OptionalhideHomeButton

hideHomeButton?: boolean

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

Default

false.

OptionalhideNotificationsButton

hideNotificationsButton?: boolean

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

Default

false.

OptionalhideStorefrontButton

hideStorefrontButton?: boolean

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

Default

false.

OptionalhideWorkspacesButton

hideWorkspacesButton?: boolean

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

Default

false.

Settings

On This Page

Properties