Open Pioneer Trails Packages
    Preparing search index...

    Interface SearchProps

    Properties supported by the Search component.

    interface SearchProps {
        map?: MapModel;
        maxResultsPerGroup?: number;
        onClear?: (event: SearchClearEvent) => void;
        onDisposed?: (event: SearchDisposedEvent) => void;
        onReady?: (event: SearchReadyEvent) => void;
        onSelect?: (event: SearchSelectEvent) => void;
        placeholder?: string;
        searchTypingDelay?: number;
        sources: SearchSource[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    map? maxResultsPerGroup? onClear? onDisposed? onReady? onSelect? placeholder? searchTypingDelay? sources

    Properties

    map?: MapModel

    The map model to use.

    maxResultsPerGroup?: number

    The maximum number of results shown per group. Defaults to 5.

    onClear?: (event: SearchClearEvent) => void

    This event handler will be called when the user clears the search input.

    onDisposed?: (event: SearchDisposedEvent) => void

    Callback that is triggered once when the search is disposed and unmounted.

    onReady?: (event: SearchReadyEvent) => void

    Callback that is triggered once when the search is initialized. The search API can be accessed by the api property of the SearchReadyEvent.

    onSelect?: (event: SearchSelectEvent) => void

    This event handler will be called when the user selects a search result.

    placeholder?: string

    The placeholder text shown in the search input field when it is empty. Defaults to a generic (and localized) hint.

    searchTypingDelay?: number

    Typing delay (in milliseconds) before the async search query starts after the user types in the search term. Defaults to 200.

    sources: SearchSource[]

    Data sources to be searched on.

    Settings

    Member Visibility

    On This Page

    Properties