AboutSupportDeveloper GuideVersion 22.3.18

Interface Dock3Config

Configuration for the Dock 3.0 provider.

interface Dock3Config {
    contentMenu?: ContentMenuEntry[];
    contentMenuTargetId?: string;
    defaultDockButtons?: Dock3Button[];
    favorites?: DockEntry[];
    icon?: string | TaskbarIcon;
    title?: string;
    uiConfig?: {
        contentMenu?: {
            enableBookmarking?: boolean;
        };
        hideDragHandle?: boolean;
        manageWorkspaces?: {
            newWindow?: {
                behavior: "view";
                viewOptions: Partial<ViewOptions>;
            };
        };
        moreMenu?: {
            quitPlatform?: {
                hidePlatformTitle?: boolean;
                skipDialog?: boolean;
            };
        };
        providerIconContentMenu?: boolean;
    };
}

Properties

contentMenu? contentMenuTargetId? defaultDockButtons? favorites? icon? title? uiConfig?

Properties

OptionalcontentMenu

contentMenu?: ContentMenuEntry[]

Content menu entries to be displayed in the dock

OptionalcontentMenuTargetId

contentMenuTargetId?: string

The id of the target element for the content menu.

OptionaldefaultDockButtons

defaultDockButtons?: Dock3Button[]

The config for the default dock buttons

Optionalfavorites

favorites?: DockEntry[]

Favorites to be displayed in the dock

Optionalicon

icon?: string | TaskbarIcon

icon URL for the dock provider.

Optionaltitle

title?: string

OptionaluiConfig

uiConfig?: {
    contentMenu?: {
        enableBookmarking?: boolean;
    };
    hideDragHandle?: boolean;
    manageWorkspaces?: {
        newWindow?: {
            behavior: "view";
            viewOptions: Partial<ViewOptions>;
        };
    };
    moreMenu?: {
        quitPlatform?: {
            hidePlatformTitle?: boolean;
            skipDialog?: boolean;
        };
    };
    providerIconContentMenu?: boolean;
}

The config for the companion dock ui

Type declaration

  • OptionalcontentMenu?: {
        enableBookmarking?: boolean;
    }
    • OptionalenableBookmarking?: boolean
  • OptionalhideDragHandle?: boolean

    By default drag handle is visible. Set this to true to hide the drag handle

  • OptionalmanageWorkspaces?: {
        newWindow?: {
            behavior: "view";
            viewOptions: Partial<ViewOptions>;
        };
    }
    • OptionalnewWindow?: {
          behavior: "view";
          viewOptions: Partial<ViewOptions>;
      }
      • behavior: "view"
      • viewOptions: Partial<ViewOptions>
  • OptionalmoreMenu?: {
        quitPlatform?: {
            hidePlatformTitle?: boolean;
            skipDialog?: boolean;
        };
    }

    Configuration for the dock more menu component.

    • OptionalquitPlatform?: {
          hidePlatformTitle?: boolean;
          skipDialog?: boolean;
      }
      • OptionalhidePlatformTitle?: boolean

        By default the quit button will contain platform title in its label. Set this to true to hide the platform title.

      • OptionalskipDialog?: boolean

        By default the quit button will show a quit confirmation dialog. Set this to true to skip the quit confirmation dialog.

  • OptionalproviderIconContentMenu?: boolean

    By default provider icon is just a drag region. Set this to true to convert it to content menu dropdown button.

Settings

On This Page

Properties