Package com.vaadin.flow.component.geolocation

Class Geolocation

java.lang.Object
com.vaadin.flow.component.geolocation.Geolocation
All Implemented Interfaces:
Serializable
public class Geolocation extends Object implements Serializable
Facade for the browser's Geolocation API. Obtain via UI.getGeolocation().

Every entry point on this class is asynchronous: calling it enqueues a request to the browser and returns immediately. The browser answers later (after the user responds to a permission prompt, after the operating system reports a position, or after a timeout), and Flow invokes the callback or updates the signal on the UI thread.

Two usage modes:

Availability check:
  • availabilitySignal() — reactive signal of whether the feature is usable and what permission state the origin has. Subscribe with Signal.effect(owner, ...) to react to changes, or call availabilitySignal().peek() for a snapshot.

Permission prompts. The first time the application asks for a location, the browser shows its own permission dialog. The dialog is controlled by the browser, not by Flow — Flow cannot style it, suppress it, or detect when it is shown. If the user denies the prompt the callback receives a GeolocationError whose errorCode is GeolocationErrorCode.PERMISSION_DENIED.

One-shot example: 

 Button locate = new Button("Use my location");
 locate.addClickListener(
         e -> e.getUI().getGeolocation()
                 .get(pos -> showNearest(pos.coords().latitude(),
                         pos.coords().longitude()),
                         err -> showManualEntry()));

Tracking example: 

 GeolocationTracker tracker = UI.getCurrent().getGeolocation().track(this);
 Signal.effect(this, () -> {
     switch (tracker.valueSignal().get()) {
     case GeolocationPending p -> {
         // waiting for first reading
     }
     case GeolocationPosition pos ->
         map.setCenter(new Coordinate(pos.coords().longitude(),
                 pos.coords().latitude()));
     case GeolocationError err -> showError(err.message());
     }
 });
See Also: