AfriGIS Address Search

The AfriGIS Address Search headless Library is aimed at creating accessible underlying logic and functionality to implement AfriGIS Search UI components without prescribing a specific visual style.

Quick features

$3

The debounce rate is the time, measured in milliseconds, to wait after initial input before registering any subsequent inputs. The default setting is 350ms.

$3

Specify the minimum number of characters of input required before address suggestions are returned. The default is 3 characters.

$3

Specify the maximum number of address suggestions to return in the results. The default value is 5, but values of between 1 and 20 are accepted.

$3

Specify an array of string for the address types to include in the suggestions for Autocomplete API and Geocode API (address search). Refer to Address types for more details.

$3

Define which address types to include in the suggestions for Autocomplete API, using an array of strings. Refer to Address types for more details.

$3

AfriGIS provides detailed address information using the Place Details API by structuring the results by address type. Alternatively, the results can be returned in a structure suitable for deliveries by using the Delivery Address Format API

Running Examples

* Clone the repo
* Run NPM Install
* Run Development Server
``bash
npm run serve
`

Initialisation

`
const agSearch = new AfriGISAddressSearch({
...
});
`

Initialisation takes an options object as input. An explanation of the properties follows:

`
export interface IAfriGISAddressSearchOptions {
// API key for authentication.
// Required
apiKey: string;

// Callback handler for when the Suggestions change
// Required
onSuggestionsChange: (suggestions: IAfriGISAddressSearchSuggestion[]) => void;

// Callback handler for when the Selected Address payload changes
// Required
onSelectedAddressChange: (address: string) => void;

// Default is "https://afrigis.services"
baseUrl?: string;

// Minimum characters required before suggestions engine kick in. Default is 3 characters
minChars?: number;

// Debounce rate in milliseconds, default is 350ms
debounceMs?: number;

// Maximum amount of suggestions to return, a value between 1 and 20, default is 5
maxResults?: number;

// Array of strings to specify which types to include in suggestions, refer to https://developers.afrigis.co.za/oas3/autocomplete-api/api/v3/autocomplete
includeTypes?: string[]; // array of strings

// Array of strings to specify which types to exclude in suggestions, refer to https://developers.afrigis.co.za/oas3/autocomplete-api/api/v3/autocomplete
excludeTypes?: string[]; // array of strings

// Specifies which format to return the selected Address Payload in. Default is 'details'
addressComponentsFormat?: 'details' | 'delivery';

// JWT token for authentication
jwtToken?: string;
}
``

Other methods

$3

Resets the selected Address and the suggestions

$3

Fires off the call to retrieve autocomplete suggestions

$3

Fires off the call to retrieve address search suggestions (a backup to autocomplete)

$3

Fires off the call to retrieve the Address Information for a specific address reference

$3

Sets the API key (useful in a multitenant situation)

$3

Sets the Address Components Format for selected Addresses

$3

Sets the JWT token. Necessary for long-running frontends as the JWT token expires in 60 minutes.