maplibre#3103 added showButton option to GeoLocate control

smellman · May 18, 2024 · 8ae3bdb · 8ae3bdb
1 parent 753204c
commit 8ae3bdb
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/src/ui/control/geolocate_control.test.ts b/src/ui/control/geolocate_control.test.ts
@@ -499,4 +499,13 @@ describe('GeolocateControl with no options', () => {
         await zoomendPromise;
         expect(geolocate._circleElement.style.width).toBeTruthy();
     });
+
+    test('don\'t show button if showButton = false', async () => {
+        const geolocate = new GeolocateControl({
+            showButton: false
+        });
+        map.addControl(geolocate);
+        await sleep(0);
+        expect(geolocate._geolocateButton.style.display).toBe('none');
+    });
 });
diff --git a/src/ui/control/geolocate_control.ts b/src/ui/control/geolocate_control.ts
@@ -38,6 +38,11 @@ type GeolocateControlOptions = {
      * @defaultValue true
      */
     showUserLocation?: boolean;
+    /**
+     * If `false` the Geolocate button will not be shown on the map.
+     * @defaultValue true
+     */
+    showButton?: boolean;
 };
 
 const defaultOptions: GeolocateControlOptions = {
@@ -51,7 +56,8 @@ const defaultOptions: GeolocateControlOptions = {
     },
     trackUserLocation: false,
     showAccuracyCircle: true,
-    showUserLocation: true
+    showUserLocation: true,
+    showButton: true
 };
 
 let numberOfWatches = 0;
@@ -488,6 +494,11 @@ export class GeolocateControl extends Evented implements IControl {
         DOM.create('span', 'maplibregl-ctrl-icon', this._geolocateButton).setAttribute('aria-hidden', 'true');
         this._geolocateButton.type = 'button';
 
+        // if showButton is false, don't add the button to the map
+        if (!this.options.showButton) {
+            this._geolocateButton.style.display = 'none';
+        }
+
         if (supported === false) {
             warnOnce('Geolocation support is not available so the GeolocateControl will be disabled.');
             const title = this._map._getUIString('GeolocateControl.LocationNotAvailable');