Live Activities #

A Flutter plugin to use iOS 16.1+ Live Activities & iPhone 14 Pro Dynamic Island features.

🧐 What is it ? #

This plugin use iOS ActivityKit API.

live_activities can be used to show dynamic live notification & implement dynamic island feature on the iPhone 14 Pro / Max ⚫️

⚠️ live_activities is only intended to use with iOS 16.1+ ! It will simply do nothing on other platform & < iOS 16.1

👻 Getting started #

Due to some technical restriction, it's not currently possible to only use Flutter 🫣.

You need to implement in your Flutter iOS project a Widget Extension & develop in Swift/Objective-C your own Live Activity / Dynamic Island design.

ℹ️ You can check into the example repository for a full example app using Live Activities & Dynamic Island

🧵 Native #

• 📱 Create natively your Live Activity view tutorial

  • ⚫️ (Opt.) Create natively a Dynamic Island tutorial

• 🛎 Enable push notification capabilities.

• ⛹️ Enable live activities for both your app & widget extension.

💙 Flutter #

• 🔌 Import the plugin.

import 'package:live_activities/live_activities.dart';

• 📣 Create your dynamic activity.

final Map<String, String> activityModel = {
  'name': 'Margherita',
  'ingredient': 'tomato, mozzarella, basil',
  'quantity': '1',
};

_liveActivitiesPlugin.createActivity(activityModel.toMap());

⚠️ For now you can only pass values as String.

Communicate over Native 🧵 and Flutter 💙 #

In order to pass some useful data between your native live activity / dynamic island with your Flutter app you just need to setup URL scheme.

• 🚄 Add a custom url scheme in Xcode by navigating to Runner > Runner > URL Types > URL Schemes

• 🔗 In your Swift code, just create a new link and open to your custom URL Scheme

Link(destination: URL(string: "la://my.app/order?=123")!) { // Replace "la" with your scheme
  Text("See order")
}

⚠️ Don't forget to put the URL Scheme you have typed in the previous step.

• 👂 In your Flutter App, you just need to listen on the url scheme Scheme

_liveActivitiesPlugin.urlSchemeStream().listen((schemeData) {
  // do what do you want here 🤗
});

📘 Documentation #

🎯 Roadmap #

• ❌ Support multiple type instead of String (Date, Number etc.).
• ❌ Inject a Widget inside the notification with Flutter Engine ?
• ✅ Pass data across native dynamic island and Flutter app.
• ✅ Pass data across native live activity notification and Flutter app.
• ✅ Cancel all activities.
• ✅ Get all activities ids.
• ✅ Check if live activities are supported.