Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional onAddressRetrieved

onAddressRetrieved: function

Optional callback. This function is invoked when the autocomplete client has retrieved a full address from the API following a user accepting a suggestion. The first argument is an object representing the address that has been retrieved.

Type declaration

Optional onAddressSelected

onAddressSelected: function

Optional callback. This function is invoked immediately after the user has selected a suggestion (either by click or keypress). The first argument is an object which represents the suggestion selected.

Type declaration

Optional onBlur

onBlur: function

Optional callback. This function is invoked when focus is removed from the address suggestion input field.

Type declaration

    • (): void
    • Returns void

Optional onClose

onClose: function

Optional callback. This function is invoked when the suggestion list is closed.

Type declaration

    • (): void
    • Returns void

Optional onFailedCheck

onFailedCheck: function

Optional callback. This function is invoked when checkKey is enabled and the key is discovered to be in an unusable state (e.g. daily limit reached, no balance, etc).

Type declaration

    • (): void
    • Returns void

Optional onFocus

onFocus: function

Optional callback. This function is invoked when the focus has been moved to the address suggestion input field.

Type declaration

    • (): void
    • Returns void

Optional onInput

onInput: function

Optional callback. This function is invoked when the address input field has detected a keypress.

Type declaration

    • (event: Event): void
    • Parameters

      • event: Event

      Returns void

Optional onLoaded

onLoaded: function

Optional callback. This function is invoked when autocomplete has been successfully attached to the input element.

Type declaration

    • (): void
    • Returns void

Optional onOpen

onOpen: function

Optional callback. This function is invoked when the suggestion list is opened.

Type declaration

    • (): void
    • Returns void

Optional onSearchError

onSearchError: function

Optional callback. This function is invoked when an error has occurred following an attempt to retrieve an address suggestion or full address. The first argument is an error instance (i.e. inherits from Error) representing the error which has occurred.

Type declaration

    • (error: Error): void
    • Parameters

      • error: Error

      Returns void

Optional onSuggestionsRetrieved

onSuggestionsRetrieved: function

Optional callback. This function is invoked immediately after address suggestions are retrieved from the API. The first argument is an array of address suggestions.

Type declaration