DeepLink Integration

This guide explains how to integrate deep linking with the Digia Flutter SDK using the app_links package.

Overview

Deep linking allows users to open specific screens in your app through URLs. This is useful for:

• Sharing specific content

• Push notifications

• QR codes

• Web-to-app navigation

When combined with Digia UI, deep links can navigate to both native Flutter screens and Digia-powered UI screens.

Supported Deep Links

• yourapp://home - Opens the home page (Digia UI page)

• yourapp://product/{id} - Opens product details with parameters

• yourapp://cart - Opens the cart screen

• yourapp://profile - Opens a native Flutter screen

• https://yourdomain.com/home - Opens the home page (Universal Links/App Links)

Setup

1. Add Dependencies

dependencies:
  app_links: ^3.5.0
  digia_ui: ^1.0.0

2. Configure Android Deep Links

Add intent filters to android/app/src/main/AndroidManifest.xml:

<intent-filter android:autoVerify="true">
  <action android:name="android.intent.action.VIEW" />
  <category android:name="android.intent.category.DEFAULT" />
  <category android:name="android.intent.category.BROWSABLE" />
  <data android:scheme="https" android:host="yourdomain.com" />
  <data android:scheme="yourapp" />
</intent-filter>

3. Configure iOS Deep Links

Add URL schemes to ios/Runner/Info.plist:

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>yourapp</string>
      <string>https</string>
    </array>
  </dict>
</array>
<key>FlutterDeepLinkingEnabled</key>
<true/>

Implementation

DeepLinkHandler Class

Create deep_link_handler.dart:

import 'dart:async';
import 'package:app_links/app_links.dart';
import 'package:flutter/material.dart';
import 'package:digia_ui/digia_ui.dart';

class DeepLinkHandler {
  static final _appLinks = AppLinks();
  static StreamSubscription<Uri>? _linkSubscription;

  static void initialize(BuildContext context) {
    _linkSubscription = _appLinks.uriLinkStream.listen(
      (Uri uri) => handleDeepLink(context, uri),
    );
    _getInitialLink(context);
  }

  static Future<void> _getInitialLink(BuildContext context) async {
    final Uri? uri = await _appLinks.getInitialAppLink();
    if (uri != null) handleDeepLink(context, uri);
  }

  static void handleDeepLink(BuildContext context, Uri uri) {
    List<String> pathSegments = uri.pathSegments;

    switch (pathSegments[0]) {
      case 'home':
        Navigator.of(context, rootNavigator: true).push(
          DUIFactory().createPageRoute('home_page_slug', {}),
        );
        break;
      // Add more cases here for different routes
      default:
        ScaffoldMessenger.of(context).showSnackBar(
          SnackBar(content: Text('Deep link not recognized: ${uri.path}')),
        );
    }
  }

  static void dispose() {
    _linkSubscription?.cancel();
  }
}

Initialize in DigiaUIAppBuilder

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return DigiaUIAppBuilder(
      options: DigiaUIOptions(accessKey: 'your-access-key'),
      builder: (context, status) {
        if (status.isLoading) return CircularProgressIndicator();
        if (status.hasError) return Text('Error: ${status.error}');

        WidgetsBinding.instance.addPostFrameCallback((_) {
          DeepLinkHandler.initialize(context);
        });

        return MaterialApp(
          home: DUIFactory().createInitialPage(),
          onGenerateRoute: (settings) => DUIFactory().createPageRoute(
            settings.name!,
            settings.arguments as Map<String, dynamic>?,
          ),
        );
      },
    );
  }
}

Testing Deep Links

Android

adb shell am start -a android.intent.action.VIEW -d "yourapp://home"

iOS

xcrun simctl openurl booted "yourapp://home"

Digia UI Integration Patterns

Pure Digia UI Navigation

case 'product':
  Navigator.of(context).push(
    DUIFactory().createPageRoute('product_details_page', {
      'productId': pathSegments[1],
      'source': 'deep_link',
    }),
  );
  break;

Hybrid Navigation

case 'profile':
  Navigator.of(context).push(
    MaterialPageRoute(builder: (_) => ProfileScreen()),
  );
  break;

Advanced Usage

Query Parameters

case 'product':
  String productId = pathSegments[1];
  String? userId = uri.queryParameters['user_id'];
  String? source = uri.queryParameters['source'];

  Navigator.of(context).push(
    DUIFactory().createPageRoute('product_details_slug', {
      'productId': productId,
      'userId': userId,
      'source': source,
    }),
  );
  break;

Analytics Integration

static void handleDeepLink(BuildContext context, Uri uri) {
  DUIAnalytics().onEvent([
    AnalyticEvent(name: 'deep_link_opened', payload: {
      'url': uri.toString(),
      'path': uri.path,
    }),
  ]);
  // Continue with navigation...
}

Troubleshooting

1. Check URL Scheme: Ensure your URL scheme is correctly registered in both Android and iOS configurations.

2. Verify Package Name: Make sure the package name in AndroidManifest matches your app's package name.

3. Test with ADB: Use ADB commands to test deep links directly.

4. Check Logs: Look for "Received deep link" messages in your app logs.

Related Documentation

• app_links Package

• Android Deep Links

• iOS Universal Links

• Digia UI Navigation