- 版本:9.0.1
- GitHub: https://github.com/Essent/nativescript-plugins
- NPM: https://npmjs.net.cn/package/%40essent%2Fnativescript-webview-ext
- 下载量
- 昨日:8
- 上周:38
- 上月:145
@essent/nativescript-webview-ext
为 NativeScript 扩展 WebView 功能,增加 "x-local"-自定义方案以加载本地文件,处理 WebView 和 NativeScript 之间的事件,JavaScript 执行,注入 CSS 和 JS 文件。支持 Android 19+ 和 iOS9+。
注意:这扩展并更新了优秀的:https://github.com/Notalib/nativescript-webview-ext
npm install @essent/nativescript-webview-ext
功能
- 为 WebView 添加了
x-local://
的自定义方案处理程序,用于在 WebView 内部加载资源。- 注意:此功能在 iOS <11 上不受支持
- 增加对捕获 URL 的支持。
- 这允许应用程序在外部浏览器中打开外部链接并处理 tel 链接
- 增加了如下函数
executeJavaScript(code: string)
用于执行 JavaScript 代码并获取结果。executePromise(code: string)
用于调用 promises 并获取结果。getTitle()
返回 document.title。
- 在
NativeScript
和WebView
之间实现双向事件监听器- 从
NativeScript
到WebView
- 从
WebView
到NativeScript
- 从
- 添加了注入
css
和javascript
文件的函数。- 到当前页面。
- 在页面加载时自动注入。
- 填充
- Promise
- Fetch API(在 Android 上覆盖原生 API 以支持 x-local:// 和 file://)
- 允许使用
WkWebView
来使用alert
、confirm
和prompt
。 - 支持
- Android 19+
- iOS 11+:完全支持
- iOS <11:部分支持
将 minSdkVersion 更新到 19 或更高
需要 Android SDK 19,更新 App_Resources/Android/app.gradle
android {
defaultConfig {
minSdkVersion 19 // change this line
generatedDensities = []
}
aaptOptions {
additionalParameters "--no-version-vectors"
}
}
核心支持
按如下模板加载
<Page class="page" xmlns="http://schemas.nativescript.org/tns.xsd" xmlns:essent="@essent/nativescript-webview-ext">
<ActionBar class="action-bar">
<Label class="action-bar-title" text="Home"></Label>
</ActionBar>
<essent:WebViewExt src="https://nota.dk"></<essent:WebViewExt>
</Page>
Angular 支持
从 @essent/nativescript-webview-ext/angular
导入 WebViewExtModule
并将其添加到您的 NgModule
。
这注册了 WebViewExt
元素。将 <WebView>
标签替换为 <WebViewExt>
Vue 支持
在您的应用程序入口文件(可能是 app.js 或 main.js)中导入 @essent/nativescript-webview-ext/vue
。
这注册了 WebViewExt
元素。将 <WebView>
标签替换为 <WebViewExt>
用法
限制
x-local://
的自定义方案处理程序仅在 Android
和 iOS 11+
上受支持
由于 ITMS-90809,移除了 iOS <11
的自定义方案支持。
API
NativeScript 视图
属性 | 值 | 描述 |
---|---|---|
readonly supportXLocalScheme | true / false | 是否支持 x-local:// ?在 iOS >= 11 或 Android 上为 true,在 iOS < 11 上为 false。 |
src | 加载 src | |
autoInjectJSBridge | true / false | 是否在 loadFinishedEvent 事件上注入 window.nsWebViewBridge?默认为 true |
builtInZoomControls | true / false | Android:是否使用内置缩放机制 |
cacheMode | default / no_cache / cache_first / cache_only | Android:设置缓存模式。 |
databaseStorage | true / false | Android:启用/禁用数据库存储 API。注意:它会影响进程中的所有 WebView。 |
debugMode | true / false | Android: 在Android上启用WebView的Chrome调试器。注意:适用于应用中的所有WebView。 |
displayZoomControls | true / false | Android: 使用内置缩放机制时显示屏幕缩放控件。 |
domStorage | true / false | Android: 启用/禁用DOM存储API。例如localStorage。 |
scrollBounce | true / false | iOS: scrollView是否应该弹跳?默认为true。 |
supportZoom | true / false | Android: WebView是否应该支持缩放。 |
viewPortSize | false / view-port字符串 / ViewPortProperties | 在加载完成后设置viewport元数据。注意:WkWebView默认将initial-scale设置为1.0。 |
limitsNavigationsToAppBoundDomains | false | iOS: 允许启用Service Workers 注意:如果设置为true,WKAppBoundDomains也应在info.plist中设置。 |
函数 | 描述 |
---|---|
loadUrl(src: 字符串): Promise |
打开一个URL,在加载完成后解析一个Promise。 |
registerLocalResource(resourceName: 字符串, path: 字符串): void; | 将“x-local://{resourceName}”映射为“{path}”。 |
unregisterLocalResource(resourceName: 字符串): void; | 从“x-local://{resourceName}”映射为“{path}”中移除映射。 |
getRegisteredLocalResource(resourceName: 字符串): void; | 从“x-local://{resourceName}”映射为“{path}”中获取映射。 |
loadJavaScriptFile(scriptName: 字符串, filepath: 字符串) | 将javascript文件注入到WebView中。应在loadFinishedEvent 之后调用。 |
loadStyleSheetFile(stylesheetName: 字符串, filepath: 字符串, insertBefore: 布尔) | 将CSS文件加载到document.head中。如果before为true,它将被添加到document.head的顶部,否则作为最后一个元素。 |
loadJavaScriptFiles(files: {resourceName: 字符串, filepath: 字符串}[]) | 将多个javascript文件注入到WebView中。应在loadFinishedEvent 之后调用。 |
loadStyleSheetFiles(files: {resourceName: 字符串, filepath: 字符串, insertBefore: 布尔}[]) | 将多个CSS文件加载到document.head中。如果before为true,它将被添加到document.head的顶部,否则作为最后一个元素。 |
autoLoadJavaScriptFile(resourceName: 字符串, filepath: 字符串) | 在loadFinishedEvent 上注册一个要注入的JavaScript文件。如果页面已经加载,脚本将被注入到当前页面。 |
autoLoadStyleSheetFile(resourceName: 字符串, filepath: 字符串, insertBefore?: 布尔) | 在loadFinishedEvent 上注册一个要注入的CSS文件。如果页面已经加载,CSS文件将被注入到当前页面。 |
autoExecuteJavaScript(scriptCode: 字符串, name: 字符串) | 在loadFinishedEvent 上执行一个脚本。脚本可以是一个Promise。 |
executeJavaScript(scriptCode: 字符串) | 在网页中执行JavaScript。注意:scriptCode应该与ES5兼容,否则可能在‘iOS < 11’上无法工作。 |
executePromise(scriptCode: 字符串, timeout: 数字 = 500) | 在WebView中运行一个Promise。 注意:执行scriptCode必须返回一个Promise。 |
emitToWebView(eventName: 字符串, data: 任意) | 向WebView发出一个事件。注意:data必须可以使用JSON.stringify进行序列化,否则会抛出异常。 |
getTitle() | 返回一个包含当前文档标题的Promise。 |
事件
事件 | 描述 |
---|---|
loadFinished | 在发生loadFinished事件时被触发。args是一个LoadFinishedEventData 。 |
loadProgress | Android仅:在页面加载期间触发,以指示进度。args是一个LoadProgressEventData 。 |
loadStarted | 在发生loadStarted事件时被触发。args是一个LoadStartedEventData 。 |
shouldOverrideUrlLoading | 在WebView请求URL之前触发。可以通过在ShouldOverrideUrlLoadEventData 中设置args.cancel = true来取消。 |
titleChanged | 文档标题已更改 |
webAlert | 当在WebView内部触发window.alert 时被触发,需要使用自定义对话框来处理web警告。args是一个WebAlertEventData 。必须调用args.callback() 来指示警告已关闭。 |
webConfirm | 当在webview内部触发window.confirm 时被触发,需要使用自定义对话框来使用web确认框。在webConfirmEvent 中提供参数。args.callback(boolean) 必须被调用以指示确认框已关闭。 |
webConsole | 仅限Android:当向web控制台添加一行时被触发。参数是WebConsoleEventData 。 |
webPrompt | 当在webview内部触发window.prompt 时被触发,需要使用自定义对话框来使用web提示框。在webConfirmEvent 中提供参数。`args.callback(string |
webview发出的事件 | 当在webview内部调用nsWebViewBridge.emit(...)时被触发。参数在WebViewEventData 中。 |
WebView
在WebView内部,我们有nsWebViewBridge
用于在NativeScript
-层和WebView
之间发送事件。注意:该桥接器仅在使用DOMContentLoaded
或onload
时在WebView内部可用。
函数 | 描述 |
---|---|
window.nsWebViewBridge.on(eventName: string, cb: (data: any) => void) | 为来自原生层的事件注册处理程序。 |
window.nsWebViewBridge.off(eventName: string, cb?: (data: any) => void) | 注销来自原生层的事件处理程序。 |
window.nsWebViewBridge.emit(eventName: string, data: any) | 向NativeScript层发出事件。将在WebViewExt上以任何其他事件的形式发出,数据将是WebViewEventData对象的组成部分 |
等待nsWebViewBridge可用
window.addEventListener("ns-bridge-ready", function(e) {
var nsWebViewBridge = e.detail || window.nsWebViewBridge;
// do stuff here
});
可能的功能
- Cookie辅助工具?
- 与原生层共享缓存?
Android
- 设置
- AppCache?
- 用户代理?
iOS
- 设置?
关于Nota
Nota是丹麦为印刷障碍人士提供图书馆和专家中心。要成为Nota的成员,您必须能够证明您无法阅读普通印刷文本。Nota的成员是视障人士、阅读障碍或其他人。
许可证
Apache许可证版本2.0