@maptiler/geocoding-control 1.4.2-dev.2 → 2.0.0

package/leaflet.d.ts

@@ -1,34 +1,70 @@
 import * as L from "leaflet";
-import type { ControlOptions } from "./types";
+import type { ControlOptions, Feature } from "./types";
 export { createLeafletMapController } from "./leaflet-controller";
 type LeafletControlOptions = ControlOptions & L.ControlOptions & {
     /**
-     * If `true`, a [Marker](https://leafletjs.com/reference.html#marker) will be added to the map at the location of the user-selected result using a default set of Marker options.
-     * If the value is an object, the marker will be constructed using these options.
-     * If `false`, no marker will be added to the map.
+     * Marker to be added to the map at the location of the user-selected result using a default set of Marker options.
+     *
+     * - If `true` or `undefined` then a default marker will be used.\
+     * - If the value is [MarkerOptions](https://leafletjs.com/reference.html#marker-option) then the marker will be constructed using these options.
+     * - If the value is a function then it can create and configure custom [Marker](https://leafletjs.com/reference.html#marker),
+     *     add it to the [Map](https://leafletjs.com/reference.html#map) and return it.
+     *   Function accepts [Map](https://leafletjs.com/reference.html#map) and `Feature` as parameters.
+     *   Feature is `undefined` for the reverse location marker.
+     * - If `false` or `null` then no marker will be added to the map.
+     *
      * Default value is `true`.
      */
-    marker?: boolean | L.MarkerOptions;
+    marker?: null | boolean | L.MarkerOptions | ((map: L.Map, feature?: Feature) => L.Marker | undefined | null);
     /**
-     * If `true`, [Markers](https://leafletjs.com/reference.html#marker) will be added to the map at the location the top results for the query.
-     * If the value is an object, the marker will be constructed using these options.
-     * If `false`, no marker will be added to the map.
+     * Marker be added to the map at the location the geocoding results.
+     *
+     * - If `true` or `undefined` then a default marker will be used.
+     * - If the value is [MarkerOptions](https://leafletjs.com/reference.html#marker-option) then the marker will be constructed using these options.
+     * - If the value is a function then it can create and configure custom [Marker](https://leafletjs.com/reference.html#marker),
+     *     add it to the [Map](https://leafletjs.com/reference.html#map) and return it.
+     *   In this case the default pop-up won't be added to the marker.
+     *   Function accepts [Map](https://leafletjs.com/reference.html#map) and `Feature` as parameters.
+     * - If `false` or `null` then no marker will be added to the map.
+     *
      * Default value is `true`.
      */
-    showResultMarkers?: boolean | L.MarkerOptions;
+    showResultMarkers?: null | boolean | L.MarkerOptions | ((map: L.Map, feature: Feature) => L.Marker | undefined | null);
     /**
-     * If `false`, animating the map to a selected result is disabled.
-     * If `true`, animating the map will use the default animation parameters.
-     * If an object, it will be passed as options to the map `flyTo` or `fitBounds` method providing control over the animation of the transition.
+     * Animation to selected feature on the map.
+     *
+     * - If `false` or `null` then animating the map to a selected result is disabled.
+     * - If `true` or `undefined` then animating the map will use the default animation parameters.
+     * - If an [ZoomPanOptions](https://leafletjs.com/reference.html#zoom/pan-options)
+     *     ` & `[FitBoundsOptions](https://leafletjs.com/reference.html#fitbounds-options) then it will be passed as options
+     *     to the map [flyTo](https://leafletjs.com/reference.html#map-flyto)
+     *     or [fitBounds](https://leafletjs.com/reference.html#map-fitbounds) method providing control over the animation of the transition.
+     *
      * Default value is `true`.
      */
-    flyTo?: boolean | (L.ZoomPanOptions & L.FitBoundsOptions);
+    flyTo?: null | boolean | (L.ZoomPanOptions & L.FitBoundsOptions);
     /**
-     * Style for full feature geometry GeoJSON.
+     * Style for the full feature geometry.
+     *
+     * - If `false` or `null` then no full geometry is drawn.
+     * - If `true` or `undefined` then default-styled full geometry is drawn.
+     * - If an [PathOptions](https://leafletjs.com/reference.html#path-option) then it will be used to style the full geometry.
+     * - If a function accepting a `Feature` and returning [PathOptions](https://leafletjs.com/reference.html#path-option)
+     *     then it must teturn the style and will be used to style the full geometry.
      */
-    fullGeometryStyle?: L.PathOptions | L.StyleFunction;
+    fullGeometryStyle?: null | boolean | L.PathOptions | L.StyleFunction;
 };
-export declare class GeocodingControl extends L.Control {
+/**
+ * Leaflet mixins https://leafletjs.com/reference.html#class
+ * for TypeScript https://www.typescriptlang.org/docs/handbook/mixins.html
+ * @internal
+ */
+declare class EventedControl {
+    constructor(...args: unknown[]);
+}
+interface EventedControl extends L.Control, L.Evented {
+}
+export declare class GeocodingControl extends EventedControl {
     #private;
     constructor(options: LeafletControlOptions);
     onAdd(map: L.Map): HTMLDivElement;