url_protocol 1.0.0 copy "url_protocol: ^1.0.0" to clipboard
url_protocol: ^1.0.0 copied to clipboard

PlatformWindows

A unified library to register custom URL protocol handlers across all supported platforms.

url_protocol #

A unified library to register custom URL protocol handlers across supported platforms.

Compatibility #

This library is designed for use within Flutter and primarily to serve on Desktop platforms that require extra programmatic registration of URL handlers.

In other words, this library is meant to provide protocol registration on the Windows and Linux (coming soon) platforms.

Usage #

Use the following to register or unregister a URL handler protocol.

import 'package:url_protocol/url_protocol.dart';

void main() {
  // Register a new custom URL protocol handler. Opening test-url-protocol://test
  // will run the executable with the arguments: -url test-url-protocol://test
  registerProtocolHandler('test-url-protocol', arguments: ['-url', '%s']);

  // Unregister and remove custom URL protocol handler
  unregisterProtocolHandler('test-url-protocol');
}

Helpful Hints #

Use this library with multi_instance_handler to manage forwarding of the opened URL to the active instance of your application on Desktop platforms.

TODO #

  • Instructions for Android, iOS, macOS
  • Support for Linux

License & Author #

This library was written by Loren Segal and is licensed under the terms of the MIT license.

13
likes
125
pub points
84%
popularity

Publisher

verified publisherloren.dev

A unified library to register custom URL protocol handlers across all supported platforms.

Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (LICENSE)

Dependencies

ffi, flutter, win32

More

Packages that depend on url_protocol