OpenFin Workspace API
    Preparing search index...

    Interface DockProviderConfigWithIdentity

    Configuration for the Dock provider.

    interface DockProviderConfigWithIdentity {
        buttons?: DockButton[];
        clientAPIVersion?: string;
        disableUserRearrangement?: boolean;
        icon: string | TaskbarIcon;
        id: string;
        taskbarIconGroup?: string;
        title: string;
        workspaceComponents?:
            | WorkspaceComponentButtonOptions
            | WorkspaceButtonsConfig;
    }

    Hierarchy (View Summary)

    Index
    buttons? clientAPIVersion? disableUserRearrangement? icon id taskbarIconGroup? title workspaceComponents?
    buttons?: DockButton[]

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

    clientAPIVersion?: string

    version of client SDK, set by the API

    disableUserRearrangement?: boolean

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

    false
    icon: string | TaskbarIcon

    Icon for the provider.

    id: string

    Unique identifier for the provider.

    A non-zero length string.

    taskbarIconGroup?: string

    The group name to group the taskbar icon with.

    title: string

    A UI friendly title for the provider platform.

    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.

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

    Settings

    On This Page
    Properties