nativescript-inappbrowser
Advanced tools
tns plugin add nativescript-inappbrowser
| Methods | Action |
|---|---|
open | Opens the url with Safari in a modal on iOS using SFSafariViewController, and Chrome in a new custom tab on Android. On iOS, the modal Safari will not share cookies with the system Safari. |
close | Dismisses the system's presented web browser. |
openAuth | Opens the url with Safari in a modal on iOS using SFAuthenticationSession/ASWebAuthenticationSession, and Chrome in a new custom tab on Android. On iOS, the user will be asked whether to allow the app to authenticate using the given url (OAuth flow with deep linking redirection). |
closeAuth | Dismisses the current authentication session. |
isAvailable | Detect if the device supports this plugin. |
| Property | Description |
|---|---|
dismissButtonStyle (String) | The style of the dismiss button. [done/close/cancel] |
preferredBarTintColor (String) | The color to tint the background of the navigation bar and the toolbar. [white/#FFFFFF] |
preferredControlTintColor (String) | The color to tint the control buttons on the navigation bar and the toolbar. [gray/#808080] |
readerMode (Boolean) | A value that specifies whether Safari should enter Reader mode, if it is available. [true/false] |
animated (Boolean) | Animate the presentation. [true/false] |
modalPresentationStyle (String) | The presentation style for modally presented view controllers. [automatic/none/fullScreen/pageSheet/formSheet/currentContext/custom/overFullScreen/overCurrentContext/popover] |
modalTransitionStyle (String) | The transition style to use when presenting the view controller. [coverVertical/flipHorizontal/crossDissolve/partialCurl] |
modalEnabled (Boolean) | Present the SafariViewController modally or as push instead. [true/false] |
enableBarCollapsing (Boolean) | Determines whether the browser's tool bars will collapse or not. [true/false] |
ephemeralWebSession (Boolean) | Prevent re-use cookies of previous session (openAuth only) [true/false] |
| Property | Description |
|---|---|
showTitle (Boolean) | Sets whether the title should be shown in the custom tab. [true/false] |
toolbarColor (String) | Sets the toolbar color. [gray/#808080] |
secondaryToolbarColor (String) | Sets the color of the secondary toolbar. [white/#FFFFFF] |
enableUrlBarHiding (Boolean) | Enables the url bar to hide as the user scrolls down on the page. [true/false] |
enableDefaultShare (Boolean) | Adds a default share item to the menu. [true/false] |
animations (Object) | Sets the start and exit animations. [{ startEnter, startExit, endEnter, endExit }] |
headers (Object) | The data are key/value pairs, they will be sent in the HTTP request headers for the provided url. [{ 'Authorization': 'Bearer ...' }] |
forceCloseOnRedirection (Boolean) | Open Custom Tab in a new task to avoid issues redirecting back to app scheme. [true/false] |
hasBackButton (Boolean) | Sets a back arrow instead of the default X icon to close the custom tab. [true/false] |
browserPackage (String) | Package name of a browser to be used to handle Custom Tabs. |
showInRecents (Boolean) | Determining whether browsed website should be shown as separate entry in Android recents/multitasking view. [true/false] |
import { Utils, Dialogs } from '@nativescript/core';
import { InAppBrowser } from 'nativescript-inappbrowser';
...
openLink = async () => {
try {
const url = 'https://www.google.com'
if (await InAppBrowser.isAvailable()) {
const result = await InAppBrowser.open(url, {
// iOS Properties
dismissButtonStyle: 'cancel',
preferredBarTintColor: '#453AA4',
preferredControlTintColor: 'white',
readerMode: false,
animated: true,
modalPresentationStyle: 'fullScreen',
modalTransitionStyle: 'coverVertical',
modalEnabled: true,
enableBarCollapsing: false,
// Android Properties
showTitle: true,
toolbarColor: '#6200EE',
secondaryToolbarColor: 'black',
enableUrlBarHiding: true,
enableDefaultShare: true,
forceCloseOnRedirection: false,
// Specify full animation resource identifier(package:anim/name)
// or only resource name(in case of animation bundled with app).
animations: {
startEnter: 'slide_in_right',
startExit: 'slide_out_left',
endEnter: 'slide_in_left',
endExit: 'slide_out_right'
},
headers: {
'my-custom-header': 'my custom header value'
},
hasBackButton: true,
browserPackage: '',
showInRecents: false
});
Dialogs.alert({
title: 'Response',
message: JSON.stringify(result),
okButtonText: 'Ok'
});
}
else {
Utils.openUrl(url);
}
}
catch(error) {
Dialogs.alert({
title: 'Error',
message: error.message,
okButtonText: 'Ok'
});
}
}
...
In order to redirect back to your application from a web browser, you must specify a unique URI to your app. To do this,
define your app scheme and replace my-scheme and my-host with your info.
<intent-filter>
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
<data android:scheme="my-scheme" android:host="my-host" />
</intent-filter>
<key>CFBundleURLTypes</key>
<array>
<dict>
<key>CFBundleTypeRole</key>
<string>Editor</string>
<key>CFBundleURLName</key>
<string>my-scheme</string>
<key>CFBundleURLSchemes</key>
<array>
<string>my-scheme</string>
</array>
</dict>
</array>
export const getDeepLink = (path = "") => {
const scheme = 'my-scheme';
const prefix = global.isAndroid ? `${scheme}://my-host/` : `${scheme}://`;
return prefix + path;
}
import { Utils, Dialogs } from '@nativescript/core';
import { InAppBrowser } from 'nativescript-inappbrowser';
import { getDeepLink } from './utilities';
...
async onLogin() {
const deepLink = getDeepLink('callback')
const url = `https://my-auth-login-page.com?redirect_uri=${deepLink}`
try {
if (await InAppBrowser.isAvailable()) {
InAppBrowser.openAuth(url, deepLink, {
// iOS Properties
ephemeralWebSession: false,
// Android Properties
showTitle: false,
enableUrlBarHiding: true,
enableDefaultShare: false
}).then((response) => {
if (
response.type === 'success' &&
response.url
) {
Utils.openUrl(response.url)
}
})
} else Utils.openUrl(url)
} catch (error) {
Utils.openUrl(url)
}
}
...
Using in-app browser tabs (like SFAuthenticationSession/ASWebAuthenticationSession and Android Custom Tabs) where available. Embedded user-agents, known as web-views (like UIWebView and WKWebView), are explicitly not supported due to the usability and security reasons documented in Section 8.12 of RFC 8252.
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated ❤️.
You can learn more about how you can contribute to this project in the contribution guide.
Please do contribute! Issues and pull requests are welcome.
This project exists thanks to all the people who contribute. [Contribute].
 Juan Nicholls ✉ |  Nathanael Anderson ✉ |
|---|
Become a financial contributor and help us sustain our community. [Contribute]
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
I believe in Unicorns 🦄 Support me, if you do too.
Available as part of the Tidelift Subscription.
The maintainers of InAppBrowser for NativeScript and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
This repository is available under the MIT License.
Made with ❤️
FAQs
InAppBrowser for NativeScript
The npm package nativescript-inappbrowser receives a total of 542 weekly downloads. As such, nativescript-inappbrowser popularity was classified as not popular.
We found that nativescript-inappbrowser demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
