diff --git a/zh-cn/application-dev/reference/apis/js-apis-animator.md b/zh-cn/application-dev/reference/apis/js-apis-animator.md index 6233ea127e29015e9c482330209b52f9d28dc60a..e8a8435dbd92e42cca063f40451e8152fceb147d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-animator.md +++ b/zh-cn/application-dev/reference/apis/js-apis-animator.md @@ -72,7 +72,7 @@ reset(options: AnimatorOptions): void | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | +| 100001 | If no page is found for pageId or fail to get object property list. | **示例:** diff --git a/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md b/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md index a177974721b93ab4059a671bdeebd63c1be9073a..87a4d535a096cffa3a6ee3d2dc5c51eefe61dc62 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md +++ b/zh-cn/application-dev/reference/apis/js-apis-mediaquery.md @@ -49,10 +49,10 @@ let listener = mediaquery.matchMediaSync('(orientation: landscape)'); //监听 ### 属性 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| ------- | ------- | ---- | ---- | ---------- | -| matches | boolean | 是 | 否 | 是否符合匹配条件。 | -| media | string | 是 | 否 | 媒体事件的匹配条件。 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------- | ------- | ---- | ---- | -------------------- | +| matches | boolean | 是 | 否 | 是否符合匹配条件。 | +| media | string | 是 | 否 | 媒体事件的匹配条件。 | ### on @@ -85,10 +85,10 @@ off(type: 'change', callback?: Callback<MediaQueryResult>): void **参数:** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------------- | ---- | ----------------------------- | -| type | boolean | 是 | 必须填写字符串'change'。 | -| callback | Callback<MediaQueryResult> | 否 | 需要去注册的回调,如果参数缺省则去注册该句柄下所有的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------- | ---- | ---------------------------------------------------------- | +| type | string | 是 | 必须填写字符串'change'。 | +| callback | Callback<MediaQueryResult> | 否 | 需要去注册的回调,如果参数缺省则去注册该句柄下所有的回调。 | **示例:** @@ -107,16 +107,19 @@ off(type: 'change', callback?: Callback<MediaQueryResult>): void listener.off('change', onPortrait) // 去注册回调 ``` - ## MediaQueryResult +用于执行媒体查询操作。 + +**系统能力:** SystemCapability.ArkUI.ArkUI.Full + ### 属性 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| ------- | ------- | ---- | ---- | ---------- | -| matches | boolean | 是 | 否 | 是否符合匹配条件。 | -| media | string | 是 | 否 | 媒体事件的匹配条件。 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------- | ------- | ---- | ---- | -------------------- | +| matches | boolean | 是 | 否 | 是否符合匹配条件。 | +| media | string | 是 | 否 | 媒体事件的匹配条件。 | ### 示例 @@ -143,7 +146,7 @@ struct MediaQueryExample { } aboutToAppear() { - let portraitFunc = this.onPortrait.bind(this) //bind current js instance + let portraitFunc = this.onPortrait.bind(this) // bind current js instance this.listener.on('change', portraitFunc) } diff --git a/zh-cn/application-dev/reference/apis/js-apis-prompt.md b/zh-cn/application-dev/reference/apis/js-apis-prompt.md index 34a7b312a997f8281a8a9098ef8f738781ae2060..874aa017866684f15710da2d5642b818c6721316 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-prompt.md +++ b/zh-cn/application-dev/reference/apis/js-apis-prompt.md @@ -145,11 +145,11 @@ prompt.showDialog({ **系统能力:** SystemCapability.ArkUI.ArkUI.Full -| 名称 | 类型 | 必填 | 说明 | -| ------- | ---------------------------------------- | ---- | ---------------------------------------- | -| title | string\| [Resource](../arkui-ts/ts-types.md#resource)9+ | 否 | 标题文本。 | -| message | string\| [Resource](../arkui-ts/ts-types.md#resource)9+ | 否 | 内容文本。 | -| buttons | Array | 否 | 对话框中按钮的数组,结构为:{text:'button', color: '\#666666'},支持1-3个按钮。其中第一个为positiveButton;第二个为negativeButton;第三个为neutralButton。 | +| 名称 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| title | string\| [Resource](../arkui-ts/ts-types.md#resource)9+ | 否 | 标题文本。 | +| message | string\| [Resource](../arkui-ts/ts-types.md#resource)9+ | 否 | 内容文本。 | +| buttons | [[Button](#button),[Button](#button)?,[Button](#button)?] | 否 | 对话框中按钮的数组,结构为:{text:'button', color: '\#666666'},支持1-3个按钮。其中第一个为positiveButton;第二个为negativeButton;第三个为neutralButton。 | ## ShowDialogSuccessResponse @@ -157,9 +157,9 @@ prompt.showDialog({ **系统能力:** SystemCapability.ArkUI.ArkUI.Full -| 名称 | 类型 | 说明 | -| ----- | ------ | ------------------- | -| index | number | 选中按钮在buttons数组中的索引。 | +| 名称 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ------------------------------- | +| index | number | 否 | 选中按钮在buttons数组中的索引。 | ## prompt.showActionMenu @@ -254,10 +254,10 @@ prompt.showActionMenu({ **系统能力:** SystemCapability.ArkUI.ArkUI.Full。 -| 名称 | 类型 | 必填 | 说明 | -| ------- | ---------------------------------------- | ---- | ---------------------------------------- | -| title | string\| [Resource](../arkui-ts/ts-types.md#resource)9+ | 否 | 标题文本。 | -| buttons | Array<[Button](#button)> | 是 | 菜单中菜单项按钮的数组,结构为:{text:'button', color: '\#666666'},支持1-6个按钮。大于6个按钮时弹窗不显示。 | +| 名称 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| title | string\| [Resource](../arkui-ts/ts-types.md#resource)9+ | 否 | 标题文本。 | +| buttons | [[Button](#button),[Button](#button)?,[Button](#button)?,[Button](#button)?,[Button](#button)?,[Button](#button)?] | 是 | 菜单中菜单项按钮的数组,结构为:{text:'button', color: '\#666666'},支持1-6个按钮。大于6个按钮时弹窗不显示。 | ## ActionMenuSuccessResponse diff --git a/zh-cn/application-dev/reference/apis/js-apis-promptAction.md b/zh-cn/application-dev/reference/apis/js-apis-promptAction.md index 6b274b6c8c03afbd53e3d471645acd53759f3227..f81fc132f5628c7013cd4c1439f48b07f4dfea7e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-promptAction.md +++ b/zh-cn/application-dev/reference/apis/js-apis-promptAction.md @@ -32,7 +32,7 @@ showToast(options: ShowToastOptions): void | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | +| 100001 | If UI execution context not found. | **示例:** @@ -88,7 +88,7 @@ showDialog(options: ShowDialogOptions): Promise<ShowDialogSuccessResponse> | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | +| 100001 | If UI execution context not found. | **示例:** @@ -142,7 +142,7 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback<ShowDialogSucc | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | +| 100001 | If UI execution context not found. | **示例:** @@ -181,11 +181,11 @@ try { **系统能力:** SystemCapability.ArkUI.ArkUI.Full -| 名称 | 类型 | 必填 | 说明 | -| ------- | ---------------------------------------- | ---- | ---------------------------------------- | -| title | string\| [Resource](../arkui-ts/ts-types.md#resource类型)9+ | 否 | 标题文本。 | -| message | string\| [Resource](../arkui-ts/ts-types.md#resource类型)9+ | 否 | 内容文本。 | -| buttons | Array | 否 | 对话框中按钮的数组,结构为:{text:'button', color: '\#666666'},支持1-3个按钮。其中第一个为positiveButton;第二个为negativeButton;第三个为neutralButton。 | +| 名称 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| title | string\| [Resource](../arkui-ts/ts-types.md#resource类型)9+ | 否 | 标题文本。 | +| message | string\| [Resource](../arkui-ts/ts-types.md#resource类型)9+ | 否 | 内容文本。 | +| buttons | [[Button](#button),[Button](#button)?,[Button](#button)?] | 否 | 对话框中按钮的数组,结构为:{text:'button', color: '\#666666'},支持1-3个按钮。其中第一个为positiveButton;第二个为negativeButton;第三个为neutralButton。 | ## ShowDialogSuccessResponse @@ -193,9 +193,9 @@ try { **系统能力:** SystemCapability.ArkUI.ArkUI.Full -| 名称 | 类型 | 说明 | -| ----- | ------ | ------------------- | -| index | number | 选中按钮在buttons数组中的索引。 | +| 名称 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ------------------------------- | +| index | number | 否 | 选中按钮在buttons数组中的索引。 | ## promptAction.showActionMenu @@ -218,7 +218,7 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback<ActionMenu | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | +| 100001 | If UI execution context not found. | **示例:** @@ -276,7 +276,7 @@ showActionMenu(options: ActionMenuOptions): Promise<ActionMenuSuccessResponse | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | +| 100001 | If UI execution context not found. | **示例:** @@ -314,10 +314,10 @@ try { **系统能力:** SystemCapability.ArkUI.ArkUI.Full。 -| 名称 | 类型 | 必填 | 说明 | -| ------- | ---------------------------------------- | ---- | ---------------------------------------- | -| title | string\| [Resource](../arkui-ts/ts-types.md#resource类型)9+ | 否 | 标题文本。 | -| buttons | Array<[Button](#button)> | 是 | 菜单中菜单项按钮的数组,结构为:{text:'button', color: '\#666666'},支持1-6个按钮。大于6个按钮时弹窗不显示。 | +| 名称 | 类型 | 必填 | 说明 | +| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| title | string\| [Resource](../arkui-ts/ts-types.md#resource类型)9+ | 否 | 标题文本。 | +| buttons | [[Button](#button),[Button](#button)?,[Button](#button)?,[Button](#button)?,[Button](#button)?,[Button](#button)?] | 是 | 菜单中菜单项按钮的数组,结构为:{text:'button', color: '\#666666'},支持1-6个按钮。大于6个按钮时弹窗不显示。 | ## ActionMenuSuccessResponse diff --git a/zh-cn/application-dev/reference/apis/js-apis-router.md b/zh-cn/application-dev/reference/apis/js-apis-router.md index 20e6d1f7881226ebb0307709c42c2dc489f9c9d4..0912e0c5a53aedd46a6397029b3521c214217cb7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-router.md +++ b/zh-cn/application-dev/reference/apis/js-apis-router.md @@ -40,9 +40,9 @@ pushUrl(options: RouterOptions): Promise<void> | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | -| 100002 | Uri error. The uri of router is not exist. | -| 100003 | Page stack error. The pages are pushed too much. | +| 100001 | If UI execution context not found. | +| 100002 | If the uri is not exist. | +| 100003 | If the pages are pushed too much. | **示例:** @@ -89,9 +89,9 @@ pushUrl(options: RouterOptions, callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | -| 100002 | Uri error. The uri of router is not exist. | -| 100003 | Page stack error. The pages are pushed too much. | +| 100001 | If UI execution context not found. | +| 100002 | If the uri is not exist. | +| 100003 | If the pages are pushed too much. | **示例:** @@ -143,9 +143,9 @@ pushUrl(options: RouterOptions, mode: RouterMode): Promise<void> | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | -| 100002 | Uri error. The uri of router is not exist. | -| 100003 | Page stack error. The pages are pushed too much. | +| 100001 | If UI execution context not found. | +| 100002 | If the uri is not exist. | +| 100003 | If the pages are pushed too much. | **示例:** @@ -193,9 +193,9 @@ pushUrl(options: RouterOptions, mode: RouterMode, callback: AsyncCallback<voi | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | -| 100002 | Uri error. The uri of router is not exist. | -| 100003 | Page stack error. The pages are pushed too much. | +| 100001 | If UI execution context not found. | +| 100002 | If the uri is not exist. | +| 100003 | If the pages are pushed too much. | **示例:** @@ -247,8 +247,8 @@ replaceUrl(options: RouterOptions): Promise<void> | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | -| 200002 | Uri error. The uri of router is not exist. | +| 100001 | If UI execution context not found, only throw in standard system. | +| 200002 | If the uri is not exist. | **示例:** @@ -292,8 +292,8 @@ replaceUrl(options: RouterOptions, callback: AsyncCallback<void>): void | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | -| 200002 | Uri error. The uri of router is not exist. | +| 100001 | If UI execution context not found, only throw in standard system. | +| 200002 | If the uri is not exist. | **示例:** @@ -344,8 +344,8 @@ replaceUrl(options: RouterOptions, mode: RouterMode): Promise<void> | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | -| 200002 | Uri error. The uri of router is not exist. | +| 100001 | If UI execution context not found, only throw in standard system. | +| 200002 | If the uri is not exist. | **示例:** @@ -390,8 +390,8 @@ replaceUrl(options: RouterOptions, mode: RouterMode, callback: AsyncCallback< | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | -| 200002 | Uri error. The uri of router is not exist. | +| 100001 | If UI execution context not found, only throw in standard system. | +| 200002 | If the uri is not exist. | **示例:** @@ -498,11 +498,11 @@ console.log('current path = ' + page.path); **系统能力:** SystemCapability.ArkUI.ArkUI.Full。 -| 名称 | 类型 | 说明 | -| ----- | ------ | ---------------------------------- | -| index | number | 表示当前页面在页面栈中的索引。从栈底到栈顶,index从1开始递增。 | -| name | string | 表示当前页面的名称,即对应文件名。 | -| path | string | 表示当前页面的路径。 | +| 名称 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ------------------------------------------------------------ | +| index | number | 是 | 表示当前页面在页面栈中的索引。从栈底到栈顶,index从1开始递增。 | +| name | string | 否 | 表示当前页面的名称,即对应文件名。 | +| path | string | 是 | 表示当前页面的路径。 | ## router.enableBackPageAlert9+ @@ -524,7 +524,7 @@ enableBackPageAlert(options: EnableAlertOptions): void | 错误码ID | 错误信息 | | --------- | ------- | -| 100001 | Internal error. | +| 100001 | If UI execution context not found. | **示例:** @@ -602,9 +602,9 @@ router.getParams(); **系统能力:** SystemCapability.ArkUI.ArkUI.Full。 -| 名称 | 描述 | -| -------- | ---------------------------------------- | -| Standard | 标准模式。
目标页面会被添加到页面路由栈顶,无论栈中是否存在相同url的页面。 | +| 名称 | 说明 | +| -------- | ------------------------------------------------------------ | +| Standard | 标准模式。
目标页面会被添加到页面路由栈顶,无论栈中是否存在相同url的页面。 | | Single | 单实例模式。
如果目标页面的url在页面栈中已经存在同url页面,离栈顶最近的页面会被移动到栈顶,移动后的页面为新建页。
如目标页面的url在页面栈中不存在同url页面,按标准模式跳转。 | ## 完整示例 @@ -812,7 +812,7 @@ replace(options: RouterOptions, mode: RouterMode): void 从API version9开始不再维护,建议使用[replaceUrl9+](#routerreplaceurl9) -**系统能力:** SystemCapability.ArkUI.ArkUI.Full +**系统能力:** SystemCapability.ArkUI.ArkUI.Lite **参数:**