👁 Image
Blazor.Geolocation.WebAssembly 10.0.0

Blazorators: The Source Generated geolocation JavaScript Interop library for Blazor WebAssembly

The Blazor.Geolocation.WebAssembly package consumes the Blazor.SourceGenerators package. It exposes a source generated IGeolocation interface specific to Blazor WebAssembly and the geolocation Web API.

Get started

After the NuGet package is added as a reference, call the AddGeolocationServices method to register the IGeolocationService service type.

using Microsoft.AspNetCore.Components.Web;
using Microsoft.AspNetCore.Components.WebAssembly.Hosting;

var builder = WebAssemblyHostBuilder.CreateDefault(args);
builder.RootComponents.Add<App>("#app");
builder.RootComponents.Add<HeadOutlet>("head::after");

builder.Services.AddScoped(
 sp => new HttpClient
 {
 BaseAddress = new Uri(builder.HostEnvironment.BaseAddress)
 });

builder.Services.AddGeolocationServices();

await builder.Build().RunAsync();

Anywhere needed within your Razor component, or Blazor client code — either @inject or [Inject] the IGeolocationService type. The interface takes the following shape:

#nullable enable
namespace Microsoft.JSInterop;

/// <summary>
/// Source generated interface definition of the <c>Geolocation</c> type.
/// </summary>
public interface IGeolocationService
{
	/// <summary>
	/// Source generated implementation of <c>window.navigator.geolocation.clearWatch</c>.
	/// <a href="https://developer.mozilla.org/docs/Web/API/Geolocation/clearWatch"></a>
	/// </summary>
	void ClearWatch(double watchId);

	/// <summary>
	/// Source generated implementation of <c>window.navigator.geolocation.getCurrentPosition</c>.
	/// <a href="https://developer.mozilla.org/docs/Web/API/Geolocation/getCurrentPosition"></a>
	/// </summary>
	/// <param name="component">The calling Razor (or Blazor) component.</param>
	/// <param name="onSuccessCallbackMethodName">Expects the name of a 
 /// <c>"JSInvokableAttribute"</c> C# method with the following 
 /// <c>System.Action{GeolocationPosition}"</c>.</param>
	/// <param name="onErrorCallbackMethodName">Expects the name of a 
 /// <c>"JSInvokableAttribute"</c> C# method with the following 
 /// <c>System.Action{GeolocationPositionError}"</c>.</param>
	/// <param name="options">The <c>PositionOptions</c> value.</param>
	void GetCurrentPosition<TComponent>(
 TComponent component,
 string onSuccessCallbackMethodName,
 string? onErrorCallbackMethodName = null,
 PositionOptions? options = null)
 where TComponent : class;

	/// <summary>
	/// Source generated implementation of <c>window.navigator.geolocation.watchPosition</c>.
	/// <a href="https://developer.mozilla.org/docs/Web/API/Geolocation/watchPosition"></a>
	/// </summary>
	/// <param name="component">The calling Razor (or Blazor) component.</param>
	/// <param name="onSuccessCallbackMethodName">Expects the name of a 
 /// <c>"JSInvokableAttribute"</c> C# method with the following 
 /// <c>System.Action{GeolocationPosition}"</c>.</param>
	/// <param name="onErrorCallbackMethodName">Expects the name of a 
 /// <c>"JSInvokableAttribute"</c> C# method with the following 
 /// <c>System.Action{GeolocationPositionError}"</c>.</param>
	/// <param name="options">The <c>PositionOptions</c> value.</param>
	double WatchPosition<TComponent>(
 TComponent component, 
 string onSuccessCallbackMethodName, 
 string? onErrorCallbackMethodName = null, 
 PositionOptions? options = null) 
 where TComponent : class;
}

Add JavaScript dependency

In the index.html file, add the following:

<script src="_content/Blazor.Geolocation.WebAssembly/blazorators.geolocation.g.js"></script>