SearchDocument
Home > @backstage/plugin-search-common
> SearchDocument
Base properties that all search documents must include.
Signature:
export interface SearchDocument
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
location | string | The relative or absolute URL of the document (target when a search result is clicked). | |
text | string | Free-form text of the document (e.g. description, content, etc). | |
title | string | The primary name of the document (e.g. name, title, identifier, etc). |