Interface QuickAccessProviderDescriptor

interface QuickAccessProviderDescriptor {
    contextKey?: string;
    getInstance: (() => QuickAccessProvider);
    helpEntries: QuickAccessProviderHelp[];
    placeholder?: string;
    prefix: string;
}

Properties

contextKey? getInstance helpEntries placeholder? prefix

Properties

Optional Readonly contextKey

contextKey?: string

A context key that will be set automatically when this quick access is being shown

Readonly getInstance

getInstance: (() => QuickAccessProvider)

return an instance of QuickAccessProvider. Implementers are free to return that same instance multiple times

Type declaration

Readonly helpEntries

helpEntries: QuickAccessProviderHelp[]

Help entries for this quick access provider

Optional Readonly placeholder

placeholder?: string

A placeholder to use for the input field when the provider is active. This will also be read out by screen readers and thus helps for accessibility.

Readonly prefix

prefix: string

The prefix for quick access picker to use the provider for.

Settings

Member Visibility

Theme

On This Page

contextKeygetInstancehelpEntriesplaceholderprefix