skills.rest
umbraco
umbracoOFFICIAL
Explore all skills by this author →
WebsiteGitHub

umbraco-search-provider

Implement custom search providers in the Umbraco backoffice returning paginated results.

26|13|Updated Nov 30, 2025
Search Tags:#search#customization#extension#provider#umbraco#backoffice
One-click install
npx skills add https://github.com/umbraco/Umbraco-CMS-Backoffice-Skills --skill umbraco-search-provider
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: umbraco-search-provider
Source: https://github.com/umbraco/Umbraco-CMS-Backoffice-Skills/tree/main/plugins/umbraco-backoffice-skills/skills/umbraco-search-provider
Command: npx skills add https://github.com/umbraco/Umbraco-CMS-Backoffice-Skills --skill umbraco-search-provider

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill enables the integration of custom search functionalities directly into Umbraco's backoffice, allowing users to search across various data sources beyond the default content, media, and members.

Core Features & Use Cases

  • Custom Data Source Integration: Connect and search proprietary data stores.
  • Backoffice Search Bar Extension: Seamlessly add custom search results alongside Umbraco's native search.
  • Use Case: A retail business can implement a search provider to allow backoffice users to quickly find specific products by SKU, name, or category directly from the main search bar.

Quick Start

Use the umbraco-search-provider skill to implement a new search provider for custom product data.

Frequently Asked Questions about umbraco-search-provider

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add custom search to the Umbraco backoffice?▼

Yes, you can integrate external data into Umbraco backoffice search by fetching and formatting your custom data sources to match the UmbSearchResultItemModel interface for display alongside native results.

How do I structure paginated search results for a custom Umbraco provider?▼

Structure paginated search results by defining a search method that returns user query matches formatted according to the UmbSearchResultItemModel interface, leveraging repository patterns for data access.

Can I scope custom search results to specific data sources in Umbraco?▼

Yes, you can scope custom search results in Umbraco by using the searchFrom argument within your custom provider implementation to restrict queries to specific data sources or contexts.

Does integrating a custom search provider require modifying native Umbraco components?▼

No, integrating a custom search provider extends the native Umbraco backoffice search bar without modifying core components, allowing proprietary data like product SKUs to appear seamlessly in standard search results.

Related Skills

Explore More Software Engineering Skills→
albanistrefialbanistrefi
4

umbraco-repository-pattern

Guide repository-based data operations in the Umbraco backoffice with OpenAPI clients.

Community
Intermediate
albanistrefialbanistrefi
4

umbraco-search-provider

Generate an Umbraco searchProvider manifest and provider class returning paginated UmbSearchResultItemModel items.

Community
Intermediate
umbracoumbraco
26

umbraco-picker-data-source

Implement custom picker data sources for Umbraco backoffice property editors.

Official
Intermediate
albanistalbanist
4

umbraco-search-provider

Integrate custom search providers into the Umbraco backoffice using TypeScript.

Community
Intermediate