使用 SharePoint 框架 生成查询建议扩展

从 SharePoint 框架 v1.10 开始，还可以使用 SharePoint 框架 生成查询建议扩展。

在开始了解SharePoint 框架扩展的整个过程之前，请确保已完成以下文章中的过程，因为查询建议扩展的工作方式与应用程序自定义工具类似：

• 生成首个 SharePoint 框架扩展（Hello World 第 1 部分）
• 使用应用程序定制器中的页面占位符（Hello World 第 2 部分）
• 将扩展部署到 SharePoint（Hello World 第 3 部分）

注意

此功能作为开发人员预览版功能引入。 要使用开发人员预览版中的功能，请确保使用 --plusbeta 版本的库（请参阅本文以供参考）

重要

此实验室要求至少使用 SharePoint 框架 1.10 版本，因为这些功能在更早版本中不可用。

创建新的解决方案项目

1. 在你最喜爱的位置创建新的项目目录：

   md query-extension
   

2. 转到项目目录：

   cd query-extension
   

3. 通过运行 Yeoman SharePoint 生成器创建新的客户端 Web 部件解决方案：

   yo @microsoft/sharepoint --plusbeta
   

4. 当出现提示时：

   • 接受默认 查询建议 作为解决方案名称，然后选择 Enter。
   • 选择“仅限 SharePoint Online (最新)”，然后按 Enter。
   • 选择“使用当前文件夹”作为文件放置位置。
   • 选择 “N ”，因为我们希望此扩展显式安装在特定站点上（给定将应用的自动化配置）
   • 在解决方案是否包含独有权限的问题上选择“N”。
   • 选择“扩展”作为要创建的客户端组件类型。
   • 选择“ 搜索查询修饰符 ”作为要创建的客户端扩展。

   注意

   如果 搜索查询修饰符 扩展不可用，请重新启动该过程，并确保在执行 yeoman 生成器时使用了 --plusbeta 开关，如下所示： yo @microsoft/sharepoint --plusbeta。

5. 接下来的一组提示要求提供 Web 部件的具体信息：

   • 输入 MyQueryExtension 的扩展名称，然后选择 Enter。
   • 输入 “我的第一个查询扩展 ”作为扩展的说明，然后选择 Enter。
   • 接受框架的默认 “无 JavaScript 框架 ”选项，然后选择 Enter 继续。

   

   此时，Yeoman 安装必需的依赖项，并为解决方案文件搭建基架。 创建解决方案可能需要几分钟时间。 Yeoman 为项目搭建基架，以包括 MyQueryExtension 扩展，该扩展可用于修改提供的搜索查询的运行时。

6. 接下来，键入以下命令，在 Visual Studio Code 中打开 Web 部件项目：

   code .
   

请注意结构与其他SharePoint 框架解决方案的相似之处。 已使用 extensions \myQueryExtension 文件夹下的默认值创建扩展

修改查询扩展代码

打开文件

修改

Save

将解决方案安装到 SharePoint

内部版本

包

安装到应用程序目录

安装到站点

安装新式搜索开源解决方案

PowerShell 执行和测试内容

激活自定义搜索体验

PowerShell 执行和测试内容