Interface ManifestSearchProvider

Represents an search provider that can be used to search.

interface ManifestSearchProvider {
    alias: string;
    api?: ApiLoaderProperty<
        UmbSearchProvider<UmbSearchResultItemModel, UmbSearchRequestArgs>,
    >;
    API_TYPE?: UmbSearchProvider<
        UmbSearchResultItemModel,
        UmbSearchRequestArgs,
    >;
    js?: ApiLoaderProperty<
        UmbSearchProvider<UmbSearchResultItemModel, UmbSearchRequestArgs>,
    >;
    kind?: unknown;
    meta?: MetaSearchProvider;
    name: string;
    type: "searchProvider";
    weight?: number;
}

Hierarchy (View Summary)

Properties

alias api? API_TYPE? js? kind? meta? name type weight?

Properties

alias

alias: string

The alias of the extension, ensure it is unique

Optionalapi

api?: ApiLoaderProperty<
    UmbSearchProvider<UmbSearchResultItemModel, UmbSearchRequestArgs>,
>

@TJS-type string

Optional ReadonlyAPI_TYPE

API_TYPE?: UmbSearchProvider<UmbSearchResultItemModel, UmbSearchRequestArgs>

@TJS-ignore

Optionaljs

js?: ApiLoaderProperty<
    UmbSearchProvider<UmbSearchResultItemModel, UmbSearchRequestArgs>,
>

The file location of the javascript file to load @TJS-type string

Optionalkind

kind?: unknown

The kind of the extension, used to group extensions together

Examples

["button"]

Optionalmeta

meta?: MetaSearchProvider

name

name: string

The friendly name of the extension

type

type: "searchProvider"

The type of extension such as dashboard etc...

Optionalweight

weight?: number

Extensions such as dashboards are ordered by weight with lower numbers being first in the list

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR