Nitrogen Poisonous Monoxide

    react-native-custom-tabs
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/react-native-custom-tabs package

    0.1.7 • Public • Published

    React Native Custom Tabs

    npm version Software License

    Chrome Custom Tabs for React Native. Custom Tabs is supported only Chrome for Android. For this reason, the interface is the same, but the behavior is following:

    • iOS
      If Chrome is installed, open the URL in it. If it is not installed, open in Safari.

    • Android
      If Chrome is installed, open the URL in Chrome that you have customized some of the look & feel. If it is not installed, open in other browser.

    Customization and detailed behavior refer to the Usage.

    Installation

    npm install react-native-custom-tabs --save
    

    To link the native module automatically, it is recommended that you use the rnpm.

    rnpm link
    

    Android

    In Android, Add it in your root build.gradle at the end of repositories:

    allprojects {
        repositories {
            ...
            maven { url "https://jitpack.io" }
        }
    }

    And, provide CustomTabsPackage in your Application class.

    @Override
    protected List<ReactPackage> getPackages() {
        return Arrays.asList(
                ...,
                new CustomTabsPackage()
        );
    }

    If you use version 0.1.5 or higher, change the app build.gradle.

    android {
        ...
        compileSdkVersion 25
        buildToolsVersion "25.0.1"
    }
     
    dependencies {
        ...
        compile "com.android.support:appcompat-v7:25.0.1"
    }

    Usage

    Open the URL as Linking of React Native.

    CustomTabs.openURL('https://www.google.com').then((launched: {boolean}) => {
      console.log(`Launched custom tabs: ${launched}`);
    }).catch(err => {
      console.error(err)
    });

    Customized for Android

    You can customize the look & feel in Android. The following option is ignored in iOS.

    import {
        ANIMATIONS_SLIDE,
        ANIMATIONS_FADE
    } from 'react-native-custom-tabs';
     
    CustomTabs.openURL(url, {
      toolbarColor: '#607D8B',
      enableUrlBarHiding: true,
      showPageTitle: true,
      enableDefaultShare: true,
      // For value, specify only full qualifier or only resource name.
      // In the case of the resource name, the module complements the application package in java side.
      animations: {
        startEnter: 'com.github.droibit.android.reactnative.customtabs.example:anim/slide_in_bottom',
        startExit: 'com.github.droibit.android.reactnative.customtabs.example:anim/slide_out_bottom',
        endEnter: 'com.github.droibit.android.reactnative.customtabs.example:anim/slide_in_bottom',
        endExit: 'com.github.droibit.android.reactnative.customtabs.example:anim/slide_out_bottom',
      },
      // or
      animations: ANIMATIONS_SLIDE, // or ANIMATIONS_FADE
      headers: {
        'my-custom-header': 'my custom header value'
      }
    });

    The option to support:

    property type default description
    toolbarColor string undefined the Toolbar color. Supported formats are: #RRGGBB, #AARRGGBB, etc.
    enableUrlBarHiding boolean undefined Enables the url bar to hide as the user scrolls down on the page.
    showPageTitle boolean undefined Sets whether the title should be shown in the custom tab.
    enableDefaultShare boolean undefined Whether to add a default shared items of the menu.
    animations Object undefined Sets the exit and start animations. ANIMATIONS_FADE, ANIMATIONS_SLIDE or custom object with string properties startEnter, startExit, endEnter and endExit each defining an Android animation resource ID to use for the animations, such as com.github.droibit.android.reactnative.customtabs:anim/slide_in_right.
    headers Object undefined Sets any custom headers that should be used.

    undefined property is the default behavior of the Custom Tabs.

    Customize and default look & feel.
    screenshot

    License

    Copyright (C) 2016 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.
    

    Install

    npm i react-native-custom-tabs

    DownloadsWeekly Downloads

    1,016

    Version

    0.1.7

    License

    Apache-2.0

    Last publish

    Collaborators

    • droibit