OpenFin Workspace Platform API
    Preparing search index...

    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: OpenFin.PlatformViewCreationOptions;
                };
            };
            moreMenu?: {
                moreMenuCustomOption?: {
                    label: string;
                    options: BaseCustomDropdownItem<any>[];
                };
                quitPlatform?: { hidePlatformTitle?: boolean; skipDialog?: boolean };
            };
            providerIconContentMenu?: boolean;
        };
    }
    Index
    contentMenu? contentMenuTargetId? defaultDockButtons? favorites? icon? title? uiConfig?
    contentMenu?: ContentMenuEntry[]

    Content menu entries to be displayed in the dock

    contentMenuTargetId?: string

    The id of the target element for the content menu.

    defaultDockButtons?: Dock3Button[]

    The config for the default dock buttons

    favorites?: DockEntry[]

    Favorites to be displayed in the dock

    icon?: string | TaskbarIcon

    icon URL for the dock provider.

    title?: string
    uiConfig?: {
        contentMenu?: { enableBookmarking?: boolean };
        hideDragHandle?: boolean;
        manageWorkspaces?: {
            newWindow?: {
                behavior: "view";
                viewOptions: OpenFin.PlatformViewCreationOptions;
            };
        };
        moreMenu?: {
            moreMenuCustomOption?: {
                label: string;
                options: BaseCustomDropdownItem<any>[];
            };
            quitPlatform?: { hidePlatformTitle?: boolean; skipDialog?: boolean };
        };
        providerIconContentMenu?: boolean;
    }

    The config for the companion dock ui

    Type Declaration

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

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

    • OptionalmanageWorkspaces?: {
          newWindow?: {
              behavior: "view";
              viewOptions: OpenFin.PlatformViewCreationOptions;
          };
      }
    • OptionalmoreMenu?: {
          moreMenuCustomOption?: {
              label: string;
              options: BaseCustomDropdownItem<any>[];
          };
          quitPlatform?: { hidePlatformTitle?: boolean; skipDialog?: boolean };
      }

      Configuration for the dock more menu component.

      • OptionalmoreMenuCustomOption?: { label: string; options: BaseCustomDropdownItem<any>[] }

        Custom menu option to display in the dock more menu. Configuration for customizable menu items that will appear in the dock context menu.

      • 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