cap-browser
TypeScript icon, indicating that this package has built-in type declarations

0.4.0 • Public • Published

CapBrowser

This capacitor plugin looks similar to Browser core plugin but with additional features like

  • Http header support (iOS & Android)
  • Browser url change event (iOS & Android)
  • Can show LaunchImage as privacy screen (iOS only)
  • Support for plain browser (iOS & Android)
  • Custom configuration for browser UI (iOS & Android)

API

open

CapBrowser.open({
    url:  'http://google.com/',
    headers: { "one":  "1", "two":  "2" },
    isPresentAfterPageLoad: true
}).then(() => {
    console.log('showing the window');
})

openWebView - Opens a plain webView instance without navBar

CapBrowser.openWebView({
    url: 'https://www.google.com/',
    headers: { "one": "1", "two": "2" },
    title: "Custom Title",
    toolbarType: "navigation",
    shareDisclaimer: {
    title: "Disclaimer",
    message: "Some Content",
    confirmBtn: "Proceed",
    cancelBtn: "No"
    },
    shareSubject: "Some subject",
    isPresentAfterPageLoad: true
}).then(() => {
    console.log('showing the window');
})

Close

CapBrowser.close().then(() => {
    console.log('browser closed');
})

Available Events - Works for both android (on webView) and iOS

CapBrowser.addListener("urlChangeEvent", (info:  any) => {
    console.log(info.url)
})
 
CapBrowser.addListener("confirmBtnClicked", (info:  any) => {
    // will be triggered when user clicks on confirm button when disclaimer is required, works only on iOS
    console.log(info.url)
})

Options

toobarType

export enum ToolBarType {
    ACTIVITY = "activity",
    NAVIGATION = "navigation",
    BLANK = "blank",
    DEFAULT = ""
}

TODO

[ ] XXX

Credits

Readme

Keywords

Package Sidebar

Install

npm i cap-browser

Weekly Downloads

3

Version

0.4.0

License

MIT

Unpacked Size

937 kB

Total Files

231

Last publish

Collaborators

  • rakeshrao1232