skills.rest
albanistrefi
albanistrefiCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

umbraco-search-provider

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

4|Updated Mar 6, 2026
Search Tags:#typescript#API integration#umbraco#search results#extension registry#backoffice extensions#search provider
One-click install
npx skills add https://github.com/albanistrefi/umbraco_CLI --skill umbraco-search-provider-albanistrefi
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: umbraco-search-provider
Source: https://github.com/albanistrefi/umbraco_CLI/tree/main/skills/extensions/umbraco-search-provider
Command: npx skills add https://github.com/albanistrefi/umbraco_CLI --skill umbraco-search-provider-albanistrefi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It solves the problem of integrating your own data sources into Umbraco backoffice search so users can find your custom entities directly from the search bar.

Core Features & Use Cases

  • Implements a Search Provider: Build a provider class with a search method that returns paginated, query-matching results.
  • Registers via Extension Manifest: Define a searchProvider manifest (type/alias/meta) that wires your provider into the Umbraco extension registry.
  • Returns Search Result Items: Produce UmbSearchResultItemModel items with entityType, unique, name, optional icon, and an href navigation target.
  • Uses Official Docs as Ground Truth: Guides you to fetch and follow the current Umbraco documentation before generating implementation files.

Quick Start

Use the umbraco-search-provider skill to generate a complete search provider (manifest and provider class) for your custom entity and then test it by executing the backoffice search with a query you expect to match.

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 results to the Umbraco backoffice?▼

You add custom search results to the Umbraco backoffice by implementing a search provider class with a search method and registering it via a searchProvider manifest in the extension registry to surface your custom entities.

What is an Umbraco backoffice search provider?▼

An Umbraco backoffice search provider is a class implementing UmbSearchProvider.search that fetches matching items from an external API or repository and returns paginated UmbSearchResultItemModel outputs for the global search UI.

Can I surface external API data in the Umbraco global search UI?▼

Yes, you can surface external API data in the Umbraco global search UI by building a provider that queries your API and maps the response to UmbSearchResultItemModel items with required fields like entityType, unique, name, and href.

How do I register a custom search provider in the Umbraco extension registry?▼

You register a custom search provider in the Umbraco extension registry by defining a searchProvider manifest specifying the type, alias, and meta, which wires your provider class into the backoffice search framework.

What properties are required for UmbSearchResultItemModel outputs?▼

UmbSearchResultItemModel outputs require entityType, unique, and name properties, and support optional icon and href navigation target fields to direct users to the correct backoffice location.

Does the Umbraco search provider need to handle pagination?▼

Yes, the Umbraco search provider must handle pagination by mapping user queries to results from an external API or repository and returning paginated items to ensure the backoffice search UI displays data efficiently.

Related Skills

Explore More Software Engineering Skills→
umbracoumbraco
26

umbraco-current-user-action

Generate TypeScript code for custom Umbraco backoffice current user actions.

Official
Intermediate
albanistrefialbanistrefi
4

umbraco-search-result-item

Implement custom Umbraco backoffice search result items with manifests and lit elements.

Community
Intermediate
umbracoumbraco
26

umbraco-picker-data-source

Implement custom picker data sources for Umbraco backoffice property editors.

Official
Intermediate
albanistalbanist
4

umbraco-entry-point

Implement custom initialization logic and UI extensions in the Umbraco backoffice.

Community
Intermediate