Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/datvm/jspermissionhandler
A MAUI Blazor library to simplify permission management for Blazor Javascript APIs like camera, microphone (getUserMedia) or geolocation
https://github.com/datvm/jspermissionhandler
blazor camera geolocation getusermedia javascript maui maui-blazor microphone permissions
Last synced: 8 days ago
JSON representation
A MAUI Blazor library to simplify permission management for Blazor Javascript APIs like camera, microphone (getUserMedia) or geolocation
- Host: GitHub
- URL: https://github.com/datvm/jspermissionhandler
- Owner: datvm
- License: mit
- Created: 2023-11-19T00:11:28.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2023-11-19T03:07:48.000Z (12 months ago)
- Last Synced: 2024-10-06T07:38:05.858Z (about 1 month ago)
- Topics: blazor, camera, geolocation, getusermedia, javascript, maui, maui-blazor, microphone, permissions
- Language: C#
- Homepage:
- Size: 214 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
This is a MAUI Blazor library to simplify permission management for Blazor Javascript APIs like camera, microphone (through `getUserMedia`) or `geolocation`. This is accomplished hugely thanks to [MackinnonBuck/MauiBlazorPermissionsExample](https://github.com/MackinnonBuck/MauiBlazorPermissionsExample). It worked for many of my projects so it's time to pack it to easily reuse it.
This library is highly customizable and extensible. Most methods are `virtual` and can be overriden to fit your needs.
See a full demo project at [project Github](https://github.com/datvm/JsPermissionHandler/tree/master/JsPermissionHandlerDemo).
This package does not support Tizen.
# Installation
Install the [NuGet package](https://www.nuget.org/packages/JsPermissionHandler) in your project:
```ps
dotnet add package JsPermissionHandler
```
# Setup Permissions
## Windows
You do not need to do anything special to use this library on Windows.
## Android
Add permissions to your `AndroidManifest.xml` file (in `Platforms/Android`).
```xml
```
Note: only add what you need. For `getUserMedia` with audio, you need both `RECORD_AUDIO` and `MODIFY_AUDIO_SETTINGS`.
## iOS
Add permissions to your `Info.plist` file (in `Platforms/iOS`).
```xml
NSLocationWhenInUseUsageDescription
This app requires access to your location. Please grant access to your precise location when requested.
NSCameraUsageDescription
This app requires access to your camera. Please grant access to your camera when requested.
NSMicrophoneUsageDescription
This app requires access to your microphone. Please grant access to your microphone when requested.
```
# Add the Handler to your WebView
In your `MainPage.xaml.cs` file, add the following code:
```cs
public MainPage()
{
InitializeComponent();
new BlazorWebViewHandler()
// Add whichever you need:
.AddCamera()
.AddMicrophone()
.AddGeolocation()
// blazorWebView is the name of your BlazorWebView
.AddInitializingHandler(blazorWebView);
}
```
And that's it, you can now use your Javascript APIs in the Blazor Webview.
# Additional permissions
The default `BlazorWebViewHandler` gives the three common permissions call `AddCamera`, `AddMicrophone` and `AddGeolocation`. If you need more, you need to inherit `PermissionHandler` and add your own. This is only needed for Android. For example:
```cs
// MyHandler.Android.cs
public class MyHandler : PermissionHandler
{
public MyHandler AddMyPermission() =>
AddWebkitPermission(
[
(Manifest.Permission.ModifyAudioSettings, null),
(Manifest.Permission.RecordAudio, rationale),
],
PermissionRequest.ResourceAudioCapture
);
}
```
# Opening Permission panel
Usually working with permissions flow requires to open the permission panel especially when user denies your app access to permission. This is done with the `PermissionHandler.OpenAppPermissionPanelAsync` static method.
```cs
public static partial Task OpenAppPermissionPanelAsync(string? windowsScheme = null);
```
- `windowsScheme` is used on Windows only. You can specify which [Windows Settings panel](https://learn.microsoft.com/en-us/windows/uwp/launch-resume/launch-settings-app#ms-settings-uri-scheme-reference) to open. If `null`, the default is `ms-settings:appsfeatures-app` to open the settings of the current app (which would include permissions).
- On Android, this method opens the app settings panel. It's not possible to open the permission panel directly.
- On iOS, this method opens the app settings panel which includes the permissions.