AboutSupportDeveloper GuideVersion 17.2.13

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
}

Hierarchy

  • WorkspaceComponentButtonOptions

Properties

hideHomeButton?: boolean

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

Default

false.
hideNotificationsButton?: boolean

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

Default

false.
hideStorefrontButton?: boolean

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

Default

false.
hideWorkspacesButton?: boolean

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

Default

false.