Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dartsidedev/whatsapp_unilink
Dart package helping your app interact with WhatsApp via HTTP links (universal links). Works with Flutter.
https://github.com/dartsidedev/whatsapp_unilink
dart flutter url whatsapp
Last synced: 3 days ago
JSON representation
Dart package helping your app interact with WhatsApp via HTTP links (universal links). Works with Flutter.
- Host: GitHub
- URL: https://github.com/dartsidedev/whatsapp_unilink
- Owner: dartsidedev
- License: bsd-3-clause
- Created: 2020-05-03T19:45:20.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-20T16:10:41.000Z (almost 2 years ago)
- Last Synced: 2023-08-20T23:30:31.108Z (about 1 year ago)
- Topics: dart, flutter, url, whatsapp
- Language: Dart
- Homepage: https://pub.dev/packages/whatsapp_unilink
- Size: 35.2 KB
- Stars: 22
- Watchers: 1
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# `whatsapp_unilink`
> Dart package helping your app interact with WhatsApp via HTTP links (universal links). Works with Flutter.
The `whatsapp_unilink` package helps you build HTTP links
and provides you with an idiomatic Dart class that:
* converts your phone number into something that WhatsApp expects ✅
* hides the encoding and link building details from you so that you can focus on your app 🚀
* is blazingly fast ⚡️
[](https://github.com/dartsidedev/whatsapp_unilink/actions) [](https://codecov.io/gh/dartsidedev/whatsapp_unilink) [](https://pub.dev/packages/whatsapp_unilink 'See whatsapp_unilink package info on pub.dev') [](https://pub.dev/publishers/dartside.dev/packages) [](https://github.com/dartsidedev/whatsapp_unilink 'Star me on GitHub!')
## Important links
* [Read the source code and **star the repo** on GitHub](https://github.com/dartsidedev/whatsapp_unilink)
* [Open an issue on GitHub](https://github.com/dartsidedev/whatsapp_unilink/issues)
* [See package on pub.dev](https://pub.dev/packages/whatsapp_unilink)
* [Read the docs on pub.dev](https://pub.dev/documentation/whatsapp_unilink/latest/)
**If you enjoy using this package, a thumbs-up on [pub.dev](https://pub.dev/packages/whatsapp_unilink) would be highly appreciated! 👍💙 Let's get to 500 likes 🚀**
#### About WhatsApp links
* [WhatsApp FAQ > Android > How to use click to chat](https://faq.whatsapp.com/en/android/26000030/)
* [WhatsApp FAQ > iPhone > How to link to WhatsApp from a different app](https://faq.whatsapp.com/en/iphone/23559013)
## Usage
With `WhatsAppUnilink`, you can create a link that
will allow your users to start a chat with someone
(identified with `phoneNumber`).
By clicking the link, a chat with the person automatically opens.
WhatsApp will include your message in `text` and
it will automatically appear in the text field of a chat.
Both the `phoneNumber` and `text` arguments are optional.
The `WhatsAppUnilink` instance, whenever converted to a string,
will create a WhatsApp link for you.
When `WhatsAppUnilink` instance is converted to a string,
any brackets, dashes, plus signs, and leading zeros or
any other non-digit characters will be removed from the phone number.
The APIs support working with strings (`toString()`) and URIs (`asUri`).
*Important*: the `whatsapp_unilink` package does not convert
from the local phone numbers format to the international format based on the device's locale.
### Flutter
You may want to launch the WhatsApp app on your user's phone and make life easier for your users by pre-filling the
mobile number and text.
Use the [`url_launcher`](https://pub.dev/packages/url_launcher) for launching the links you create with
the `whatsapp_unilink` package.
```dart
import 'package:whatsapp_unilink/whatsapp_unilink.dart';
// For Flutter applications, you'll most likely want to use
// the url_launcher package.
import 'package:url_launcher/url_launcher.dart';
// ...somewhere in your Flutter app...
launchWhatsAppUri() async {
final link = WhatsAppUnilink(
phoneNumber: '+001-(555)1234567',
text: "Hey! I'm inquiring about the apartment listing",
);
// Convert the WhatsAppUnilink instance to a Uri.
// The "launch" method is part of "url_launcher".
await launch(link.asUri());
}
```
Alternatively, you can get the `String` representation of the links.
You can either explicitly call the `link.toString()` method,
or you may rely on Dart's shorter string interpolation, `'$link'`.
```dart
import 'package:url_launcher/url_launcher_string.dart';
launchWhatsAppString() async {
final link = WhatsAppUnilink(
phoneNumber: '+001-(555)1234567',
text: "Hey! I'm inquiring about the apartment listing",
);
// Convert the WhatsAppUnilink instance to a string.
// Use either Dart's string interpolation or the toString() method.
// The "launchUrlString" method is part of "url_launcher_string".
await launchUrlString('$link');
}
```
### Dart
This package works on all Dart projects and
doesn't have any Flutter-specific dependency.
It works on the frontend, rendered to an `a` tag
from your HTTP server, or returned from your Dart REST APIs.
You can convert your `WhatsAppUnilink` instances to
`String` or [`Uri`](https://api.dart.dev/dart-core/Uri-class.html).
```dart
final link = WhatsAppUnilink(
phoneNumber: '+001-(555)1234567',
text: "Hey! I'm inquiring about the apartment listing",
);
final linkAsString = link.toString(); // or '$link'
final linkAsUri = link.asUri();
```