通过


扩展组件示例

Azure DevOps Services |Azure DevOps Server |Azure DevOps Server 2022

将这些示例用作你自己的扩展的起点。 每个示例都演示了少量的贡献,以便你可以看到它们是如何单独工作的。 所有源代码都在 Azure DevOps 扩展示例存储库中。

提示

有关最新的扩展开发指南,包括主题处理以及从 VSS.SDK 的迁移,请参阅 Azure DevOps 扩展 SDK 开发人员门户

下表列出了存储库中的示例以及每个示例演示的贡献类型。

示例 贡献内容 说明
BreadcrumbService 面包屑导航服务,枢纽 添加痕迹导航服务,它将 示例痕迹导航项 添加到示例中心。 若要查看此项,请转到管道中心组中的示例中心
CodeEditorContribution 代码编辑器 为代码编辑器添加语言定义和 JSON 架构。
功能 功能、枢纽、属性提供商 演示如何挂钩到 用户配置文件菜单下的“预览功能 ”面板。 添加一个简单的中心,仅在打开“ABC”功能时显示。 可以针对每个用户或组织切换该功能。
集线器 集线器 将名为 Sample Hub的中心添加到 Pipelines 中心组中。 示例中心位于管道导航元素下的项目级页面上。
菜单 生成定义菜单项 示例构建定义菜单项 添加到 构建中心 的下拉操作菜单中。 菜单处理程序从传递的上下文中获取当前生成定义,进行 REST 调用,然后在消息框中显示结果。
面板 面板内容,中枢 在 Hub 示例中应用。 包含一个切换按钮以及 “确定 ”和 “取消” 按钮。 可用作自定义面板或对话框内容。
透视表 Web 选项卡 将“示例透视”选项卡添加到组织或项目集合主页、“项目”、“我的工作项”和“我的拉取请求”旁边
药片 药丸提供者 将药片添加到管道定义(运行)页的标题。
查询参数处理器 (QueryParamsHandler) 事件订阅 当加载任何页面时,只要查询参数showMyPanel出现在URL中,就会添加一个服务。 启动服务显示来自 Panel 示例的自定义面板,并使用可选 myPanelTitle 查询参数作为面板标题。
RepositoryActions 菜单项 示例存储库操作 菜单项添加到代码中心页面顶部的存储库选取器。 如果 href 属性显示,请选择操作以转到给定的 URL。 如果提供了该 uri 属性,则选择该操作时,该代码将执行。
RepositoryServiceHub 集线器 存储库信息 中心添加到 代码 中心组。 演示如何与 IVersionControlRepositoryService 用户 Git 存储库进行交互以获取有关用户 Git 存储库的基本信息。
WorkItemFormGroup 工作项表单组 Sample WorkItem 窗体组扩展添加到工作项窗体中,以展示如何与IWorkItemFormService服务和IWorkItemNotificationListener进行交互。 提供 UI 以显示如何使用表单服务更改字段值以及显示工作项窗体通知事件的情况。
WorkItemOpen 集线器 Sample WorkItem Open 中心添加到 Boards 中心组,以显示如何与 IWorkItemFormNavigationService 服务交互。 提供一个 UI,用于按 ID 打开现有工作项,或按工作项类型打开新工作项的工作项窗体。 其中任一选项在主机帧中打开一个对话框。

社区示例 (DevLabs)

来自 Microsoft DevLabs 的这些开源扩展显示了可以适应的实际模式。

示例 Source 贡献内容 说明
团队日历 GitHub 中心、事件源 跟踪对团队很重要的事件、查看和管理休息日、快速查看冲刺开始和结束时间等。
WSJF(加权最短作业优先) GitHub 通知(工作项)、上下文菜单操作(工作项) 自动计算每个工作项的 WSJF(加权最短作业优先)并将其存储在工作项字段中。
级联列表 GitHub 工作项表单 为工作项窗体中的选项列表定义级联行为。
回顾会议 GitHub 集线器 回顾会议和反馈板场景的一流体验。 收集有关项目里程碑的反馈、组织和确定优先级,并创建和跟踪可操作的任务,这有助于团队随着时间的推移改进。
估计 GitHub 中枢、工作项操作菜单 在 Azure DevOps 中进行规划扑克。 从迭代、查询或你的积压工作项中选择工作,与团队一起估算这些项目的工作量,并立即更新工作项。
多值控件 GitHub 工作项表单 允许选择多个值的工作项窗体控件。
Azure DevOps 扩展任务 GitHub 构建和发布任务 用于将 Azure DevOps 和 Visual Studio 扩展打包并发布到 Visual Studio 市场的 Azure Pipelines 任务。

开始

有关分步演练,请参阅 “开发 Web 扩展”。 还可以克隆 Azure DevOps 扩展示例存储库 ,并将任何示例用作起始模板。