可以使用组件为mgt-teams-channel-picker与用户关联的Microsoft Teams启用搜索。 组件可以搜索用户已加入的所有团队,以及这些团队中的每个频道。
示例
以下示例显示组件 mgt-teams-channel-picker 。 开始搜索频道或团队以查看结果呈现。
<iframe src="https://mgt.dev/iframe.html?id=components-mgt-teams-channel-picker--teams-channel-picker&source=docs" height="450"></iframe>
获取所选频道
selectedItem使用 属性检索当前选定的频道和父团队。 如果未选择任何通道,则此值将为 null。 selectedItem 包含两个属性: channel (MicrosoftGraph.Channel) 和 team (MicrosoftGraph.Team) 。
const channelPicker = document.querySelector('mgt-teams-channel-picker');
console.log(channelPicker.selectedItem.channel);
console.log(channelPicker.selectedItem.team);
选择频道
selectChannelById(channelId: string)使用 方法以编程方式选择通道。
注意: Teams选取器仅支持单通道选择。
const channelPicker = document.querySelector('mgt-teams-channel-picker');
const channelId = 'some-channel-id';
channelPicker.selectChannelById(channelId);
注意: 提供的频道 (和后续 ID) 必须属于经过身份验证的用户已加入的团队。
CSS 自定义属性
组件 mgt-teams-channel-picker 定义以下 CSS 自定义属性。
mgt-teams-channel-picker {
--input-border: 2px rgba(255, 255, 255, 0.5) solid; /* sets all input area border */
/* OR individual input border sides */
--input-border-bottom: 2px rgba(255, 255, 255, 0.5) solid;
--input-border-right: 2px rgba(255, 255, 255, 0.5) solid;
--input-border-left: 2px rgba(255, 255, 255, 0.5) solid;
--input-border-top: 2px rgba(255, 255, 255, 0.5) solid;
--input-background-color: #1f1f1f; /* input area background color */
--input-border-color--hover: #008394; /* input area border hover color */
--input-border-color--focus: #0f78d4; /* input area border focus color */
--dropdown-background-color: #1f1f1f; /* channel background color */
--dropdown-item-hover-background: #333d47; /* channel or team hover background */
--dropdown-item-selected-background: #0F78D4; /* selected channel background color */
--color: white; /* input area border focus color */
--arrow-fill: #ffffff;
--placeholder-color: #f1f1f1; /* placeholder text color */
--placeholder-color--focus: rgba(255, 255, 255, 0.8); /* place holder text focus color */
}
事件
| 事件 | 何时发出 | 自定义数据 | Cancelable | 气泡 | 使用自定义模板 |
|---|---|---|---|---|---|
selectionChanged |
在用户更改频道选择时触发 | 当前选择的项目作为 { channel: channelteam, team: ``} |
否 | 否 | 是 |
有关处理事件的信息,请参阅 事件。
模板
mgt-teams-channel-picker 支持 多个 模板,您可以使用这些模板替换组件的某些部分。 若要指定模板,请包含 <template> 组件中的元素,将 data-type 值设置为以下值之一。
| 数据类型 | 数据上下文 | 说明 |
|---|---|---|
| loading | null:无数据 | 向 Microsoft 请求时用于呈现文件选取器Graph模板。 |
| error | null:无数据 | 当用户搜索未返回任何用户时所使用的模板。 |
以下示例演示如何使用该 error 模板。
<mgt-teams-channel-picker>
<template data-type="error">
<p>Sorry, no Teams or Channels were found</p>
</template>
</mgt-teams-channel-picker>
Microsoft Graph 权限
默认情况下,此组件Graph Microsoft 应用程序 API 和权限。
| API | 权限 |
|---|---|
| /me/joinedTeams | User.Read.All |
| /teams/${id}/channels | Group.Read.All |
在版本 2.2 中,所需的权限已更新为限制较Teams权限。 若要避免发生意外更改,您需要通过全局配置选择加入新权限。
import {MgtTeamsChannelPicker} from "@microsoft/mgt-components";
MgtTeamsChannelPicker.config.useTeamsBasedScopes = true;
true设置为 useTeamsBasedScopes 时,Teams选取器将使用以下范围。
| API | 权限 |
|---|---|
| /me/joinedTeams | Team.ReadBasic.All |
| /teams/${id}/channels | Channel.ReadBasic.All |
这些权限将是下一个主要更新中的默认权限。
身份验证
该控件使用身份验证文档中介绍的全局 身份验证提供程序。
缓存
组件 mgt-teams-channel-picker 不缓存任何数据。
扩展以了解更多控件
对于更复杂的方案或真正自定义的 UX,此组件公开 protected render* 了多个在组件扩展中替代的方法:
| 方法 | 说明 |
|---|---|
| renderSelected | 在输入框中呈现选定的团队和频道。 |
| renderInput | 呈现输入框。 |
| renderDropdown | 呈现下拉列表。 |
| renderDropdownList | 以递归方法呈现下拉列表中的项。 |
| renderItem | 在下拉列表中呈现团队或频道。 |
| renderHighlightedText | 呈现通道文本,突出显示输入查询。 |
| renderLoading | 呈现加载下拉列表状态。 |
| renderError | 呈现下拉列表错误状态。 |
历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 sebastienlevert)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
