Skip to main content

SearchDocument

Home > @backstage/plugin-search-common > SearchDocument

Base properties that all search documents must include.

Signature:

export interface SearchDocument 

Properties

PropertyModifiersTypeDescription
locationstringThe relative or absolute URL of the document (target when a search result is clicked).
textstringFree-form text of the document (e.g. description, content, etc).
titlestringThe primary name of the document (e.g. name, title, identifier, etc).