垂直導覽指引

Azure DevOps Services

垂直導覽會帶來會影響某些延伸模組的變更。 這些結果包括延伸模組圖示的支援，以及小組內容的變更。

提示

請參閱使用 Azure DevOps 擴充功能 SDK 進行擴充功能開發的最新檔。

小組內容

在傳統的水平導覽中，用戶可以從頁首左上方的選擇器中選取 ，以移至專案或小組。 這個選擇器會顯示最近的小組清單，以及流覽所有小組的方式。 在新的垂直導覽中，使用者只能流覽至專案（而不是小組）。 這項變更是為了簡化整體體驗而進行的。 但是，它為網頁延伸模組帶來了挑戰，這些延伸模組依賴用戶在頁首中使用傳統團隊選擇器切換團隊的能力。

SDK.getWebContext() 是 SDK 所提供的用戶端 API，可提供目前組織、專案和使用者正在運作小組的相關信息：

{
    "account": {
        "name": "Fabrikam",
        "id": "50e49b94-4bb6-40e7-8c85-a6d756d8a4d8"
    },
    "project": {
        "name": "Fabrikam Dev",
        "id": "049b1af2-fc87-4e50-95e4-151357f04b7f"
    },
    "team": {
        "name": "Ops Team",
        "id": "9b3a6b80-fe95-4c8c-8aa1-1e5d535d7af1"
    }
}

我們不建議依賴 SDK.getWebContext().team。 相反地，請遵循下列指引，根據您的擴充功能所屬類別。

小組感知的中樞延伸模組

如果您的延伸模組需要為使用者提供選取小組的方式，您可以使用 Teams REST API 來取得目前專案的小組清單。 下列範例示範如何從延伸模組呼叫此 API。

import { getClient } from "azure-devops-extension-api";
import { CoreRestClient } from "azure-devops-extension-api/Core";
import * as SDK from "azure-devops-extension-sdk";

private async getTeams() {
    const client = getClient(CoreRestClient);
    
    client.getTeams(SDK.getWebContext().project.id).then(
        function(teams) {
            console.log(teams);
        }
    );
}

如需提供小組選擇器控件的延伸模塊範例，請參閱 Team Calendar。

小組感知中樞的樞紐/面板延伸模組，例如待辦專案和儀錶板

您的延伸模組可以檢查傳遞至您貢獻的 組態 物件。 此物件具有不同的屬性，視參與類型以及裝載貢獻的位置而定。 範例顯示從組態讀取小組，並從 webContext 回溯至讀取小組，以支持內部部署版本中新的垂直導覽和較舊的水平流覽。

function getCurrentTeam() {
  let webContext = SDK.getWebContext();
  let configuration = SDK.getConfiguration();

  if ("team" in configuration) {
    return configuration.team;
  } else if ("team" in webContext) {
    return webContext.team;
  } else {
    return null; // should only happen if not in a project context
  }
}

小組感知中樞的動作延伸模組，例如待辦專案和儀錶板

當您的使用者選取參與的功能表項時，延伸模組可以檢查 傳遞給所叫用回呼的 actionContext 物件。 範例顯示從 actionContext 讀取小組。

var menuContributionHandler = (function () {
        "use strict";
        return {
            // This is a callback that gets invoked when a user selects the newly contributed menu item
            // The actionContext parameter contains team information.
            execute: function (actionContext) {
                if("team" in actionContext) {
                    alert(`Team. Id is ${actionContext.team.id}, Name is ${actionContext.team.name}`);
                }
            }
        };
    }());

中樞圖示

您可以選擇性地將資產（例如.png或.jpg）設定為中樞的圖示。 此圖示會出現在垂直導覽列中樞旁邊。 它必須與您的延伸模組一起封裝。

注意

這些圖示不會出現在水平導覽中。

完成下列步驟來設定中樞的圖示。

1. 將 iconAsset 中樞貢獻的 屬性設定為完整的資產標識碼，其遵循模式： {publisher-id}.{extension-id}/{asset-path}。

2. 在參與屬性中 includesData 新增此資產的專案。

3. 藉由將資產列在指令清單根目錄的 屬性中 files ，以擴充功能封裝資產。

範例 #1：

{
  "id": "my-extension",
  "publisherId": "my-publisher",
  ...
  "contributions": [
        {
            "id": "example-hub",
            "type": "ms.vss-web.hub",
            "targets": [
                "ms.vss-code-web.code-hub-group"
            ],
            "properties": {
                "name": "My Hub",
                "iconAsset": "my-publisher.my-extension/images/fabrikam-logo.png",
                "includesData": {
                    "assets": [
                        "my-publisher.my-extension/images/fabrikam-logo.png"
                    ]
                }
            }
       }
  ],
 "files": [
     {
         "path": "images/fabrikam-logo.png",
         "addressable": true
     }
 ]
}

範例 #2：

套用淺色與深色等主題時，您可以在延伸模組指令清單中指定圖示，如下所示。

{
    "id": "hub",
    "type": "ms.vss-web.hub",
    "targets": [
        "ms.vss-work-web.work-hub-group"
    ],
    "properties": {
        "name": "Hub",
        "description": "Something",
        "uri": "pages/Hub.html",
        "icon": {
            "light": "img/hub-light.png",
            "dark": "img/hub-dark.png"
        }
    }
}