Skip to content

Commit 63d2e75

Browse files
committed
Update README.md
1 parent 375e1a7 commit 63d2e75

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# React Native Custom Tabs
22
[![npm version](https://badge.fury.io/js/react-native-custom-tabs.svg)](https://badge.fury.io/js/react-native-custom-tabs) [![Software License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](https://github.com/droibit/react-native-custom-tabs/blob/develop/LICENSE)
33

4-
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:
4+
[Chrome Custom Tabs](https://developer.chrome.com/multidevice/android/customtabs) for React Native.
5+
Custom Tabs is supported only for Android, so the behavior on each platform is bellow.
56

67
* Android
78
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.
89

910
* iOS
1011
If Chrome is installed, open the URL in it. If it is not installed, open in Safari.
1112

12-
Customization and detailed behavior refer to the Usage.
13+
Customization and detailed behavior refer to the [Usage](#Usage).
1314

1415
## Installation
1516

@@ -25,7 +26,7 @@ rnpm link
2526

2627
#### Android
2728

28-
In Android, Add it in your **root** `build.gradle` at the end of repositories:
29+
In Android, Add it in your **root** `build.gradle`([e.g. example](https://github.com/droibit/react-native-custom-tabs/blob/develop/example/android/build.gradle)) at the end of repositories:
2930

3031
```groovy
3132
allprojects {
@@ -77,7 +78,7 @@ CustomTabs.openURL('https://www.google.com').then((launched: {boolean}) => {
7778
});
7879
```
7980

80-
#### Customized for Android
81+
#### Customize for Android
8182

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

@@ -92,16 +93,16 @@ CustomTabs.openURL(url, {
9293
enableUrlBarHiding: true,
9394
showPageTitle: true,
9495
enableDefaultShare: true,
95-
// For value, specify only full qualifier(package:anim/name) or only resource name.
96-
// In the case of the resource name, the module complements application package.
96+
// Specify full animation resource identifier(package:anim/name)
97+
// or only resource name(in case of animation bundled with app).
9798
animations: {
9899
startEnter: 'slide_in_bottom',
99100
startExit: 'slide_out_bottom',
100101
endEnter: 'slide_in_bottom',
101102
endExit: 'slide_out_bottom',
102103
},
103-
// or
104-
animations: ANIMATIONS_SLIDE, // or ANIMATIONS_FADE
104+
// And supports SLIDE and FADE as default animation.
105+
// animations: ANIMATIONS_SLIDE or ANIMATIONS_FADE.
105106
headers: {
106107
'my-custom-header': 'my custom header value'
107108
},
@@ -122,13 +123,14 @@ The option to support:
122123
|forceCloseOnRedirection|boolean|undefined|Workaround that Custom Tabs doesn't close on redirecting back to app scheme.([#11](https://github.com/droibit/react-native-custom-tabs/pull/11))|
123124

124125

125-
`undefined` property is the default behavior of the Custom Tabs.
126+
`undefined` property is default behavior of the Custom Tabs.
126127

127128
Customize and default look & feel.
128129
![screenshot](http://i.imgur.com/0qE2E7a.gif)
129130

130131
## License
131132

133+
Copyright (C) 2015 The Android Open Source Project
132134
Copyright (C) 2016 Shinya Kumagai
133135

134136
Licensed under the Apache License, Version 2.0 (the "License");

0 commit comments

Comments
 (0)