Interface JawgPlacesMaplibreOptions

Options for JawgPlaces.MapLibre and JawgPlaces.Mapbox

interface JawgPlacesMaplibreOptions {
    accessToken?: string;
    adminArea?: AdminAreaOptions;
    boundary?: BoudaryOptions;
    clearCross?: boolean;
    container?: string | HTMLElement;
    debounceDelay?: number;
    focusPoint?: LatLon | (() => LatLon);
    input?: string | HTMLElement;
    inputClasses?: string | string[];
    language?: string | (() => string);
    layers?:
        | string
        | string[]
        | (() => string)
        | (() => string[]);
    marker?: MapGLMarkerOptions;
    minLength?: number;
    noResultsMessage?: string | false;
    onClear?: (() => void);
    onClick?: ((feature: Feature) => void);
    onClose?: (() => void);
    onError?: ((error: any) => void);
    onFeatures?: ((features: Feature[]) => void);
    placeholder?: string;
    resultContainer?: string | HTMLElement;
    reverse?: ReverseOptions;
    searchOnTyping?: boolean;
    showResultIcons?: boolean;
    size?: number;
    sources?:
        | string
        | string[]
        | (() => string[])
        | (() => string);
    transition?: MapGLTransitionOptions;
}

Hierarchy (view full)

Properties

accessToken? adminArea? boundary? clearCross? container? debounceDelay? focusPoint? input? inputClasses? language? layers? marker? minLength? noResultsMessage? onClear? onClick? onClose? onError? onFeatures? placeholder? resultContainer? reverse? searchOnTyping? showResultIcons? size? sources? transition?

Properties

OptionalaccessToken

accessToken?: string

Your personal access token, create your own on the Jawg Lab. This is filled automatically when you get the library with our CDN.

OptionaladminArea

adminArea?: AdminAreaOptions

Option to show administrative area when available.

Optionalboundary

boundary?: BoudaryOptions

Set of options when you are looking for places in a particular region.

OptionalclearCross

clearCross?: boolean

Add a clear cross in the right side of the input.

Optionalcontainer

container?: string | HTMLElement

The custom <div> that will contain the input and geocoding results when Places JS is used as MapLibre Control. By default this is generated by Jawg Places JS. With some frameworks/UI libs such as React, you can't use the ref here.

OptionaldebounceDelay

debounceDelay?: number

Set the number of milliseconds to wait before a search validation. If you press Enter the search will be immediately validated. This option work only when searchOnTyping=true. Default value is 350.

OptionalfocusPoint

focusPoint?: LatLon | (() => LatLon)

See FocusOptions.point

Optionalinput

input?: string | HTMLElement

The <input> to transform into a geocoding search bar. This can be either a id (e.g #my-input), class selector (e.g .my-input) or the HTMLElement. With some frameworks/UI libs such as React, you can't use the ref here.

OptionalinputClasses

inputClasses?: string | string[]

Class to add to the input when it's generated by the library.

Optionallanguage

language?: string | (() => string)

Return results in a specific language using BCP47 standard (e.g 'en', 'fr', 'de', ...). By default, we use HTTP Header set by the browser and English when not present. Language can be static or dynamic with the function.

Optionallayers

layers?:
    | string
    | string[]
    | (() => string)
    | (() => string[])

Filter the kind of place you want to find. Layers can be static or dynamic with the function.

Optionalmarker

marker?: MapGLMarkerOptions

Option to configure result markers on the map.

OptionalminLength

minLength?: number

Set the minimum number of characters to trigger a geocoding request. If you press Enter the search will be validated even if the length is not reached. This option work only when searchOnTyping=true. Default value is 0.

OptionalnoResultsMessage

noResultsMessage?: string | false

Set a custom message when no results are found. This can be disabled.

OptionalonClear

onClear?: (() => void)

Callback triggered when the input is empty.

OptionalonClick

onClick?: ((feature: Feature) => void)

Callback triggered when the user click on a result.

Type declaration

    • (feature): void

    • Parameters

      • feature: Feature

        The feature selected by the user

      Returns void

OptionalonClose

onClose?: (() => void)

Callback triggered when the result list is closed/cleared.

OptionalonError

onError?: ((error: any) => void)

Callback triggered when Jawg Places API returns an error.

OptionalonFeatures

onFeatures?: ((features: Feature[]) => void)

Callback triggered when Jawg Places API returns without error.

Type declaration

    • (features): void

    • Parameters

      • features: Feature[]

        The list of features returned by Jawg Places API

      Returns void

Optionalplaceholder

placeholder?: string

Placeholder text to add when the input in generated by the library.

OptionalresultContainer

resultContainer?: string | HTMLElement

The custom <div> that will contain the geocoding results. By default the container is created by Jawg Places JS. With some frameworks/UI libs such as React, you can't use the ref here.

Optionalreverse

reverse?: ReverseOptions

Option to activate reverse geocoding withing the input. You can paste coordinates in the form {lat}/{lon} in the input. The separation can be either / (slash), , (comma) or (space).

OptionalsearchOnTyping

searchOnTyping?: boolean

Set this to true to activate search on typing, this will also use autocomplete search. Default value is false, you will need to press Enter to validate your search.

OptionalshowResultIcons

showResultIcons?: boolean

Show icon at the left each results.

Optionalsize

size?: number

Set the default number of results. Default value is 10.

Optionalsources

sources?:
    | string
    | string[]
    | (() => string[])
    | (() => string)

Filter the originating source of the data. Sources can be static or dynamic with the function.

Optionaltransition

transition?: MapGLTransitionOptions

Option to configure transition on result selection.

Settings

Member Visibility

On This Page

Properties