Package detailsv1.7.0

ua_client_hints

Provide User-Agent Client Hints to Flutter.

AndroidiOSWebmacOS

pub.dev API documentation Source code

30-day downloads: 192K
Likes: 52
Pub points: 130

Install package

flutter pub add ua_client_hints

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

The ua_client_hints package enables Flutter applications to access User-Agent Client Hints, providing detailed browser and device information through standardized HTTP headers. It simplifies the process of retrieving client metadata such as platform, model, and brand on Android, iOS, Web, and macOS. This helps developers tailor content delivery based on user device characteristics without relying solely on string parsing of User-Agent strings. The package integrates seamlessly with HTTP clients and supports modern web standards for privacy-preserving device detection.

Use cases

Device-specific content rendering
Browser and OS detection
Optimized asset delivery
Privacy-conscious analytics
Cross-platform compatibility testing

Key features

Supports Android, iOS, Web, and macOS
Provides standardized client hints via HTTP headers
Reduces reliance on User-Agent string parsing
Integrates with existing HTTP clients
Follows modern web standards for device detection

Suitable for

Developers needing accurate device info
Apps requiring adaptive UI/UX
Projects focused on privacy and compliance
Web and mobile hybrid applications
Content delivery optimization

Considerations

Requires compatible server-side support
Limited to devices that expose client hints
Not all browsers fully support client hints
May require additional server configuration
Depends on underlying platform capabilities

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

User-Agent Client Hints for Flutter

What's User-Agent Client Hints?

User-Agent Client Hints
Improving user privacy and developer experience with User-Agent Client Hints
User-Agent Client Hints Demo on Browser

⬇️ Response Accept-CH	⬆️ Request header	⬆️ RequestExample value	Description
UA	Sec-CH-UA	"Chromium";v="84", "Google Chrome";v="84"	List of browser brands and their significant version.
UA-Mobile	Sec-CH-UA-Mobile	?1	Boolean indicating if the browser is on a mobile device (?1 for true) or not (?0 for false).
UA-Full-Version	Sec-CH-UA-Full-Version	"84.0.4143.2"	The complete version for the browser.
UA-Platform	Sec-CH-UA-Platform	"Android"	The platform for the device, usually the operating system (OS).
UA-Platform-Version	Sec-CH-UA-Platform-Version	"10"	The version for the platform or OS.
UA-Arch	Sec-CH-UA-Arch	"ARM64"	The underlying architecture for the device. While this may not be relevant to displaying the page, the site may want to offer a download which defaults to the right format.
UA-Model	Sec-CH-UA-Model	"Pixel 3"	The device model.

Installation

This plugin is set the Null Safety.

Add this to your package's pubspec.yaml file by running the following command

$ flutter pub add ua_client_hints

Usage

Supported platforms:

Android
iOS
macOS
Web

On Web, values depend on browser support for User-Agent Client Hints. Some fields such as architecture, model, or platformVersion can be empty on browsers that don't expose high-entropy hints.

With Dio

Add to the request header.

class AppDio with DioMixin implements Dio {
  AppDio._([BaseOptions options]) {
    options = BaseOptions(
      baseUrl: 'https://wasabeef.jp',
    );

    this.options = options;
    interceptors.add(InterceptorsWrapper(
      onRequest: (options) async {
        // Add User-Agent Client Hints
        options.headers.addAll(await userAgentClientHintsHeader());
        return options;
      },
    ));
  }

  static Dio getInstance() => AppDio._();
}

APIs

final String ua = await userAgent();

print('User-Agent: $ua');  // e.g.. 'SampleApp/1.0.0 (Android 11; Pixel 4 XL; coral; arm64-v8a)'
// macOS example:
// 'SampleApp/1.0.0 (macOS 15.5.0; Mac; Mac15,12; arm64)'
// Web fallback example:
// 'SampleApp/1.0.0 (macOS 15.5.0; Google Chrome; arm64)'

final UserAgentData uaData = await userAgentData();

print('platform:        ${uaData.platform}');              // e.g.. 'Android'
print('platformVersion: ${uaData.platformVersion}');       // e.g.. '10'
print('model:           ${uaData.model}');                 // e.g.. 'Pixel 4 XL'
print('architecture:    ${uaData.architecture}');          // e.g.. 'arm64-v8a'
print('brand:           ${uaData.brand}');                 // e.g.. 'Google'
print('mobile:          ${uaData.mobile}');                // e.g.. true
print('device:          ${uaData.device}');                // e.g.. 'coral'
print('appName:         ${uaData.package.appName}');       // e.g.. 'SampleApp'
print('appVersion:      ${uaData.package.appVersion}');    // e.g.. '1.0.0'
print('packageName:     ${uaData.package.packageName}');   // e.g.. 'jp.wasabeef.ua'
print('buildNumber:     ${uaData.package.buildNumber}');   // e.g.. '1'

final Map<String, dynamic> header = await userAgentClientHintsHeader();

print("Sec-CH-UA-Arch:             ${header['Sec-CH-UA-Arch']}");             // e.g.. 'arm64-v8a'
print("Sec-CH-UA-Model:            ${header['Sec-CH-UA-Model']}");            // e.g.. 'Pixel 4 XL'
print("Sec-CH-UA-Platform:         ${header['Sec-CH-UA-Platform']}");         // e.g.. 'Android'
print("Sec-CH-UA-Platform-Version: ${header['Sec-CH-UA-Platform-Version']}"); // e.g.. '10'
print("Sec-CH-UA:                  ${header['Sec-CH-UA']}");                  // e.g.. '"SampleApp"; v="1.0.0"'
print("Sec-CH-UA-Full-Version:     ${header['Sec-CH-UA-Full-Version']}");     // e.g.. '1.0.0'
print("Sec-CH-UA-Mobile:           ${header['Sec-CH-UA-Mobile']}");           // e.g.. '?1' (true) or '?0' (false)