Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kshyju/browserdetector
Fast & light weight browser detection & device detection for asp.net core and azure functions
https://github.com/kshyju/browserdetector
azure-functions-browser-detection browser-detection browser-detection-in-aspnetcore browser-detector browserdetection detect-browser device-detection device-type-detection devicetypedetection operating-system-detection
Last synced: 16 days ago
JSON representation
Fast & light weight browser detection & device detection for asp.net core and azure functions
- Host: GitHub
- URL: https://github.com/kshyju/browserdetector
- Owner: kshyju
- License: mit
- Created: 2019-08-28T19:13:35.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-02T02:07:35.000Z (11 months ago)
- Last Synced: 2024-01-03T02:59:14.927Z (11 months ago)
- Topics: azure-functions-browser-detection, browser-detection, browser-detection-in-aspnetcore, browser-detector, browserdetection, detect-browser, device-detection, device-type-detection, devicetypedetection, operating-system-detection
- Language: C#
- Homepage:
- Size: 162 KB
- Stars: 29
- Watchers: 5
- Forks: 13
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BrowserDetector
[](https://www.nuget.org/packages/Shyjus.BrowserDetector/)
Browser detection capabilities for asp.net core Web API.
### Supported frameworks
- .NET6.0
- .NET7.0
- .NET8.0
This library does
1. Browser detection
2. Device type detection
3. Operating System detection
.NET framework 4.7 has `Browser` property on `HttpContext.Request` which gives you information about the browser, from where there HTTP request came from. Unfortunately, ASP.NET core does not have this. This package can be used for browser & device detection in your ASP.NET core apps.
## Browsers supported
| Name | Operating System | Device type |
| ------------- | ------------- | ------------- |
| Chrome | Windows | Desktop |
| Chrome | Mac OS | Desktop |
| Chrome | iOS | Mobile |
| Chrome | iOS | Tablet |
| Chrome | Android | Mobile |
| Chrome | Android | Tablet |
| Internet Explorer 11 | Windows | Desktop |
| Edge | Windows | Desktop |
| Edge | iOS | Tablet |
| Edge | iOS | Mobile |
| Edge | Android | Mobile |
| EdgeChromium | Windows | Desktop |
| EdgeChromium | OSX | Desktop |
| Opera | Windows | Desktop |
| Opera | Mac OS | Desktop |
| Opera | iOS | Mobile |
| Opera | iOS | Tablet |
| Safari | Windows | Desktop |
| Safari | Mac OS | Desktop |
| Safari | iOS | Mobile |
| Safari | iOS | Tablet |
| Firefox | Windows | Desktop |
| Firefox | Mac OS | Desktop |
| Firefox | iOS | Mobile |
| Firefox | iOS | Tablet |
If you do not see a specific browser/os/device type combo, please [open an issue](https://github.com/kshyju/BrowserDetector/issues/new)
## How to use ?
**Step 1:**
Install the [BrowserDetector nuget package](https://www.nuget.org/packages/Shyjus.BrowserDetector/)
````
Install-Package Shyjus.BrowserDetector
````
**Step 2:** Enable the browser detection service by calling `AddBrowserDetection` method on `IServiceCollection` in your startup code.
````
services.AddBrowserDetection();
````
**Step 3:** Inject `IBrowserDetector` to your controller class or view file or middleware and access the `Browser` property.
#### Example usage in controller code
````
public class HomeController : Controller
{
private readonly IBrowserDetector browserDetector;
public HomeController(IBrowserDetector browserDetector)
{
this.browserDetector = browserDetector;
}
public IActionResult Index()
{
var browser = this.browserDetector.Browser;
// Use browser object as needed.
return View();
}
}
````
#### Example usage in view code
````
@inject Shyjus.BrowserDetection.IBrowserDetector browserDetector
@browserDetector.Browser.Name
@browserDetector.Browser.Version
@browserDetector.Browser.OS
@browserDetector.Browser.DeviceType
````
#### Example usage in custom middleware
You can inject the `IBrowserDetector` to the `InvokeAsync` method.
````
public class MyCustomMiddleware
{
private RequestDelegate next;
public MyCustomMiddleware(RequestDelegate next)
{
this.next = next;
}
public async Task InvokeAsync(HttpContext httpContext, IBrowserDetector browserDetector)
{
var browser = browserDetector.Browser;
if (browser.Type == BrowserType.Edge)
{
await httpContext.Response.WriteAsync("Have you tried the new chromuim based edge ?");
}
else
{
await this.next.Invoke(httpContext);
}
}
}
````
### Interpreting the Name values returned by `IBrowser.Name`
* Firefox - Firefox browser.
* EdgeChromium - The new Chromium based Microsoft Edge browser.
* Edge - The legacy Edge browser.
* Safari - The Safari browser.
* Chrome - The Chrome browser.
### What is the Perf impact on adding this package ?
I ran benchmarks on Safari and Chrome desktop user agents and those seems to return the results around **~ 1 micro second.** Heap allocation varies based on the input.
```
| Method | Mean |
|--------------- |---------:|
| Chrome_Windows | 1.057 us |
| Safari_Windows | 1.093 us |
````
> 1 micro second is one millionth of a second.