Documentation for automated readers
A curated documentation index is available at: https://grafana.com/llms.txt
A complete documentation index is available at: https://grafana.com/llms-full.txt
These indexes can help with page discovery before fetching individual documents.
This page is also available in Markdown, which may be easier for automated readers and AI tools to parse than HTML. The Markdown version is available at https://grafana.com/docs/grafana/v8.4/packages_api/ui/selectasyncprops.md, or by sending Accept: text/markdown to https://grafana.com/docs/grafana/v8.4/packages_api/ui/selectasyncprops/. For broader documentation discovery, the curated index is available at https://grafana.com/llms.txt and the complete index is available at https://grafana.com/llms-full.txt.
Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
SelectAsyncProps interface
Signature
export interface SelectAsyncProps<T> Import
import { SelectAsyncProps } from '@grafana/ui';Properties
| Property | Type | Description |
|---|---|---|
| cacheOptions | boolean | If cacheOptions is true, then the loaded data will be cached. The cache will remain until cacheOptions changes value. |
| defaultOptions | boolean | Array<SelectableValue<T>> | When specified as boolean the loadOptions will execute when component is mounted |
| loadingMessage | string | Message to display when options are loading |
| loadOptions | (query: string) => Promise<Array<SelectableValue<T>>> | Asynchronously load select options |
cacheOptions property
If cacheOptions is true, then the loaded data will be cached. The cache will remain until cacheOptions changes value.
Signature
cacheOptions?: boolean;defaultOptions property
When specified as boolean the loadOptions will execute when component is mounted
Signature
defaultOptions?: boolean | Array<SelectableValue<T>>;loadingMessage property
Message to display when options are loading
Signature
loadingMessage?: string;loadOptions property
Asynchronously load select options
Signature
loadOptions?: (query: string) => Promise<Array<SelectableValue<T>>>;