Skip to content

Commit 6fa165e

Browse files
committed
Updating search query extensions to be GA'd
1 parent d5cdb96 commit 6fa165e

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

docs/spfx/building-search-extensions.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
---
22
title: Modifying Microsoft Search experience using SharePoint Framework extensions
33
description: You can modify the Microsoft Search experiences using SharePoint Framework extensions
4-
ms.date: 06/19/2020
4+
ms.date: 04/19/2023
55
ms.localizationpriority: medium
66
---
77

88
# Modifying Microsoft Search experience using SharePoint Framework extensions
99

10-
The SharePoint Framework v1.10 release introduces Search Query extensions. These are SharePoint Framework (SPFx) extensions, which can be used to modify search query executed using the search experience.
11-
12-
[!INCLUDE [developer-preview-notice](../../includes/snippets/developer-preview-notice.md)]
10+
Search Query extensions are SharePoint Framework (SPFx) extensions, which can be used to modify search query executed using the search experience.
1311

1412
> [!IMPORTANT]
15-
> Even thought this extension is available in the SharePoint Framework v1.10 release, it's not supported in the SharePoint Online.
13+
> This feature moved to General Availability status with the SPFx v1.16 release.
1614
17-
A query extension acts as a normal SharePoint Framework extension, but it will be invoked just before the search query is executed, so that the query can be potentially modified. During **preview**, query extensions have following characteristics:
15+
A query extension acts as a normal SharePoint Framework extension, but it will be invoked just before the search query is executed, so that the query can be potentially modified. Query extensions have following characteristics:
1816

1917
- Query extensions only work in the context of SharePoint
2018
- You will need to explicitly enable query extensions in site or in site collection scope
@@ -25,10 +23,10 @@ A query extension acts as a normal SharePoint Framework extension, but it will b
2523

2624
## Development process
2725

28-
You can start developing query extensions simply by using the SharePoint Framework v1.10 or later packages. As this feature is on preview status, you'll need to execute the Yeoman generator using the `--plusbeta` switch as demonstrated below.
26+
You can start developing query extensions for production simply by using the SharePoint Framework v1.16 or later packages.
2927

3028
```console
31-
yo @microsoft/sharepoint --plusbeta
29+
yo @microsoft/sharepoint
3230
```
3331

3432
You can see a new option called **Search Query Modifier** under the extension selection to scaffold you a query extension component.
@@ -55,11 +53,11 @@ Technically you can also use the Tenant scoped deployment of SharePoint Framewor
5553

5654
## Deployment of your extension
5755

58-
Deployment is a two-step process by default for the **Search Query Modifier** at least during the preview:
56+
Deployment is a two-step process by default for the **Search Query Modifier**:
5957

6058
1. Deploy solution to SharePoint App Catalog
61-
1. Install solution to the site collection where you want to use the extension
62-
1. Create a custom search results page and configure it to be used in the site collection
59+
2. Install solution to the site collection where you want to use the extension
60+
3. Create a custom search results page and configure it to be used in the site collection
6361

6462
You can configure custom search results page for a site collection from the site settings by clicking **Search Settings** and then enabling the custom search experience option.
6563

docs/spfx/release-1.16.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: SharePoint Framework v1.16 release notes
33
description: Release notes for the SharePoint Framework v1.16 release
4-
ms.date: 2/16/2023
4+
ms.date: 4/19/2023
55
ms.localizationpriority: high
66
---
77
# SharePoint Framework v1.16 release notes
@@ -97,6 +97,12 @@ SPFx now supports React 17 by default (scaffolded as part of the solution).
9797

9898
Set a data version for this preconfigured entry. This is optional and can be used in cases where the SPPKG is updated independently from code (e.g. hosted on a CDN). Web Parts can read this value for backwards compatibility with out of date default properties.
9999

100+
### General availability of Search Query extensions
101+
102+
Search Query extensions moved to the General Availability status with this version and can be used in the production.
103+
104+
* [Modifying Microsoft Search experience using SharePoint Framework extensions](building-search-extensions.md)
105+
100106
### Ability to use tasks and middleware in Microsoft Graph v3
101107

102108
Starting this version, developers can install `@microsoft/microsoft-graph-client` to reference tasks or middlewares from the SDK, for example, `LargeFileUploadTask`. SPFx will automatically externalize the dependency and load it from the CDN.

0 commit comments

Comments
 (0)