flutter_custom_tabs 2.0.0+1 copy "flutter_custom_tabs: ^2.0.0+1" to clipboard
flutter_custom_tabs: ^2.0.0+1 copied to clipboard

A Flutter plugin for mobile apps to launch a URL in Custom Tabs/SFSafariViewController.

flutter_custom_tabs #

pub package

A Flutter plugin for mobile apps to launch a URL in Custom Tabs.
The plugin allows you to add the browser experience that Custom Tabs provides to your mobile apps.

In version 2.0, the plugin expands the support for launching a URL in mobile apps:

  • Launch a URL in an external browser.
  • Launch a deep link URL.
Android iOS Web
Support SDK 19+ 11.0+ Any
Implementation Custom Tabs SFSafariViewController url_launcher

Getting Started #

Add flutter_custom_tabs to the dependencies of your pubspec.yaml.

dependencies:
  flutter_custom_tabs: ^2.0.0

Important

v2.0.0 includes breaking changes from v1.x. Please refer to the migration guide when updating the plugin.

Requirements for Android #

  • Android Gradle Plugin v7.4.0 and above.
  • Kotlin v1.7.0 and above.
// your-project/android/build.gradle
buildscript {
    ext.kotlin_version = '1.7.0' // and above if explicitly depending on Kotlin.

    dependencies {
        classpath 'com.android.tools.build:gradle:7.4.0' // and above.
    }
}

Usage #

You can launch a web URL similar to url_launcher and specify options to customize appearance and behavior.

Android iOS
android iOS

Basic Usage #

import 'package:flutter/material.dart';
import 'package:flutter_custom_tabs/flutter_custom_tabs.dart';

void _launchURL(BuildContext context) async {
  final theme = Theme.of(context);
  try {
    await launchUrl(
      Uri.parse('https://flutter.cn'),      
      customTabsOptions: CustomTabsOptions(
        colorSchemes: CustomTabsColorSchemes.defaults(
          toolbarColor: theme.colorScheme.surface,
        ),
        shareState: CustomTabsShareState.on,
        urlBarHidingEnabled: true,
        showTitle: true,
        closeButton: CustomTabsCloseButton(
          icon: CustomTabsCloseButtonIcons.back,
        ),
      ),                    
      safariVCOptions: SafariViewControllerOptions(
        preferredBarTintColor: theme.colorScheme.surface,
        preferredControlTintColor: theme.colorScheme.onSurface,
        barCollapsingEnabled: true,
        dismissButtonStyle: SafariViewControllerDismissButtonStyle.close,        
      ),
    );
  } catch (e) {
    // If the URL launch fails, an exception will be thrown. (For example, if no browser app is installed on the Android device.)
    debugPrint(e.toString());
  }
}

See the example app for more complex examples.

Usage of the lightweight version #

This package supports a wide range of Custom Tabs customizations,
but we have introduced a lightweight URL launch for users who don't need as much in v2.0.0.

Note

On Android, the lightweight version prefers launching the default browser that supports Custom Tabs over Chrome.

import 'package:flutter/material.dart';
import 'package:flutter_custom_tabs/flutter_custom_tabs_lite.dart';

void _launchURL(BuildContext context) async {
    final theme = Theme.of(context);
    try {
      await launchUrl(
        Uri.parse('https://flutter.cn'),
        options: LaunchOptions(
          barColor: theme.colorScheme.surface,
          onBarColor: theme.colorScheme.onSurface,
          barFixingEnabled: false,
        ),
      );
    } catch (e) {
      // If the URL launch fails, an exception will be thrown. (For example, if no browser app is installed on the Android device.)
      debugPrint(e.toString());
    }
}

Custom Tabs Customization #

Option Android (CustomTabsOptions) iOS (SafariViewControllerOptions) LaunchOptions
Change background color of app/bottom bar
Change color of controls on app/bottom bar -
(Automatically adjusted by Custom Tabs)
Change background color of system navigation bar -
Change color of system navigation divider -
Hide(Collapse) the app bar by scrolling
Add sharing action for web pages -
(always added on Android)
Change visibility of web page title -
(always shown on Android)
Change the availability of Reader mode - Not provided
Change appearance of close button
(Icon, position)

(Predefined button styles)
Not provided
Change the availability of Instant Apps - Not provided
Change animation style
(Predefined modal presentation styles)
Not provided
Prefer the default browser over Chrome - Not provided
Pass HTTP headers - Not provided
Show as a bottom sheet Not provided

Support status in flutter_custom_tabs:

  • ✅: Supported.
  • -: Option not provided by Custom Tabs implementation.

Advanced Usage #

Deep Linking #

Supports launching a deep link URL.
(If a native app that responds to the deep link URL is installed, it will directly launch it. otherwise, it will launch a custom tab.)

import 'package:flutter/material.dart';
import 'package:flutter_custom_tabs/flutter_custom_tabs.dart';
// or import 'package:flutter_custom_tabs/flutter_custom_tabs_lite.dart';

Future<void> _launchDeepLinkURL(BuildContext context) async {
  final theme = Theme.of(context);
  await launchUrl(
    Uri.parse('https://www.google.com/maps/@35.6908883,139.7865242,13z'),
    prefersDeepLink: true,
    customTabsOptions: CustomTabsOptions(
      colorSchemes: CustomTabsColorSchemes.defaults(
        toolbarColor: theme.colorScheme.surface,
      ),
    ),
    safariVCOptions: SafariViewControllerOptions(
      preferredBarTintColor: theme.colorScheme.surface,
      preferredControlTintColor: theme.colorScheme.onSurface,
    ),
  );
}

Launch in an external browser #

By default, if no mobile platform-specific options are specified, a URL will be launched in an external browser.

Tip

Android: CustomTabsOptions.externalBrowser supports HTTP request headers.

import 'package:flutter_custom_tabs/flutter_custom_tabs.dart';

Future<void> _launchInExternalBrowser() async {
  await launchUrl(Uri.parse('https://flutter.cn'));
}

Show as a bottom sheet #

You can launch a URL in Custom Tabs as a bottom sheet.

Requirements:

import 'package:flutter/material.dart';
import 'package:flutter_custom_tabs/flutter_custom_tabs.dart';

Future<void> _launchURLInBottomSheet(BuildContext context) async {
  final theme = Theme.of(context);
  final mediaQuery = MediaQuery.of(context);    
  await launchUrl(
    Uri.parse('https://flutter.cn'),
    customTabsOptions: CustomTabsOptions.partial(
      configuration: PartialCustomTabsConfiguration(
        initialHeight: mediaQuery.size.height * 0.7,
      ),
      colorSchemes: CustomTabsColorSchemes.defaults(
        toolbarColor: theme.colorScheme.surface,
      ),
    ),
    safariVCOptions: SafariViewControllerOptions.pageSheet(
      configuration: const SheetPresentationControllerConfiguration(
        detents: {
          SheetPresentationControllerDetent.large,
          SheetPresentationControllerDetent.medium,
        },
        prefersScrollingExpandsWhenScrolledToEdge: true,
        prefersGrabberVisible: true,
        prefersEdgeAttachedInCompactHeight: true,
      ),
      preferredBarTintColor: theme.colorScheme.surface,
      preferredControlTintColor: theme.colorScheme.onSurface,
      dismissButtonStyle: SafariViewControllerDismissButtonStyle.close,
    ),
  );
}

Prefer the default browser over Chrome #

On Android, the plugin defaults to launching Chrome, which supports all Custom Tabs features.
You can prioritize launching the default browser on the device that supports Custom Tabs over Chrome.

Note

Some browsers may not support the options specified in CustomTabsOptions.

import 'package:flutter_custom_tabs/flutter_custom_tabs.dart';

Future<void> _launchURLInDefaultBrowserOnAndroid() async {  
  await launchUrl(
    Uri.parse('https://flutter.cn'),
    customTabsOptions: CustomTabsOptions(
      browser: const CustomTabsBrowserConfiguration(
        prefersDefaultBrowser: true,
      ),
    ),
  );
}

License #

Copyright (C) 2015 The Android Open Source Project
Copyright (C) 2018 Shinya Kumagai

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
213
likes
130
pub points
98%
popularity

Publisher

unverified uploader

A Flutter plugin for mobile apps to launch a URL in Custom Tabs/SFSafariViewController.

Repository (GitHub)
View/report issues

Documentation

API reference

License

Apache-2.0 (LICENSE)

Dependencies

flutter, flutter_custom_tabs_android, flutter_custom_tabs_ios, flutter_custom_tabs_platform_interface, flutter_custom_tabs_web, meta

More

Packages that depend on flutter_custom_tabs