跳转到内容
WebView AllWebView All
这是 1.4.x 版本的文档,最新接口请切换至 latest。

通用接口

导入:

import 'package:webview_all/webview_all.dart';

构造函数:

构造函数用途
WebViewController({onPermissionRequest})使用通用参数创建 controller。
WebViewController.fromPlatformCreationParams(params, {onPermissionRequest})使用平台创建参数。
WebViewController.fromPlatform(platform, {onPermissionRequest})包装已有平台 controller。

加载:

方法返回说明
loadRequestFuture<void>加载 URL 或 HTTP 请求。
loadFileFuture<void>加载设备文件。
loadFlutterAssetFuture<void>加载 Flutter asset。
loadHtmlStringFuture<void>加载内存 HTML。
isOffscreenWebViewSupportedFuture<bool>controller 是否可在没有 WebViewWidget 时运行。
API用途
getCapabilities()查询会话模式、关闭能力及会话数据管理能力。
create({mode, onPermissionRequest})创建会话;不支持或失败时打印原因并返回 null,默认 incognito,通过 incognitoSupport 区分支持程度。
controller、cookieManager、dataManager会话页面及所选存储的数据管理器。
mode、capabilities、isClosed模式、能力和关闭状态。
close()可重复关闭,关闭前先移除组件。
API作用
create()使用默认参数创建并持有离屏 controller。
fromPlatformCreationParams(params)使用平台参数创建并持有 controller。
fromController(controller)接管已有 controller 的所有权。
controller在关闭开始前返回会话持有的 controller。
close()可重复调用,并确定性永久释放会话资源。

导航:

方法返回
currentUrl()Future<String?>
canGoBack()Future<bool>
canGoForward()Future<bool>
goBack()Future<void>
goForward()Future<void>
reload()Future<void>
setNavigationDelegate(delegate)Future<void>

JavaScript:

方法返回
setJavaScriptModeFuture<void>
runJavaScriptFuture<void>
runJavaScriptReturningResultFuture<Object>
callAsyncJavaScriptFuture<Object?>
isUserScriptInjectionSupportedFuture<bool>
addUserScriptFuture<String>,返回不透明脚本标识
removeUserScript / removeAllUserScriptsFuture<void>
addJavaScriptChannel(String name, {required void Function(JavaScriptMessage) onMessageReceived})Future<void>
removeJavaScriptChannelFuture<void>
setOnConsoleMessageFuture<void>
setOnJavaScriptAlertDialogFuture<void>
setOnJavaScriptConfirmDialogFuture<void>
setOnJavaScriptTextInputDialogFuture<void>

视图状态:

方法返回
getTitle()Future<String?>
scrollTo / scrollByFuture<void>
getScrollPosition()Future<Offset>
setOnScrollPositionChangeFuture<void>
setVerticalScrollBarEnabled / setHorizontalScrollBarEnabledFuture<void>
supportsSetScrollBarsEnabled()Future<bool>
enableZoomFuture<void>
setBackgroundColorFuture<void>
setUserAgent / getUserAgentFuture<void> / Future<String?>
setOverScrollModeFuture<void>
回调作用
onNavigationRequest允许或阻止导航。
onPageStarted页面开始加载。
onPageFinished页面加载完成。
onProgress加载进度。
onWebResourceError资源错误。
onUrlChangeURL 变化。
onTitleChange主文档标题变化;空标题遵循引擎默认行为。
onHttpAuthRequestHTTP 鉴权。
onHttpErrorHTTP 状态错误。
onSslAuthError可恢复 SSL 证书错误。

WebViewWidget 接收 WebViewController 并委托当前平台实现构建 native/Web 视图。

方法返回作用
clearCookies()Future<bool>清空 cookie。
setCookie(WebViewCookie cookie)Future<void>设置通用 cookie。
getCookies({required Uri domain})Future<List<WebViewCookie>>获取指定域名可见 cookie。
方法返回作用
clearAllWebsiteData()Future<WebViewDataClearingResult>无需 controller 即可清理网站数据,并返回已清理、不支持和失败的数据类型。

默认构造函数使用当前平台的默认持久化数据区;也可通过 fromPlatformCreationParams 或 fromPlatform 使用平台参数或已有平台实现。

webview_all.dart 导出 WebViewSession、WebViewSessionMode、WebViewSessionCapabilities、WebViewIncognitoSupport、OffscreenWebViewSession、LoadRequestMethod、NavigationDecision、NavigationRequest、WebResourceError、HttpResponseError、HttpAuthRequest、WebViewCredential、JavaScriptMode、JavaScriptMessage、JavaScriptConsoleMessage、JavaScriptExecutionException、JavaScriptInvocationParams、JS dialog request、ScrollPositionChange、WebViewCookie、WebViewDataClearingResult、WebViewDataType、WebViewUserScript、WebViewUserScriptInjectionTime、WebViewOverScrollMode、WebViewPermissionResourceType 和 WebViewPlatform 等类型。