mobile-web-bridge 0.1.4 → 0.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -8
- package/dist/apiManifest.d.ts +1 -1
- package/dist/index.js +21 -8
- package/dist/mwb.iife.js +21 -8
- package/dist/plugins/basic.d.ts +1 -0
- package/dist/plugins/container.d.ts +1 -0
- package/dist/types.d.ts +54 -87
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
MWB 为 iOS 和 Android 的 Web 容器提供统一 JS API。原生通信由 DSBridge 3.x 完成。
|
|
4
4
|
|
|
5
|
-
当前版本为 `0.1.
|
|
5
|
+
当前版本为 `0.1.6`,与同一 Git Tag 下的 iOS/Android 源码配套。下方安装命令固定为 `0.1.6`;分发状态见 [版本说明](https://github.com/gaoxiao228/MobileWebBridge/blob/main/docs/versioning.md),需要本地构建时可按 [源码构建与安装](https://github.com/gaoxiao228/MobileWebBridge#从源码构建-js-sdk) 使用。
|
|
6
6
|
|
|
7
7
|
正式仓库:[gaoxiao228/MobileWebBridge](https://github.com/gaoxiao228/MobileWebBridge)。建议固定精确版本;Git Tag 与 npm 分发标签独立,原生接入与支持范围见 [项目 README](https://github.com/gaoxiao228/MobileWebBridge#readme)。
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ MWB 为 iOS 和 Android 的 Web 容器提供统一 JS API。原生通信由 DSBr
|
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
12
|
# 固定项目版本;原生端也使用配套版本。
|
|
13
|
-
npm install mobile-web-bridge@0.1.
|
|
13
|
+
npm install mobile-web-bridge@0.1.6
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
```ts
|
|
@@ -32,7 +32,7 @@ await mwb.setNavigationBarTheme({
|
|
|
32
32
|
});
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
仅显式提供新 onActionClick 才替换原回调;局部颜色、显隐或 actionExt 更新保留 handler;传入 `actionTxt: ""` 可移除按钮。`onActionClick` 不会序列化传给原生,原生点击时只回传 `actionExt`。目前 iOS、Android 均支持文字按钮,`actionIcon` 尚不支持。
|
|
36
36
|
|
|
37
37
|
网页也可直接引入发布包中的 `dist/mwb.iife.js`,通过 `window.mwb` 调用。应在 MWB 原生容器内加载;普通浏览器中的原生调用会给出“桥未就绪”错误。
|
|
38
38
|
|
|
@@ -42,7 +42,7 @@ await mwb.setNavigationBarTheme({
|
|
|
42
42
|
|
|
43
43
|
当前源码新增 `await mwb.basic.notifyPageReady()`(也可用根入口 `mwb.notifyPageReady()`),用于 H5 主动通知当前原生容器首屏准备完成。无需注册业务插件,重复调用幂等。成功表示原生接受通知,不代表宿主已完成展示。
|
|
44
44
|
|
|
45
|
-
此能力请配套使用 JS、iOS 和 Android `0.1.
|
|
45
|
+
此能力请配套使用 JS、iOS 和 Android `0.1.6`。此方法走文档身份网关,等待上限 30000ms;旧原生和普通浏览器明确失败。调用时机、原生回调和重载规则见 [接入说明](https://github.com/gaoxiao228/MobileWebBridge/blob/main/docs/page-lifecycle.md)。
|
|
46
46
|
|
|
47
47
|
## 同步与异步调用
|
|
48
48
|
|
|
@@ -76,7 +76,7 @@ try {
|
|
|
76
76
|
|
|
77
77
|
### basic 异步方法
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
当前源码的 22 个 basic 异步原生入口(例如 `toast`、`navigateTo`、`redirectTo`、`chooseImage`、`scanCode`)返回 `Promise<GenericAsyncResult<T>>`。成功为 `{errCode: 0, result?: T}`;失败拒绝 Promise,不应只在 `.then` 中检查 errCode。
|
|
80
80
|
|
|
81
81
|
```ts
|
|
82
82
|
import { mwb, MWBBridgeError } from "mobile-web-bridge";
|
|
@@ -97,11 +97,13 @@ Promise 完成仅表示该方法约定的操作完成:`navigateTo` 默认在
|
|
|
97
97
|
|
|
98
98
|
当前 iOS 源码可传 `await mwb.navigateTo({ url: childURL, waitForReady: true })`,由 SDK 自动等待主文档加载及 WebKit 绘制准备后再发起原系统转场;无需 H5 报告 ready。参数默认 `false`,Android 应省略此参数。总等待 3000 ms,加载/绘制失败或超时拒绝为 `-1002`,源页离开或后台取消为 `-1005`,同源已有准备请求为 `-1004`,非布尔值为 `-1001`。源文档失效后旧回复丢弃。成功不表示动画结束或异步业务数据完成,详见 [iOS 接入说明](../MWB-iOS/README.md)。
|
|
99
99
|
|
|
100
|
+
`redirectTo` 与 `mwb.basic.redirectTo` 共用函数,用于替换当前容器,返回时跳过旧页。两端可立即替换;`waitForReady` 仅 iOS 支持,Android 必须省略。旧页成功替换后会销毁,后续业务在目标页初始化,不依赖旧页成功回调继续运行;完整参数和平台边界见[页面打开与替换](https://github.com/gaoxiao228/MobileWebBridge/blob/main/docs/navigation.md)。此方法自 `0.1.5` 提供,需同步升级 JS 与原生 SDK。
|
|
101
|
+
|
|
100
102
|
除新增 `notifyPageReady()` 外,既有 basic 异步调用没有统一超时及文档失效兜底;原生未回调时可能持续等待。业务添加等待超时只会停止自己的等待,不代表原生操作已取消;支付等操作尤其不能据超时推断业务失败或直接重试。
|
|
101
103
|
|
|
102
104
|
### 事件与自定义插件
|
|
103
105
|
|
|
104
|
-
18 个 JS 句柄/事件方法不属于上述
|
|
106
|
+
18 个 JS 句柄/事件方法不属于上述 31 个原生入口。`onAppShow`、`registerHandler` 等注册方法立即返回,回调后续触发;`await mwb.onAppShow(handler)` 不会等待应用进入前台。使用对应 `off` / `unRegister` 方法解绑;插件 `.on()` 返回解绑函数。
|
|
105
107
|
|
|
106
108
|
通过 `defineNativePlugin` 声明的业务方法**只支持 `Promise<GenericAsyncResult<T>>`**。即便原生立即调用 `responder.success`,JS 仍应使用异步契约;不能声明普通对象返回值,也没有 `sync: true` 配置。`hasPlugin` 同样返回 Promise。
|
|
107
109
|
|
|
@@ -109,7 +111,7 @@ Promise 完成仅表示该方法约定的操作完成:`navigateTo` 默认在
|
|
|
109
111
|
|
|
110
112
|
## 插件组合与构建
|
|
111
113
|
|
|
112
|
-
当前源码默认提供 basic 的
|
|
114
|
+
当前源码默认提供 basic 的 50 个方法。源码分为 `container`、`device`、`media`、`storage` 四组;事件和 JS 句柄始终包含在 SDK 内。`basicPlugin` 为完整组合,`--plugins=basic` 可构建全量 basic;与旧分组混用时去重。原有 `createMWB(legacyPlugins)` 数组裁剪入口保留,只在 basic 下映射选中的方法。重复方法或覆盖 Core/事件入口的配置直接报错。
|
|
113
115
|
|
|
114
116
|
```bash
|
|
115
117
|
pnpm install
|
|
@@ -150,7 +152,7 @@ if (await sdk.hasPlugin("network")) {
|
|
|
150
152
|
|
|
151
153
|
调用参数、成功结果和事件只接受 JSON:拒绝循环、函数、undefined 字段、非有限数字、非普通对象或 getter/setter。省略参数按 null 处理;显式结果 null 保留。超时默认 30000ms,允许整数 1..120000ms,超时以 `MWBBridgeError(-1103)` 拒绝。缺插件/方法分别为 `-1100/-1101`,旧壳无网关为 `-1106`,完整错误表见接入文档。
|
|
152
154
|
|
|
153
|
-
名称采用 `[a-z][a-zA-Z0-9_]*`。插件名不得占用当前
|
|
155
|
+
名称采用 `[a-z][a-zA-Z0-9_]*`。插件名不得占用当前 50 个根方法、basic/version/hasPlugin、pluginSession/pluginInfo/invokePlugin/pluginEvent、dispatchEvent/backBtnPressed 或以下探测名。业务方法和事件禁止 `on/then/catch/finally/toJSON/inspect/constructor/prototype/__proto__`;`on` 专用于订阅。读取方法属性不发请求,Proxy 的 Promise/JSON/Symbol 探测不会调用原生。不要通过 `typeof sdk.network.someMethod` 判断原生是否支持该方法,原生才会根据标记方法返回 `-1101`。
|
|
154
156
|
|
|
155
157
|
## 接口约定
|
|
156
158
|
|
|
@@ -167,3 +169,5 @@ if (await sdk.hasPlugin("network")) {
|
|
|
167
169
|
MWB 的通信底层基于 [DSBridge](https://github.com/wendux/DSBridge-Android)(MIT)。接口能力参考当前工作区的旧项目,MWB 不依赖 Cordova。
|
|
168
170
|
|
|
169
171
|
包内包含 LICENSE 和 THIRD_PARTY_NOTICES.md,ESM/IIFE/组合脚本保留完整许可注释;单独分发 bundle 时也不要移除这些注释。
|
|
172
|
+
|
|
173
|
+
`0.1.6` 支持三个导航方法共用外观字段,宿主可设置 `navigationBarAppearance` 默认主题;打开或替换页面时,目标页首帧前即应用外观。按钮背景开关仅 iOS 26 及以上支持,Android 请省略。详见[原生导航栏外观](../docs/navigation-bar.md)。
|
package/dist/apiManifest.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const apiMethods: readonly ["notifyPageReady", "setEnableDebug", "openAppAuthorizeSetting", "toast", "getAppInfoSync", "setBadgeCount", "navigateTo", "navigateBack", "navigateBackToRoot", "openExternalBrowser", "setNavigationBarTheme", "getDeviceInfoSync", "getClipboardDataSync", "setClipboardData", "makePhoneCall", "getNetworkTypeSync", "getNotificationSwitchStatus", "cleanWebviewCache", "compressImage", "scanCode", "saveImageToPhotosAlbum", "chooseImage", "setStorageSync", "getStorageSync", "removeStorageSync", "clearStorageSync", "openFile", "exitApp", "checkRequestCameraPermissions", "convertImagePathToBase64", "openNativePage", "registerHandler", "unRegisterHandlers", "unRegisterHandler", "checkHandlerExist", "onNetworkStatusChange", "offNetworkStatusChange", "onAppShow", "offAppShow", "onAppHide", "offAppHide", "onRemoteNotificationReceive", "offRemoteNotificationReceive", "onPageShow", "offPageShow", "onPageHide", "offPageHide", "onBackBtnPressed", "offBackBtnPressed"];
|
|
1
|
+
export declare const apiMethods: readonly ["notifyPageReady", "setEnableDebug", "openAppAuthorizeSetting", "toast", "getAppInfoSync", "setBadgeCount", "navigateTo", "redirectTo", "navigateBack", "navigateBackToRoot", "openExternalBrowser", "setNavigationBarTheme", "getDeviceInfoSync", "getClipboardDataSync", "setClipboardData", "makePhoneCall", "getNetworkTypeSync", "getNotificationSwitchStatus", "cleanWebviewCache", "compressImage", "scanCode", "saveImageToPhotosAlbum", "chooseImage", "setStorageSync", "getStorageSync", "removeStorageSync", "clearStorageSync", "openFile", "exitApp", "checkRequestCameraPermissions", "convertImagePathToBase64", "openNativePage", "registerHandler", "unRegisterHandlers", "unRegisterHandler", "checkHandlerExist", "onNetworkStatusChange", "offNetworkStatusChange", "onAppShow", "offAppShow", "onAppHide", "offAppHide", "onRemoteNotificationReceive", "offRemoteNotificationReceive", "onPageShow", "offPageShow", "onPageHide", "offPageHide", "onBackBtnPressed", "offBackBtnPressed"];
|
package/dist/index.js
CHANGED
|
@@ -222,7 +222,7 @@ var require_dsbridge = __commonJS({
|
|
|
222
222
|
var import_dsbridge = __toESM(require_dsbridge(), 1);
|
|
223
223
|
|
|
224
224
|
// src/types.ts
|
|
225
|
-
var version = "0.1.
|
|
225
|
+
var version = "0.1.6";
|
|
226
226
|
|
|
227
227
|
// src/eventHub.ts
|
|
228
228
|
var hubs = /* @__PURE__ */ new WeakMap();
|
|
@@ -408,16 +408,24 @@ function assembleMWB(plugins) {
|
|
|
408
408
|
const nativeSetTheme = methods.setNavigationBarTheme;
|
|
409
409
|
if (nativeSetTheme) {
|
|
410
410
|
let currentActionClick;
|
|
411
|
+
let themeQueue = Promise.resolve();
|
|
411
412
|
methods.setNavigationBarTheme = async (param) => {
|
|
412
413
|
const { onActionClick, ...nativeParam } = param;
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
currentActionClick = void 0;
|
|
416
|
-
if (nativeParam.actionTxt?.trim() && onActionClick) {
|
|
417
|
-
events.registerHandler("navigationActionClick", onActionClick);
|
|
418
|
-
currentActionClick = onActionClick;
|
|
414
|
+
if (onActionClick !== void 0 && typeof onActionClick !== "function") {
|
|
415
|
+
throw new TypeError("onActionClick must be a function");
|
|
419
416
|
}
|
|
420
|
-
|
|
417
|
+
const request = themeQueue.then(async () => {
|
|
418
|
+
const result = await nativeSetTheme(nativeParam);
|
|
419
|
+
const clearsAction = typeof nativeParam.actionTxt === "string" && !nativeParam.actionTxt.trim();
|
|
420
|
+
if (clearsAction || onActionClick !== void 0) {
|
|
421
|
+
if (currentActionClick) events.unRegisterHandler("navigationActionClick", currentActionClick);
|
|
422
|
+
currentActionClick = clearsAction ? void 0 : onActionClick;
|
|
423
|
+
if (currentActionClick) events.registerHandler("navigationActionClick", currentActionClick);
|
|
424
|
+
}
|
|
425
|
+
return result;
|
|
426
|
+
});
|
|
427
|
+
themeQueue = request.catch(() => void 0);
|
|
428
|
+
return request;
|
|
421
429
|
};
|
|
422
430
|
}
|
|
423
431
|
const basic = Object.freeze({ ...methods, ...events });
|
|
@@ -433,6 +441,7 @@ var apiMethods = [
|
|
|
433
441
|
"getAppInfoSync",
|
|
434
442
|
"setBadgeCount",
|
|
435
443
|
"navigateTo",
|
|
444
|
+
"redirectTo",
|
|
436
445
|
"navigateBack",
|
|
437
446
|
"navigateBackToRoot",
|
|
438
447
|
"openExternalBrowser",
|
|
@@ -708,6 +717,10 @@ var containerPlugin = {
|
|
|
708
717
|
navigateTo(param) {
|
|
709
718
|
return callAsync("navigateTo", param);
|
|
710
719
|
},
|
|
720
|
+
// 替换由原生一次完成,JS 不拼接打开和关闭操作。
|
|
721
|
+
redirectTo(param) {
|
|
722
|
+
return callAsync("redirectTo", param);
|
|
723
|
+
},
|
|
711
724
|
navigateBack(callbackInfo) {
|
|
712
725
|
return callAsync("navigateBack", callbackInfo);
|
|
713
726
|
},
|
package/dist/mwb.iife.js
CHANGED
|
@@ -224,7 +224,7 @@ SOFTWARE.
|
|
|
224
224
|
var import_dsbridge = __toESM(require_dsbridge(), 1);
|
|
225
225
|
|
|
226
226
|
// src/types.ts
|
|
227
|
-
var version = "0.1.
|
|
227
|
+
var version = "0.1.6";
|
|
228
228
|
|
|
229
229
|
// src/eventHub.ts
|
|
230
230
|
var hubs = /* @__PURE__ */ new WeakMap();
|
|
@@ -410,16 +410,24 @@ SOFTWARE.
|
|
|
410
410
|
const nativeSetTheme = methods.setNavigationBarTheme;
|
|
411
411
|
if (nativeSetTheme) {
|
|
412
412
|
let currentActionClick;
|
|
413
|
+
let themeQueue = Promise.resolve();
|
|
413
414
|
methods.setNavigationBarTheme = async (param) => {
|
|
414
415
|
const { onActionClick, ...nativeParam } = param;
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
currentActionClick = void 0;
|
|
418
|
-
if (nativeParam.actionTxt?.trim() && onActionClick) {
|
|
419
|
-
events.registerHandler("navigationActionClick", onActionClick);
|
|
420
|
-
currentActionClick = onActionClick;
|
|
416
|
+
if (onActionClick !== void 0 && typeof onActionClick !== "function") {
|
|
417
|
+
throw new TypeError("onActionClick must be a function");
|
|
421
418
|
}
|
|
422
|
-
|
|
419
|
+
const request = themeQueue.then(async () => {
|
|
420
|
+
const result = await nativeSetTheme(nativeParam);
|
|
421
|
+
const clearsAction = typeof nativeParam.actionTxt === "string" && !nativeParam.actionTxt.trim();
|
|
422
|
+
if (clearsAction || onActionClick !== void 0) {
|
|
423
|
+
if (currentActionClick) events.unRegisterHandler("navigationActionClick", currentActionClick);
|
|
424
|
+
currentActionClick = clearsAction ? void 0 : onActionClick;
|
|
425
|
+
if (currentActionClick) events.registerHandler("navigationActionClick", currentActionClick);
|
|
426
|
+
}
|
|
427
|
+
return result;
|
|
428
|
+
});
|
|
429
|
+
themeQueue = request.catch(() => void 0);
|
|
430
|
+
return request;
|
|
423
431
|
};
|
|
424
432
|
}
|
|
425
433
|
const basic = Object.freeze({ ...methods, ...events });
|
|
@@ -435,6 +443,7 @@ SOFTWARE.
|
|
|
435
443
|
"getAppInfoSync",
|
|
436
444
|
"setBadgeCount",
|
|
437
445
|
"navigateTo",
|
|
446
|
+
"redirectTo",
|
|
438
447
|
"navigateBack",
|
|
439
448
|
"navigateBackToRoot",
|
|
440
449
|
"openExternalBrowser",
|
|
@@ -702,6 +711,10 @@ SOFTWARE.
|
|
|
702
711
|
navigateTo(param) {
|
|
703
712
|
return callAsync("navigateTo", param);
|
|
704
713
|
},
|
|
714
|
+
// 替换由原生一次完成,JS 不拼接打开和关闭操作。
|
|
715
|
+
redirectTo(param) {
|
|
716
|
+
return callAsync("redirectTo", param);
|
|
717
|
+
},
|
|
705
718
|
navigateBack(callbackInfo) {
|
|
706
719
|
return callAsync("navigateBack", callbackInfo);
|
|
707
720
|
},
|
package/dist/plugins/basic.d.ts
CHANGED
|
@@ -26,6 +26,7 @@ export declare const basicPlugin: {
|
|
|
26
26
|
readonly setEnableDebug: (enabled: boolean) => void;
|
|
27
27
|
readonly toast: (param: import("..").ParamToast) => Promise<import("..").GenericAsyncResult<undefined>>;
|
|
28
28
|
readonly navigateTo: (param: import("..").ParamNavigateTo) => Promise<import("..").GenericAsyncResult<undefined>>;
|
|
29
|
+
readonly redirectTo: (param: import("..").ParamRedirectTo) => Promise<import("..").GenericAsyncResult<undefined>>;
|
|
29
30
|
readonly navigateBack: (callbackInfo: Record<string, any> | undefined) => Promise<import("..").GenericAsyncResult<undefined>>;
|
|
30
31
|
readonly navigateBackToRoot: () => Promise<import("..").GenericAsyncResult<undefined>>;
|
|
31
32
|
readonly openExternalBrowser: (param: import("..").ParamExternalBrowse) => Promise<import("..").GenericAsyncResult<undefined>>;
|
|
@@ -7,6 +7,7 @@ export declare const containerPlugin: {
|
|
|
7
7
|
setEnableDebug(enabled: boolean): void;
|
|
8
8
|
toast(param: import("..").ParamToast): Promise<import("..").GenericAsyncResult<undefined>>;
|
|
9
9
|
navigateTo(param: import("..").ParamNavigateTo): Promise<import("..").GenericAsyncResult<undefined>>;
|
|
10
|
+
redirectTo(param: import("..").ParamRedirectTo): Promise<import("..").GenericAsyncResult<undefined>>;
|
|
10
11
|
navigateBack(callbackInfo: Record<string, any> | undefined): Promise<import("..").GenericAsyncResult<undefined>>;
|
|
11
12
|
navigateBackToRoot(): Promise<import("..").GenericAsyncResult<undefined>>;
|
|
12
13
|
openExternalBrowser(param: import("..").ParamExternalBrowse): Promise<import("..").GenericAsyncResult<undefined>>;
|
package/dist/types.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const version = "0.1.
|
|
1
|
+
export declare const version = "0.1.6";
|
|
2
2
|
type TYPE_VERSION = typeof version;
|
|
3
3
|
export type GenericAsyncResult<T = any> = {
|
|
4
4
|
errCode: number;
|
|
@@ -31,117 +31,82 @@ export type ReturnStorageResult = {
|
|
|
31
31
|
export type ParamStorageClear = {
|
|
32
32
|
groupName?: string;
|
|
33
33
|
};
|
|
34
|
-
|
|
35
|
-
|
|
34
|
+
/** 三个导航方法共享的可选原生外观;打开时在目标容器首帧前应用。 */
|
|
35
|
+
export type NavigationBarAppearanceOptions = {
|
|
36
|
+
/** 6 位十六进制背景色,可带 #。 */
|
|
37
|
+
color?: string;
|
|
38
|
+
/** 未显式设置 buttonColor 时,沿用标题和按钮同色的旧行为。 */
|
|
39
|
+
titleColor?: string;
|
|
40
|
+
/** 显式指定后,后续 titleColor 更新不再影响按钮。 */
|
|
41
|
+
buttonColor?: string;
|
|
42
|
+
/** 仅 iOS(26 起生效):false 隐藏系统按钮背景,true 恢复系统样式;Android 请省略。 */
|
|
43
|
+
buttonBackgroundVisible?: boolean;
|
|
44
|
+
backButtonStyle?: "text" | "arrow" | "arrowText";
|
|
45
|
+
/** 默认“返回”;不能是空白字符串。 */
|
|
46
|
+
backButtonText?: string;
|
|
47
|
+
showBackButton?: boolean;
|
|
48
|
+
separatorVisible?: boolean;
|
|
49
|
+
separatorColor?: string;
|
|
50
|
+
/** 系统缩放前字号,0 < size <= 32;iOS 缩放后上限 32pt。 */
|
|
51
|
+
titleFontSize?: number;
|
|
52
|
+
titleFontWeight?: "regular" | "medium" | "semibold" | "bold";
|
|
53
|
+
/** 系统缩放前字号,0 < size <= 28;iOS 缩放后上限 28pt。 */
|
|
54
|
+
buttonFontSize?: number;
|
|
55
|
+
};
|
|
56
|
+
/** 替换当前原生容器;Android 必须省略 waitForReady,不支持创建新弹窗。 */
|
|
57
|
+
export type ParamRedirectTo = NavigationBarAppearanceOptions & {
|
|
58
|
+
/** 目标地址,沿用容器的可信来源限制。 */
|
|
59
|
+
url: string;
|
|
60
|
+
/** 新容器标题。 */
|
|
61
|
+
title?: string;
|
|
62
|
+
/** 是否隐藏导航栏,默认 true。 */
|
|
63
|
+
hidden?: boolean;
|
|
64
|
+
/** 仅 iOS:等待主文档加载和绘制准备,默认 false;最多 3000ms,失败保留当前页。 */
|
|
36
65
|
waitForReady?: boolean;
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
**/
|
|
66
|
+
};
|
|
67
|
+
export type ParamNavigateTo = NavigationBarAppearanceOptions & {
|
|
40
68
|
url: string;
|
|
41
|
-
/**
|
|
42
|
-
* 是否隐藏导航栏,默认 true
|
|
43
|
-
**/
|
|
69
|
+
/** 默认 true;样式参数不会自动显示导航栏。 */
|
|
44
70
|
hidden?: boolean;
|
|
45
|
-
/**
|
|
46
|
-
* 导航栏标题
|
|
47
|
-
**/
|
|
48
71
|
title?: string;
|
|
49
|
-
/**
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
/**
|
|
54
|
-
* 导航栏颜色 如 eeeeee
|
|
55
|
-
**/
|
|
56
|
-
color?: string;
|
|
57
|
-
/**
|
|
58
|
-
* 是否是亮色主题 控制状态栏
|
|
59
|
-
**/
|
|
72
|
+
/** 仅 iOS,默认 false;Android 必须省略。 */
|
|
73
|
+
waitForReady?: boolean;
|
|
74
|
+
/** 仅 iOS:打开新的原生导航弹窗。 */
|
|
75
|
+
isPopUp?: boolean;
|
|
76
|
+
/** @deprecated 打开方法不支持;由 Android 目标文档通过主题方法设置。 */
|
|
60
77
|
isBright?: boolean;
|
|
61
|
-
/**
|
|
62
|
-
* 是否显示返回按钮
|
|
63
|
-
**/
|
|
64
|
-
showBackButton?: boolean;
|
|
65
|
-
/**
|
|
66
|
-
* 是否显示关闭按钮
|
|
67
|
-
**/
|
|
78
|
+
/** @deprecated 打开方法不支持;由 Android 目标文档通过主题方法设置。 */
|
|
68
79
|
showCloseButton?: boolean;
|
|
69
|
-
/**
|
|
70
|
-
* 右上角文字按钮
|
|
71
|
-
**/
|
|
80
|
+
/** @deprecated 操作与回调由目标文档注册,不能从来源页传入。 */
|
|
72
81
|
actionTxt?: string;
|
|
73
|
-
/**
|
|
74
|
-
* 右上角 icon base64
|
|
75
|
-
**/
|
|
82
|
+
/** @deprecated 原生尚不支持图片按钮。 */
|
|
76
83
|
actionIcon?: string;
|
|
77
|
-
/**
|
|
78
|
-
* 右上角 传参 点击的时候会回传给H5
|
|
79
|
-
**/
|
|
84
|
+
/** @deprecated 操作载荷由目标文档设置。 */
|
|
80
85
|
actionExt?: string;
|
|
81
|
-
/**
|
|
82
|
-
* 状态栏是否沉浸
|
|
83
|
-
**/
|
|
86
|
+
/** @deprecated 原生不支持沉浸状态栏参数。 */
|
|
84
87
|
translucentStatusBars?: boolean;
|
|
85
|
-
/**
|
|
86
|
-
* 打开新页面样式是否弹出
|
|
87
|
-
**/
|
|
88
|
-
isPopUp?: boolean;
|
|
89
|
-
/**
|
|
90
|
-
* 打开的新页面回调给当前页面的回调函数
|
|
91
|
-
**/
|
|
88
|
+
/** @deprecated 原生不支持此回调参数;使用已有返回事件。 */
|
|
92
89
|
callbackFunction?: GenericCallbackFunc | string;
|
|
93
90
|
};
|
|
94
91
|
export type ParamExternalBrowse = {
|
|
95
92
|
url: string;
|
|
96
93
|
};
|
|
97
|
-
export type ParamNavigationBarTheme = {
|
|
98
|
-
/**
|
|
99
|
-
* 是否隐藏导航栏
|
|
100
|
-
**/
|
|
94
|
+
export type ParamNavigationBarTheme = NavigationBarAppearanceOptions & {
|
|
101
95
|
hidden?: boolean;
|
|
102
|
-
/**
|
|
103
|
-
* 导航栏标题
|
|
104
|
-
**/
|
|
105
96
|
title?: string;
|
|
106
|
-
/**
|
|
107
|
-
* 标题文字颜色,如 eeeeee
|
|
108
|
-
**/
|
|
109
|
-
titleColor?: string;
|
|
110
|
-
/**
|
|
111
|
-
* 导航栏颜色 如 eeeeee
|
|
112
|
-
**/
|
|
113
|
-
color?: string;
|
|
114
|
-
/**
|
|
115
|
-
* 是否是亮色主题 控制状态栏
|
|
116
|
-
**/
|
|
97
|
+
/** 仅 Android:状态栏明暗。 */
|
|
117
98
|
isBright?: boolean;
|
|
118
|
-
/**
|
|
119
|
-
* 是否显示返回按钮
|
|
120
|
-
**/
|
|
121
|
-
showBackButton?: boolean;
|
|
122
|
-
/**
|
|
123
|
-
* 是否显示关闭按钮
|
|
124
|
-
**/
|
|
99
|
+
/** 仅 Android:显示关闭按钮。 */
|
|
125
100
|
showCloseButton?: boolean;
|
|
126
|
-
/**
|
|
127
|
-
* 右上角文字按钮
|
|
128
|
-
**/
|
|
129
101
|
actionTxt?: string;
|
|
130
|
-
/**
|
|
131
|
-
* 右上角 icon base64
|
|
132
|
-
**/
|
|
102
|
+
/** 原生尚不支持,传入会拒绝。 */
|
|
133
103
|
actionIcon?: string;
|
|
134
|
-
/**
|
|
135
|
-
* 右上角 传参 点击的时候会回传给H5
|
|
136
|
-
**/
|
|
137
104
|
actionExt?: string;
|
|
138
|
-
/**
|
|
105
|
+
/** 函数仅留在当前文档;局部外观更新保留现有 handler。 */
|
|
139
106
|
onActionClick?: (data: {
|
|
140
107
|
actionExt?: string;
|
|
141
108
|
}) => void;
|
|
142
|
-
/**
|
|
143
|
-
* 状态栏是否沉浸
|
|
144
|
-
**/
|
|
109
|
+
/** 原生尚不支持,传入会拒绝。 */
|
|
145
110
|
translucentStatusBars?: boolean;
|
|
146
111
|
};
|
|
147
112
|
export type ParamPhoneCall = {
|
|
@@ -366,6 +331,8 @@ export interface MWBJSSDK {
|
|
|
366
331
|
* 打开新页面
|
|
367
332
|
**/
|
|
368
333
|
navigateTo(param: ParamNavigateTo): Promise<GenericAsyncResult<undefined>>;
|
|
334
|
+
/** 替换当前容器,返回时跳过被替换页;不要依赖旧页在成功后继续执行 JS。 */
|
|
335
|
+
redirectTo(param: ParamRedirectTo): Promise<GenericAsyncResult<undefined>>;
|
|
369
336
|
/**
|
|
370
337
|
* 返回上一级
|
|
371
338
|
*
|