Optional
buttonsButtons for platform-specific custom actions to display on the Dock.
Optional
clientAPIVersionversion of client SDK, set by the API
Optional
disableIf true, the user will not be able to rearrange the buttons on the Dock.
false
Icon for the provider.
Unique identifier for the provider.
Optional
skipBy default, the Dock will save the user's configuration and restore it on the next launch.
If true, the currently stored configuration will be ignored and the Dock will use the configuration provided by the provider.
false
A UI friendly title for the provider platform.
Optional
workspaceControls the visibility of buttons for workspace components on the Dock. All components are visible by default, but you can hide any of them.
['switchWorkspace', 'home', 'notifications', 'store']
Sample DockProvider definition.
The icon for
DockProvider
must be in a raster image format. An SVG is not processed.Import required dependencies.
Create provider object to pass to the static
register
function of theDock
type.When a Dock button is clicked, the
action
object is passed to thecustomActions
function defined as defined in the Workspace Platforminit
function.Initialize your Workspace Platform with
customActions
to be invoked by dock dropdown.Register Dock
provider
object.Show Dock.