@maptiler/geocoding-control 2.0.0-rc.2 → 2.0.0-rc.3

package/svelte/FeatureItem.svelte.d.ts

@@ -1,10 +1,10 @@
 import { SvelteComponent } from "svelte";
-import type { Feature } from "./types";
+import type { Feature, ShowPlaceType } from "./types";
 declare const __propDef: {
     props: {
         feature: Feature;
         selected?: boolean;
-        showPlaceType: "never" | "always" | "if-needed";
+        showPlaceType: ShowPlaceType;
         missingIconsCache: Set<string>;
         iconsBaseUrl: string;
     };

package/svelte/GeocodingControl.svelte

@@ -43,7 +43,7 @@ export let clearOnBlur = false;
 export let collapsed = false;
 export let country = undefined;
 export let debounceSearch = 200;
-export let enableReverse = false;
+export let reverse = "never";
 export let errorMessage = "Something went wrong…";
 export let filter = () => true;
 export let flyTo = true;
@@ -57,7 +57,7 @@ export let placeholder = "Search";
 export let proximity = [
     { type: "server-geolocation" },
 ];
-export let reverseActive = enableReverse === "always";
+export let reverseActive = reverse === "always";
 export let reverseButtonTitle = "toggle reverse geocoding";
 export let searchValue = "";
 export let pickedResultStyle = "full-geometry";
@@ -74,7 +74,7 @@ export let zoom = ZOOM_DEFAULTS;
 export let apiUrl = "https://api.maptiler.com/geocoding";
 export let fetchParameters = {};
 export let iconsBaseUrl = "https://cdn.maptiler.com/maptiler-geocoding-control/v" +
-    "2.0.0-rc.2" +
+    "2.0.0-rc.3" +
     "/icons/";
 export let adjustUrlQuery = () => { };
 export function focus() {
@@ -123,7 +123,7 @@ let prevIdToFly;
 const missingIconsCache = new Set();
 const dispatch = createEventDispatcher();
 $: {
-    reverseActive = enableReverse === "always";
+    reverseActive = reverse === "always";
 }
 $: if (pickedResultStyle !== "marker-only" &&
     picked &&
@@ -464,7 +464,7 @@ function computeZoom(feature) {
         : undefined) ?? zoom[index]);
 }
 function handleReverse(coordinates) {
-    reverseActive = enableReverse === "always";
+    reverseActive = reverse === "always";
     listFeatures = undefined;
     picked = undefined;
     selectedItemIndex = -1;
@@ -570,7 +570,7 @@ function pick(feature) {
       {/if}
     </div>
 
-    {#if enableReverse === true}
+    {#if reverse !== "never"}
       <button
         type="button"
         class:active={reverseActive}

package/svelte/GeocodingControl.svelte.d.ts

@@ -1,5 +1,5 @@
 import { SvelteComponent } from "svelte";
-import type { BBox, Feature, FeatureCollection, MapController, ProximityRule } from "./types";
+import type { BBox, EnableReverse, Feature, FeatureCollection, MapController, PickedResultStyle, ProximityRule, ShowPlaceType } from "./types";
 declare const __propDef: {
     props: {
         ZOOM_DEFAULTS?: Record<string, number>;
@@ -11,7 +11,7 @@ declare const __propDef: {
         collapsed?: boolean;
         country?: string | string[] | undefined;
         debounceSearch?: number;
-        enableReverse?: boolean | "always";
+        reverse?: EnableReverse;
         errorMessage?: string;
         filter?: (feature: Feature) => boolean;
         flyTo?: boolean;
@@ -26,8 +26,8 @@ declare const __propDef: {
         reverseActive?: boolean;
         reverseButtonTitle?: string;
         searchValue?: string;
-        pickedResultStyle?: "marker-only" | "full-geometry" | "full-geometry-including-polygon-center-marker";
-        showPlaceType?: "never" | "always" | "if-needed";
+        pickedResultStyle?: PickedResultStyle;
+        showPlaceType?: ShowPlaceType;
         showResultsWhileTyping?: boolean;
         autocompleteTimeout?: number | undefined;
         selectFirst?: boolean;

package/svelte/types.d.ts

@@ -99,6 +99,7 @@ export type ControlOptions = {
     noResultsMessage?: string;
     /**
      * Minimum number of characters to enter before results are shown.
+     *
      * Default value is `2`.
      */
     minLength?: number;
@@ -135,7 +136,7 @@ export type ControlOptions = {
     /**
      * Set to `false` to disable fuzzy search.
      *
-     * Default value is `true`
+     * Default value is `true`.
      */
     fuzzyMatch?: boolean;
     /**
@@ -149,17 +150,21 @@ export type ControlOptions = {
     zoom?: Record<string, number>;
     /**
      * If `true`, the geocoder control will collapse until hovered or in focus.
+     *
      * Default value is `false`.
      */
     collapsed?: boolean;
     /**
      * If true, the geocoder control will clear its value when the input blurs.
+     *
      * Default value is `false`.
      */
     clearOnBlur?: 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.
+     *
+     * Default value is a function returning always `true`.
      */
     filter?: (feature: Feature) => boolean;
     /**
@@ -169,13 +174,13 @@ export type ControlOptions = {
      */
     class?: string;
     /**
-     * Set to `true` to enable reverse geocoding button with title. Set to `"always"` to reverse geocoding be always active.
+     * Set to `button` to enable reverse geocoding button with title. Set to `"always"` to reverse geocoding be always active.
      *
-     * Default value is `false`
+     * Default value is `"never"`.
      */
-    enableReverse?: boolean | "always";
+    enableReverse?: EnableReverse;
     /**
-     * Reverse mode.
+     * Reverse mode active.
      *
      * Default value is `false`.
      */
@@ -198,7 +203,7 @@ export type ControlOptions = {
      *
      * Default value is `"if-needed"`.
      */
-    showPlaceType?: "never" | "always" | "if-needed";
+    showPlaceType?: ShowPlaceType;
     /**
      * Style of the picked result on the map:
      *
@@ -208,7 +213,7 @@ export type ControlOptions = {
      *
      * Default value is `true`.
      */
-    pickedResultStyle?: "marker-only" | "full-geometry" | "full-geometry-including-polygon-center-marker";
+    pickedResultStyle?: PickedResultStyle;
     /**
      * Limit search to specified country(ies).
      *
@@ -277,6 +282,9 @@ export type ControlOptions = {
      */
     markerOnSelected?: boolean;
 };
+export type PickedResultStyle = "marker-only" | "full-geometry" | "full-geometry-including-polygon-center-marker";
+export type EnableReverse = "never" | "always" | "button";
+export type ShowPlaceType = "never" | "always" | "if-needed";
 export type DispatcherTypeCC = {
     featuresListed: {
         features: Feature[] | undefined;

package/types.d.ts

@@ -99,6 +99,7 @@ export type ControlOptions = {
     noResultsMessage?: string;
     /**
      * Minimum number of characters to enter before results are shown.
+     *
      * Default value is `2`.
      */
     minLength?: number;
@@ -135,7 +136,7 @@ export type ControlOptions = {
     /**
      * Set to `false` to disable fuzzy search.
      *
-     * Default value is `true`
+     * Default value is `true`.
      */
     fuzzyMatch?: boolean;
     /**
@@ -149,17 +150,21 @@ export type ControlOptions = {
     zoom?: Record<string, number>;
     /**
      * If `true`, the geocoder control will collapse until hovered or in focus.
+     *
      * Default value is `false`.
      */
     collapsed?: boolean;
     /**
      * If true, the geocoder control will clear its value when the input blurs.
+     *
      * Default value is `false`.
      */
     clearOnBlur?: 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.
+     *
+     * Default value is a function returning always `true`.
      */
     filter?: (feature: Feature) => boolean;
     /**
@@ -169,13 +174,13 @@ export type ControlOptions = {
      */
     class?: string;
     /**
-     * Set to `true` to enable reverse geocoding button with title. Set to `"always"` to reverse geocoding be always active.
+     * Set to `button` to enable reverse geocoding button with title. Set to `"always"` to reverse geocoding be always active.
      *
-     * Default value is `false`
+     * Default value is `"never"`.
      */
-    enableReverse?: boolean | "always";
+    enableReverse?: EnableReverse;
     /**
-     * Reverse mode.
+     * Reverse mode active.
      *
      * Default value is `false`.
      */
@@ -198,7 +203,7 @@ export type ControlOptions = {
      *
      * Default value is `"if-needed"`.
      */
-    showPlaceType?: "never" | "always" | "if-needed";
+    showPlaceType?: ShowPlaceType;
     /**
      * Style of the picked result on the map:
      *
@@ -208,7 +213,7 @@ export type ControlOptions = {
      *
      * Default value is `true`.
      */
-    pickedResultStyle?: "marker-only" | "full-geometry" | "full-geometry-including-polygon-center-marker";
+    pickedResultStyle?: PickedResultStyle;
     /**
      * Limit search to specified country(ies).
      *
@@ -277,6 +282,9 @@ export type ControlOptions = {
      */
     markerOnSelected?: boolean;
 };
+export type PickedResultStyle = "marker-only" | "full-geometry" | "full-geometry-including-polygon-center-marker";
+export type EnableReverse = "never" | "always" | "button";
+export type ShowPlaceType = "never" | "always" | "if-needed";
 export type DispatcherTypeCC = {
     featuresListed: {
         features: Feature[] | undefined;