AboutSupportDeveloper GuideVersion 20.1.5

Interface DockProviderConfigWithIdentity

Configuration for the Dock provider.

Hierarchy

Properties

buttons? clientAPIVersion? disableUserRearrangement? icon id taskbarIconGroup? title workspaceComponents?

Properties

Optional buttons

buttons?: DockButton[]

Buttons for platform-specific custom actions to display on the Dock.

Optional clientAPIVersion

clientAPIVersion?: string

version of client SDK, set by the API

Optional disableUserRearrangement

disableUserRearrangement?: boolean

If true, the user will not be able to rearrange the buttons on the Dock.

Default

false

icon

icon: string | TaskbarIcon

Icon for the provider.

id

id: string

Unique identifier for the provider.

Remarks

A non-zero length string.

Optional taskbarIconGroup

taskbarIconGroup?: string

The group name to group the taskbar icon with.

title

title: string

A UI friendly title for the provider platform.

Optional workspaceComponents

workspaceComponents?: WorkspaceComponentButtonOptions | WorkspaceButtonsConfig

Controls the visibility of buttons for workspace components on the Dock. All components are visible by default, but you can hide any of them.

Default

  • All components are visible. ['switchWorkspace', 'home', 'notifications', 'store']

Settings

Theme

On This Page