Изменение интерфейса Поиска (Майкрософт) с помощью расширений SharePoint Framework

  • Статья

В выпуске SharePoint Framework версии 1.10 представлены расширения запросов поиска. Это расширения SharePoint Framework (SPFx), которые можно использовать для изменения поискового запроса, выполняемого с помощью интерфейса поиска.

Примечание.

Сейчас эта функция доступна в предварительной версии функции для разработчиков. Чтобы использовать функции в предварительной версии для разработчиков, убедитесь, что вы используете --plusbeta версию пакета. Дополнительные сведения см. в статье Пробная SharePoint Framework предварительных версий возможностей.

Важно!

Даже если это расширение доступно в выпуске SharePoint Framework версии 1.10, оно не поддерживается в SharePoint Online.

Расширение запроса действует как обычное расширение SharePoint Framework, но оно будет вызываться непосредственно перед выполнением поискового запроса, чтобы запрос можно было изменить. Во время предварительной версии расширения запросов имеют следующие характеристики:

  • Расширения запросов работают только в контексте SharePoint
  • Необходимо явно включить расширения запросов на сайте или в области семейства веб-сайтов.
  • Расширения запросов работают только в том случае, если семейство веб-сайтов связано с использованием настраиваемой страницы результатов поиска
  • Настраиваемая страница результатов поиска может использовать новый макет страницы без заголовковSearchResults для уменьшения содержимого заголовка
  • Макет страницы без заголовковSearchResults поддерживается только для страниц, которые связаны как настраиваемая страница результатов поиска
  • Вы можете обеспечить современный интерфейс поиска с помощью современного решения для поиска с открытым исходным кодом

Процесс разработки

Вы можете начать разработку расширений запросов, просто используя пакеты SharePoint Framework версии 1.10 или более поздних версий. Так как эта функция находится в состоянии предварительного просмотра, необходимо выполнить генератор Yeoman с помощью переключателя --plusbeta , как показано ниже.

yo @microsoft/sharepoint --plusbeta

Вы можете увидеть новый параметр под названием "Модификатор запросов поиска ", чтобы создать шаблон компонента расширения запроса.

Связывание расширений запросов с сайтами

Расширения запросов по умолчанию связаны с семейством веб-сайтов, когда на сайте установлено решение, содержащее расширение. Это происходит автоматически с помощью определений платформы компонентов, автоматически упакованных в пакет решения. Технически эта связь выполняется с помощью UserCustomAction коллекции с ClientSideExtension.SearchQueryModifier в качестве атрибута Location .

При создании решения с модификатором поисковых запросов включаются следующие elements.xml файл:

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
  <CustomAction
      Title="QueryModifyer"
      Location="ClientSideExtension.SearchQueryModifier"
      ClientSideComponentId="801f82d5-1a21-4b2c-94b6-f13f6672142c"
      ClientSideComponentProperties="{&quot;testMessage&quot;:&quot;Test message&quot;}">
  </CustomAction>
</Elements>

Технически вы также можете использовать развертывание расширений SharePoint Framework в области клиента, чтобы автоматически связать расширение с несколькими семействами веб-сайтов в клиенте.

Развертывание расширения

Развертывание — это двухфакторный процесс по умолчанию для модификатора поисковых запросов по крайней мере во время предварительной версии:

  1. Развертывание решения в каталоге приложений SharePoint
  2. Установите решение в семейство веб-сайтов, в котором вы хотите использовать расширение
  3. Создание настраиваемой страницы результатов поиска и настройка ее использования в семействе веб-сайтов

Вы можете настроить настраиваемую страницу результатов поиска для семейства веб-сайтов из параметров сайта, щелкнув Параметры поиска , а затем включив параметр пользовательского интерфейса поиска.

Рис