@capgo/inappbrowser

Install

npm install @capgo/inappbrowser
npx cap sync

API

• open(...)
• close()
• openWebView(...)
• setUrl(...)
• addListener('urlChangeEvent', ...)
• addListener('closeEvent', ...)
• addListener('confirmBtnClicked', ...)
• Interfaces
• Type Aliases
• Enums

open(...)

open(options: OpenOptions) => Promise<any>

| Param | Type | | ------------- | --------------------------------------------------- | | options | OpenOptions |

Returns: Promise<any>

close()

close() => Promise<any>

Returns: Promise<any>

openWebView(...)

openWebView(options: OpenWebViewOptions) => Promise<any>

| Param | Type | | ------------- | ----------------------------------------------------------------- | | options | OpenWebViewOptions |

Returns: Promise<any>

setUrl(...)

setUrl(options: { url: string; }) => Promise<any>

| Param | Type | | ------------- | ----------------------------- | | options | { url: string; } |

Returns: Promise<any>

addListener('urlChangeEvent', ...)

addListener(eventName: 'urlChangeEvent', listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for url change

| Param | Type | | ------------------ | --------------------------------------------------------------- | | eventName | 'urlChangeEvent' | | listenerFunc | UrlChangeListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 0.0.1

addListener('closeEvent', ...)

addListener(eventName: 'closeEvent', listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for close click

| Param | Type | | ------------------ | --------------------------------------------------------------- | | eventName | 'closeEvent' | | listenerFunc | UrlChangeListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 0.4.0

addListener('confirmBtnClicked', ...)

addListener(eventName: 'confirmBtnClicked', listenerFunc: ConfirmBtnListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Will be triggered when user clicks on confirm button when disclaimer is required, works only on iOS

| Param | Type | | ------------------ | ----------------------------------------------------------------- | | eventName | 'confirmBtnClicked' | | listenerFunc | ConfirmBtnListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 0.0.1

Interfaces

OpenOptions

| Prop | Type | | ---------------------------- | ------------------------------------------- | | url | string | | headers | Headers | | isPresentAfterPageLoad | boolean |

Headers

OpenWebViewOptions

| Prop | Type | | ---------------------------- | --------------------------------------------------------------- | | url | string | | headers | Headers | | shareDisclaimer | DisclaimerOptions | | toolbarType | ToolBarType | | shareSubject | string | | title | string | | backgroundColor | BackgroundColor | | isPresentAfterPageLoad | boolean |

DisclaimerOptions

| Prop | Type | | ---------------- | ------------------- | | title | string | | message | string | | confirmBtn | string | | cancelBtn | string |

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

UrlEvent

| Prop | Type | Description | Since | | --------- | ------------------- | ------------------------- | ----- | | url | string | Emit when the url changes | 0.0.1 |

BtnEvent

| Prop | Type | Description | Since | | --------- | ------------------- | ------------------------------ | ----- | | url | string | Emit when a button is clicked. | 0.0.1 |

Type Aliases

UrlChangeListener

(state: UrlEvent): void

ConfirmBtnListener

(state: BtnEvent): void

Enums

ToolBarType

| Members | Value | | ---------------- | ------------------------- | | ACTIVITY | 'activity' | | NAVIGATION | 'navigation' | | BLANK | 'blank' | | DEFAULT | '' |

BackgroundColor

| Members | Value | | ----------- | -------------------- | | WHITE | 'white' | | BLACK | 'black' |

Credits

• WKWebViewController - for iOS
• CapBrowser - For the base in capacitor v2