The Search Query extension tutorial has no useful information at all

[Neutrino-Sunset]

Target SharePoint environment

SharePoint Online

What SharePoint development model, framework, SDK or API is this about?

💥 SharePoint Framework

Developer environment

None

What browser(s) / client(s) have you tested

• 💥 Internet Explorer
• 💥 Microsoft Edge
• 💥 Google Chrome
• 💥 FireFox
• 💥 Safari
• mobile (iOS/iPadOS)
• mobile (Android)
• not applicable
• other (enter in the "Additional environment details" area below)

Additional environment details

• browser version: Latest
• SPFx version: 1.21.1
• Node.js version: 22.21.1
• etc

Describe the bug / error

The Search Query extension tutorial page here https://learn.microsoft.com/en-us/sharepoint/dev/spfx/building-search-extensions does not describe what a search query extension is, nor how to create one.

It describes how to scaffold a search query extension project, but it does not modify that project to actually customize anything. Nor does it link to any other useful documentation.

It does link to the PnP Modern Search v4 documentation, but that documentation just describes how to use PnP Search components in modern pages. It has nothing to do with building custom SPFX components.

Steps to reproduce

1. Read the documentation

Expected behavior

I should be able to learn what a search customizer is and how to create one.

[Ashlesha-MSFT]

Hello @Neutrino-Sunset,
Thank you for bringing this issue to our attention. We will look into it and get back to you shortly.
If you don’t receive a reply within two working days, please use this escalation form to escalate.

[Ashlesha-MSFT]

@Neutrino-Sunset,
Thank you for your detailed feedback regarding the Search Query Extension tutorial. You’re correct that the current documentation https://learn.microsoft.com/en-us/sharepoint/dev/spfx/extensions/get-started/query-suggestion-tutorial-building and https://learn.microsoft.com/en-us/sharepoint/dev/spfx/building-search-extensions doesn’t go in-depth on what a Search Query Modifier is or how to modify search queries beyond scaffolding the project.

It appears that the tutorial was written assuming developers are already familiar with SPFx scaffolding, packaging, and deployment, which is why it focuses on the new Search Query Modifier concept and its configuration rather than providing end-to-end guidance or code examples. Compared to previous SPFx tutorials, this can make it challenging for developers encountering this feature for the first time to fully understand how to implement and use it.

We understand that for new or less experienced SPFx developers, a more complete example demonstrating how to modify search queries using modifySearchQuery() and how the extension interacts with the search pipeline would be very helpful.

We will check with the engineering and documentation team to see if sample code and a more detailed explanation can be added to the article to improve clarity and usability.