@maptiler/geocoding-control 2.0.1 → 2.1.0-rc1

package/svelte/openlayers-controller.js

@@ -191,7 +191,7 @@ export function createOpenLayersMapController(map, flyToOptions = {}, flyToBound
             if (reverseMarker) {
                 source.addFeature(reverseMarker);
             }
-            if (picked) {
+            block: if (picked) {
                 let handled = false;
                 if (picked.geometry.type === "GeometryCollection") {
                     const geoms = picked.geometry.geometries
@@ -229,14 +229,14 @@ export function createOpenLayersMapController(map, flyToOptions = {}, flyToBound
                 }
                 else if (picked.geometry.type === "LineString") {
                     source.addFeature(new OlFeature(fromWgs84(new OlLineString(picked.geometry.coordinates))));
-                    return; // no pin for (multi)linestrings
+                    break block; // no pin for (multi)linestrings
                 }
                 else if (picked.geometry.type === "MultiLineString") {
                     source.addFeature(new OlFeature(fromWgs84(new OlMultiLineString(picked.geometry.coordinates))));
-                    return; // no pin for (multi)linestrings
+                    break block; // no pin for (multi)linestrings
                 }
                 if (!showPolygonMarker && picked.geometry.type !== "Point") {
-                    return;
+                    break block;
                 }
                 source.addFeature(new OlFeature(fromWgs84(new OlPoint(picked.center))));
             }

package/svelte/openlayers.d.ts

@@ -36,11 +36,42 @@ export declare class GeocodingControl extends Control {
     un: CustomObjectOnSignature<EventsKey>;
     constructor(options: OpenLayersControlOptions);
     setMap(map: Map | null): void;
+    /**
+     * Update the control options.
+     *
+     * @param options options to update
+     */
     setOptions(options: OpenLayersControlOptions): void;
+    /**
+     * Set the content of search input box.
+     *
+     * @param value text to set
+     * @param submit perform the search
+     */
     setQuery(value: string, submit?: boolean): void;
+    /**
+     * Clear geocoding search results from the map.
+     */
     clearMap(): void;
+    /**
+     * Clear search result list.
+     */
     clearList(): void;
-    focus(): void;
+    /**
+     * Set reverse geocoding mode.
+     *
+     * @param reverseActive reverse geocoding active
+     */
+    setReverseMode(reverseActive: boolean): void;
+    /**
+     * Focus the search input box.
+     *
+     * @param options [FocusOptions](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus#options)
+     */
+    focus(options?: FocusOptions): void;
+    /**
+     * Blur the search input box.
+     */
     blur(): void;
 }
 export declare class SelectEvent extends BaseEvent {

package/svelte/openlayers.js

@@ -61,6 +61,11 @@ export class GeocodingControl extends Control {
             this.#gc?.$set({ mapController });
         }
     }
+    /**
+     * Update the control options.
+     *
+     * @param options options to update
+     */
     setOptions(options) {
         Object.assign(this.#options, options);
         const { flyTo, fullGeometryStyle, ...restOptions } = this.#options;
@@ -69,18 +74,46 @@ export class GeocodingControl extends Control {
             flyTo: flyTo === undefined ? true : !!flyTo,
         });
     }
+    /**
+     * Set the content of search input box.
+     *
+     * @param value text to set
+     * @param submit perform the search
+     */
     setQuery(value, submit = true) {
         this.#gc?.setQuery(value, submit);
     }
+    /**
+     * Clear geocoding search results from the map.
+     */
     clearMap() {
         this.#gc?.clearMap();
     }
+    /**
+     * Clear search result list.
+     */
     clearList() {
         this.#gc?.clearList();
     }
-    focus() {
-        this.#gc?.focus();
-    }
+    /**
+     * Set reverse geocoding mode.
+     *
+     * @param reverseActive reverse geocoding active
+     */
+    setReverseMode(reverseActive) {
+        this.#gc?.$set({ reverseActive });
+    }
+    /**
+     * Focus the search input box.
+     *
+     * @param options [FocusOptions](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus#options)
+     */
+    focus(options) {
+        this.#gc?.focus(options);
+    }
+    /**
+     * Blur the search input box.
+     */
     blur() {
         this.#gc?.blur();
     }

package/svelte/react.d.ts

@@ -9,11 +9,37 @@ type MapControllerProp = {
 };
 export type Props = ControlOptions & CallbackProperties<DispatcherTypeCC> & MapControllerProp;
 export type Methods = {
+    /**
+     * Blur the search input box.
+     */
     blur(): void;
-    focus(): void;
+    /**
+     * Focus the search input box.
+     *
+     * @param options [FocusOptions](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus#options)
+     */
+    focus(options?: FocusOptions): void;
+    /**
+     * Set the content of search input box.
+     *
+     * @param value text to set
+     * @param submit perform the search
+     */
     setQuery(value: string, submit?: boolean): void;
+    /**
+     * Clear geocoding search results from the map.
+     */
     clearMap(): void;
+    /**
+     * Clear search result list.
+     */
     clearList(): void;
+    /**
+     * Set reverse geocoding mode.
+     *
+     * @param reverseActive reverse geocoding active
+     */
+    setReverseMode(reverseActive: boolean): void;
 };
 declare const ReactGeocodingControl: import("react").ForwardRefExoticComponent<ControlOptions & CallbackProperties<DispatcherTypeCC> & MapControllerProp & import("react").RefAttributes<Methods>>;
 export { ReactGeocodingControl as GeocodingControl };

package/svelte/react.js

@@ -12,9 +12,13 @@ const eventNames = [
 ];
 const propertyNames = [
     "adjustUrlQuery",
+    "adjustUrl",
     "apiKey",
+    "apiUrl",
     "bbox",
+    "class",
     "clearButtonTitle",
+    "clearListOnPick",
     "clearOnBlur",
     "collapsed",
     "country",
@@ -22,11 +26,17 @@ const propertyNames = [
     "enableReverse",
     "errorMessage",
     "excludeTypes",
+    "exhaustiveReverseGeocoding",
+    "fetchParameters",
     "filter",
+    "flyToSelected",
     "fuzzyMatch",
+    "iconsBaseUrl",
+    "keepListOpen",
     "language",
     "limit",
     "mapController",
+    "markerOnSelected",
     "minLength",
     "noResultsMessage",
     "pickedResultStyle",
@@ -34,6 +44,7 @@ const propertyNames = [
     "proximity",
     "reverseActive",
     "reverseButtonTitle",
+    "selectFirst",
     "showPlaceType",
     "showResultsWhileTyping",
     "types",
@@ -45,8 +56,8 @@ function getEventFnName(name) {
         name.slice(1));
 }
 const ReactGeocodingControl = forwardRef(function ReactGeocodingControl(props, ref) {
-    const divRef = useRef();
-    const controlRef = useRef();
+    const divRef = useRef(undefined);
+    const controlRef = useRef(undefined);
     const options = { ...props };
     for (const eventName of eventNames) {
         // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
@@ -75,7 +86,7 @@ const ReactGeocodingControl = forwardRef(function ReactGeocodingControl(props, r
     for (const eventName of eventNames) {
         const eventHandlerFn = props[getEventFnName(eventName)];
         useEffect(() => eventHandlerFn &&
-            controlRef.current?.$on(eventName, (e) => {
+            controlRef.current?.$on(eventName.toLowerCase(), (e) => {
                 eventHandlerFn(e.detail);
             }), [eventHandlerFn]);
     }
@@ -83,8 +94,9 @@ const ReactGeocodingControl = forwardRef(function ReactGeocodingControl(props, r
         setQuery: (value, submit = true) => controlRef.current?.setQuery(value, submit),
         clearMap: () => controlRef.current?.clearMap(),
         clearList: () => controlRef.current?.clearList(),
-        focus: () => controlRef.current?.focus(),
+        focus: (options) => controlRef.current?.focus(options),
         blur: () => controlRef.current?.blur(),
+        setReverseMode: (reverseActive) => controlRef.current?.$set({ reverseActive }),
     }));
     return createElement("div", { ref: divRef });
 });

package/svelte/types.d.ts

@@ -154,11 +154,23 @@ export type ControlOptions = {
      */
     collapsed?: boolean;
     /**
-     * If true, the geocoder control will clear its value when the input blurs.
+     * If `true`, the geocoder control will clear its value when the input blurs.
      *
      * Default value is `false`.
      */
     clearOnBlur?: boolean;
+    /**
+     * If `true`, then after picking a result from the list or map the list will be cleared and not re-displayed on input box focus.
+     *
+     * Default value is `false`.
+     */
+    clearListOnPick?: boolean;
+    /**
+     * Keep the list open even if the control is not focused.
+     *
+     * Default value is `false`.
+     */
+    keepListOpen?: boolean;
     /**
      * A function which accepts a Feature in the Carmen GeoJSON format to filter out results from the Geocoding API response before they are included in the suggestions list.
      * Return true to keep the item, false otherwise.
@@ -260,8 +272,18 @@ export type ControlOptions = {
      * Function to adjust URL search parameters.
      *
      * Default value is empty function.
+     *
+     * @deprecated use `adjustUrl`
      */
     adjustUrlQuery?: (sp: URLSearchParams) => void;
+    /**
+     * Function to adjust geocoding URL before the fetch.
+     *
+     * @param url [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) parameter which can be modified
+     *
+     * Default value is empty function.
+     */
+    adjustUrl?: (url: URL) => void;
     /**
      * Automatically select the first feature from the result list.
      *

package/svelte/vanilla.d.ts

@@ -17,11 +17,42 @@ export declare class GeocodingControl extends EventTarget {
     constructor({ target, ...options }: Options & {
         target: HTMLElement;
     });
+    /**
+     * Update the control options.
+     *
+     * @param options options to update
+     */
     setOptions(options: Partial<Options>): void;
+    /**
+     * Set the content of search input box.
+     *
+     * @param value text to set
+     * @param submit perform the search
+     */
     setQuery(value: string, submit?: boolean): void;
+    /**
+     * Clear geocoding search results from the map.
+     */
     clearMap(): void;
+    /**
+     * Clear search result list.
+     */
     clearList(): void;
-    focus(): void;
+    /**
+     * Set reverse geocoding mode.
+     *
+     * @param reverseActive reverse geocoding active
+     */
+    setReverseMode(reverseActive: boolean): void;
+    /**
+     * Focus the search input box.
+     *
+     * @param options [FocusOptions](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus#options)
+     */
+    focus(options?: FocusOptions): void;
+    /**
+     * Blur the search input box.
+     */
     blur(): void;
     addEventListener<K extends keyof CustomEventMap>(type: K, callback: CustomEventListenerOrEventListenerObject<K> | null, options?: AddEventListenerOptions | boolean): void;
     removeEventListener<K extends keyof CustomEventMap>(type: K, callback: CustomEventListenerOrEventListenerObject<K> | null, options?: EventListenerOptions | boolean): void;

package/svelte/vanilla.js

@@ -33,21 +33,54 @@ export class GeocodingControl extends EventTarget {
         });
         finalizationRegistry.register(this, this.#gc);
     }
+    /**
+     * Update the control options.
+     *
+     * @param options options to update
+     */
     setOptions(options) {
         this.#gc.$set(options);
     }
+    /**
+     * Set the content of search input box.
+     *
+     * @param value text to set
+     * @param submit perform the search
+     */
     setQuery(value, submit = true) {
         this.#gc?.setQuery(value, submit);
     }
+    /**
+     * Clear geocoding search results from the map.
+     */
     clearMap() {
         this.#gc?.clearMap();
     }
+    /**
+     * Clear search result list.
+     */
     clearList() {
         this.#gc?.clearList();
     }
-    focus() {
-        this.#gc?.focus();
+    /**
+     * Set reverse geocoding mode.
+     *
+     * @param reverseActive reverse geocoding active
+     */
+    setReverseMode(reverseActive) {
+        this.#gc?.$set({ reverseActive });
     }
+    /**
+     * Focus the search input box.
+     *
+     * @param options [FocusOptions](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus#options)
+     */
+    focus(options) {
+        this.#gc?.focus(options);
+    }
+    /**
+     * Blur the search input box.
+     */
     blur() {
         this.#gc?.blur();
     }

package/types.d.ts

@@ -154,11 +154,23 @@ export type ControlOptions = {
      */
     collapsed?: boolean;
     /**
-     * If true, the geocoder control will clear its value when the input blurs.
+     * If `true`, the geocoder control will clear its value when the input blurs.
      *
      * Default value is `false`.
      */
     clearOnBlur?: boolean;
+    /**
+     * If `true`, then after picking a result from the list or map the list will be cleared and not re-displayed on input box focus.
+     *
+     * Default value is `false`.
+     */
+    clearListOnPick?: boolean;
+    /**
+     * Keep the list open even if the control is not focused.
+     *
+     * Default value is `false`.
+     */
+    keepListOpen?: boolean;
     /**
      * A function which accepts a Feature in the Carmen GeoJSON format to filter out results from the Geocoding API response before they are included in the suggestions list.
      * Return true to keep the item, false otherwise.
@@ -260,8 +272,18 @@ export type ControlOptions = {
      * Function to adjust URL search parameters.
      *
      * Default value is empty function.
+     *
+     * @deprecated use `adjustUrl`
      */
     adjustUrlQuery?: (sp: URLSearchParams) => void;
+    /**
+     * Function to adjust geocoding URL before the fetch.
+     *
+     * @param url [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) parameter which can be modified
+     *
+     * Default value is empty function.
+     */
+    adjustUrl?: (url: URL) => void;
     /**
      * Automatically select the first feature from the result list.
      *

package/vanilla.d.ts

@@ -17,11 +17,42 @@ export declare class GeocodingControl extends EventTarget {
     constructor({ target, ...options }: Options & {
         target: HTMLElement;
     });
+    /**
+     * Update the control options.
+     *
+     * @param options options to update
+     */
     setOptions(options: Partial<Options>): void;
+    /**
+     * Set the content of search input box.
+     *
+     * @param value text to set
+     * @param submit perform the search
+     */
     setQuery(value: string, submit?: boolean): void;
+    /**
+     * Clear geocoding search results from the map.
+     */
     clearMap(): void;
+    /**
+     * Clear search result list.
+     */
     clearList(): void;
-    focus(): void;
+    /**
+     * Set reverse geocoding mode.
+     *
+     * @param reverseActive reverse geocoding active
+     */
+    setReverseMode(reverseActive: boolean): void;
+    /**
+     * Focus the search input box.
+     *
+     * @param options [FocusOptions](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus#options)
+     */
+    focus(options?: FocusOptions): void;
+    /**
+     * Blur the search input box.
+     */
     blur(): void;
     addEventListener<K extends keyof CustomEventMap>(type: K, callback: CustomEventListenerOrEventListenerObject<K> | null, options?: AddEventListenerOptions | boolean): void;
     removeEventListener<K extends keyof CustomEventMap>(type: K, callback: CustomEventListenerOrEventListenerObject<K> | null, options?: EventListenerOptions | boolean): void;