Ekhlass/Flutter_Documentation · Datasets at Hugging Face

text stringlengths 1 474
Deep linking is a mechanism for launching an app with a URI.
This URI contains scheme, host, and path,
and opens the app to a specific screen.A app link is a type of deep link that uses
http or https and is exclusive to Android devices.Setting up app links requires one to own a web domain.
Otherwise, consider using Firebase Hosting
or GitHub Pages as a temporary solution.<topic_end>
<topic_start>
1. Customize a Flutter application
Write a Flutter app that can handle an incoming URL.
This example uses the go_router package to handle the routing.
The Flutter team maintains the go_router package.
It provides a simple API to handle complex routing scenarios.To create a new application, type flutter create <app-name>:To include go_router package in your app,
add a dependency for go_router to the project:To add the go_router package as a dependency,
run flutter pub add:To handle the routing,
create a GoRouter object in the main.dart file:
<code_start>import 'package:flutter/material.dart';
import 'package:go_router/go_router.dart';
void main() => runApp(MaterialApp.router(routerConfig: router));
/// This handles '/' and '/details'.
final router = GoRouter(
routes: [
GoRoute(
path: '/',
builder: (_, __) => Scaffold(
appBar: AppBar(title: const Text('Home Screen')),
),
routes: [
GoRoute(
path: 'details',
builder: (_, __) => Scaffold(
appBar: AppBar(title: const Text('Details Screen')),
),
),
],
),
],
);<code_end>
<topic_end>
<topic_start>
2. Modify AndroidManifest.xml
Add the following metadata tag and intent filter inside the
<activity> tag with .MainActivity.Replace example.com with your own web domain.info Note
The metadata tag flutter_deeplinking_enabled opts
into Flutter’s default deeplink handler.
If you are using the third-party plugins,
such as uni_links, setting this metadata tag will
break these plugins. Omit this metadata tag
if you prefer to use third-party plugins.<topic_end>
<topic_start>
3. Hosting assetlinks.json file
Host an assetlinks.json file in using a web server
with a domain that you own. This file tells the
mobile browser which Android application to open instead
of the browser. To create the file,
get the package name of the Flutter app you created in
the previous step and the sha256 fingerprint of the
signing key you will be using to build the APK.<topic_end>
<topic_start>
Package name
Locate the package name in AndroidManifest.xml,
the package property under <manifest> tag.
Package names are usually in the format of com.example.*.<topic_end>
<topic_start>
sha256 fingerprint
The process might differ depending on how the apk is signed.<topic_end>
<topic_start>Using google play app signing
You can find the sha256 fingerprint directly from play
developer console. Open your app in the play console,
under Release> Setup > App Integrity> App Signing tab:<topic_end>
<topic_start>Using local keystore
If you are storing the key locally,
you can generate sha256 using the following command:<topic_end>
<topic_start>
assetlinks.json
The hosted file should look similar to this:Set the package_name value to your Android application ID.Set sha256_cert_fingerprints to the value you got
from the previous step.Host the file at a URL that resembles the following:
<webdomain>/.well-known/assetlinks.jsonVerify that your browser can access this file.<topic_end>
<topic_start>
Testing
You can use a real device or the Emulator to test an app link,
but first make sure you have executed flutter run at least once on
the devices. This ensures that the Flutter application is installed.To test only the app setup, use the adb command:info Note
This doesn’t test whether the web files are
hosted correctly,
the command launches the app even
if web files are not presented.To test both web and app setup, you must click a link
directly through web browser or another app.
One way is to create a Google Doc, add the link, and tap on it.If everything is set up correctly, the Flutter application
launches and displays the details screen:<topic_end>
<topic_start>
Appendix
Source code: deeplink_cookbook
<topic_end>
<topic_start>Set up universal links for iOS
Deep linking is a mechanism for launching an app with a URI. This URI
contains scheme, host, and path, and opens the app to a specific
screen.A universal link is a type of deep link that uses http or https
and is exclusive to Apple devices.Setting up universal links requires one to own a web domain.
Otherwise, consider using Firebase Hosting or GitHub Pages
as a temporary solution.<topic_end>

Deep linking is a mechanism for launching an app with a URI.

This URI contains scheme, host, and path,

and opens the app to a specific screen.A app link is a type of deep link that uses

http or https and is exclusive to Android devices.Setting up app links requires one to own a web domain.

Otherwise, consider using Firebase Hosting

or GitHub Pages as a temporary solution.<topic_end>

<topic_start>

1. Customize a Flutter application

Write a Flutter app that can handle an incoming URL.

This example uses the go_router package to handle the routing.

The Flutter team maintains the go_router package.

It provides a simple API to handle complex routing scenarios.To create a new application, type flutter create <app-name>:To include go_router package in your app,

add a dependency for go_router to the project:To add the go_router package as a dependency,

run flutter pub add:To handle the routing,

create a GoRouter object in the main.dart file:

<code_start>import 'package:flutter/material.dart';

import 'package:go_router/go_router.dart';

void main() => runApp(MaterialApp.router(routerConfig: router));

/// This handles '/' and '/details'.

final router = GoRouter(

routes: [

GoRoute(

path: '/',

builder: (_, __) => Scaffold(

appBar: AppBar(title: const Text('Home Screen')),

),

routes: [

GoRoute(

path: 'details',

builder: (_, __) => Scaffold(

appBar: AppBar(title: const Text('Details Screen')),

),

],

),

],

);<code_end>

<topic_end>

<topic_start>

2. Modify AndroidManifest.xml

Add the following metadata tag and intent filter inside the

<activity> tag with .MainActivity.Replace example.com with your own web domain.info Note

The metadata tag flutter_deeplinking_enabled opts

into Flutter’s default deeplink handler.

If you are using the third-party plugins,

such as uni_links, setting this metadata tag will

break these plugins. Omit this metadata tag

if you prefer to use third-party plugins.<topic_end>

<topic_start>

3. Hosting assetlinks.json file

Host an assetlinks.json file in using a web server

with a domain that you own. This file tells the

mobile browser which Android application to open instead

of the browser. To create the file,

get the package name of the Flutter app you created in

the previous step and the sha256 fingerprint of the

signing key you will be using to build the APK.<topic_end>

<topic_start>

Package name

Locate the package name in AndroidManifest.xml,

the package property under <manifest> tag.

Package names are usually in the format of com.example.*.<topic_end>

<topic_start>

sha256 fingerprint

The process might differ depending on how the apk is signed.<topic_end>

<topic_start>Using google play app signing

You can find the sha256 fingerprint directly from play

developer console. Open your app in the play console,

under Release> Setup > App Integrity> App Signing tab:<topic_end>

<topic_start>Using local keystore

If you are storing the key locally,

you can generate sha256 using the following command:<topic_end>

<topic_start>

assetlinks.json

The hosted file should look similar to this:Set the package_name value to your Android application ID.Set sha256_cert_fingerprints to the value you got

from the previous step.Host the file at a URL that resembles the following:

<webdomain>/.well-known/assetlinks.jsonVerify that your browser can access this file.<topic_end>

<topic_start>

Testing

You can use a real device or the Emulator to test an app link,

but first make sure you have executed flutter run at least once on

the devices. This ensures that the Flutter application is installed.To test only the app setup, use the adb command:info Note

This doesn’t test whether the web files are

hosted correctly,

the command launches the app even

if web files are not presented.To test both web and app setup, you must click a link

directly through web browser or another app.

One way is to create a Google Doc, add the link, and tap on it.If everything is set up correctly, the Flutter application

launches and displays the details screen:<topic_end>

<topic_start>

Appendix

Source code: deeplink_cookbook

<topic_end>

<topic_start>Set up universal links for iOS

Deep linking is a mechanism for launching an app with a URI. This URI

contains scheme, host, and path, and opens the app to a specific

screen.A universal link is a type of deep link that uses http or https

and is exclusive to Apple devices.Setting up universal links requires one to own a web domain.

Otherwise, consider using Firebase Hosting or GitHub Pages

as a temporary solution.<topic_end>