提交 d84a4a98 编写于 作者: H HelloCrease

update docs

Signed-off-by: NHelloCrease <lian15@huawei.com>
上级 ed7a8b64
...@@ -24,7 +24,7 @@ push(options: RouterOptions): void ...@@ -24,7 +24,7 @@ push(options: RouterOptions): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ------------------ | | ------- | ------------------------------- | ---- | --------- |
| options | [RouterOptions](#routeroptions) | 是 | 跳转页面描述信息。 | | options | [RouterOptions](#routeroptions) | 是 | 跳转页面描述信息。 |
...@@ -50,9 +50,9 @@ push(options: RouterOptions, mode: RouterMode): void ...@@ -50,9 +50,9 @@ push(options: RouterOptions, mode: RouterMode): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------- | ---- | -------------------- | | ------- | ------------------------------- | ---- | ---------- |
| options | [RouterOptions](#routeroptions) | 是 | 跳转页面描述信息。 | | options | [RouterOptions](#routeroptions) | 是 | 跳转页面描述信息。 |
| mode<sup>9+</sup> | [RouterMode](#routermode9) | 是 | 跳转页面使用的模式。 | | mode | [RouterMode](#routermode9) | 是 | 跳转页面使用的模式。 |
**示例:** **示例:**
...@@ -78,7 +78,7 @@ replace(options: RouterOptions): void ...@@ -78,7 +78,7 @@ replace(options: RouterOptions): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ------------------ | | ------- | ------------------------------- | ---- | --------- |
| options | [RouterOptions](#routeroptions) | 是 | 替换页面描述信息。 | | options | [RouterOptions](#routeroptions) | 是 | 替换页面描述信息。 |
**示例:** **示例:**
...@@ -102,9 +102,9 @@ replace(options: RouterOptions, mode: RouterMode): void ...@@ -102,9 +102,9 @@ replace(options: RouterOptions, mode: RouterMode): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------- | ---- | -------------------- | | ------- | ------------------------------- | ---- | ---------- |
| options | [RouterOptions](#routeroptions) | 是 | 替换页面描述信息。 | | options | [RouterOptions](#routeroptions) | 是 | 替换页面描述信息。 |
| mode<sup>9+</sup> | [RouterMode](#routermode9) | 是 | 跳转页面使用的模式。 | | mode | [RouterMode](#routermode9) | 是 | 跳转页面使用的模式。 |
**示例:** **示例:**
...@@ -127,7 +127,7 @@ back(options?: RouterOptions ): void ...@@ -127,7 +127,7 @@ back(options?: RouterOptions ): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ------------------------------------------------------------ | | ------- | ------------------------------- | ---- | ---------------------------------------- |
| options | [RouterOptions](#routeroptions) | 否 | 返回页面描述信息,其中参数url指路由跳转时会返回到指定url的界面,如果页面栈上没有url页面,则不响应该情况。如果url未设置,则返回上一页。 | | options | [RouterOptions](#routeroptions) | 否 | 返回页面描述信息,其中参数url指路由跳转时会返回到指定url的界面,如果页面栈上没有url页面,则不响应该情况。如果url未设置,则返回上一页。 |
**示例:** **示例:**
...@@ -160,7 +160,7 @@ getLength(): string ...@@ -160,7 +160,7 @@ getLength(): string
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ---------------------------------- | | ------ | ------------------ |
| string | 页面数量,页面栈支持最大数值是32。 | | string | 页面数量,页面栈支持最大数值是32。 |
**示例:** **示例:**
...@@ -180,7 +180,7 @@ getState(): RouterState ...@@ -180,7 +180,7 @@ getState(): RouterState
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------- | -------------- | | --------------------------- | ------- |
| [RouterState](#routerstate) | 页面状态信息。 | | [RouterState](#routerstate) | 页面状态信息。 |
**示例:** **示例:**
...@@ -198,7 +198,7 @@ console.log('current path = ' + page.path); ...@@ -198,7 +198,7 @@ console.log('current path = ' + page.path);
**系统能力:** SystemCapability.ArkUI.ArkUI.Full。 **系统能力:** SystemCapability.ArkUI.ArkUI.Full。
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| ----- | ------ | ------------------------------------------------------------ | | ----- | ------ | ---------------------------------- |
| index | number | 表示当前页面在页面栈中的索引。从栈底到栈顶,index从1开始递增。 | | index | number | 表示当前页面在页面栈中的索引。从栈底到栈顶,index从1开始递增。 |
| name | string | 表示当前页面的名称,即对应文件名。 | | name | string | 表示当前页面的名称,即对应文件名。 |
| path | string | 表示当前页面的路径。 | | path | string | 表示当前页面的路径。 |
...@@ -213,7 +213,7 @@ enableAlertBeforeBackPage(options: EnableAlertOptions): void ...@@ -213,7 +213,7 @@ enableAlertBeforeBackPage(options: EnableAlertOptions): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------------- | ---- | ------------------ | | ------- | ---------------------------------------- | ---- | --------- |
| options | [EnableAlertOptions](#enablealertoptions) | 是 | 文本弹窗信息描述。 | | options | [EnableAlertOptions](#enablealertoptions) | 是 | 文本弹窗信息描述。 |
**示例:** **示例:**
...@@ -230,7 +230,7 @@ enableAlertBeforeBackPage(options: EnableAlertOptions): void ...@@ -230,7 +230,7 @@ enableAlertBeforeBackPage(options: EnableAlertOptions): void
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------------- | | ------- | ------ | ---- | -------- |
| message | string | 是 | 询问对话框内容。 | | message | string | 是 | 询问对话框内容。 |
## router.disableAlertBeforeBackPage ## router.disableAlertBeforeBackPage
...@@ -257,7 +257,7 @@ getParams(): Object ...@@ -257,7 +257,7 @@ getParams(): Object
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ---------------------------------- | | ------ | ----------------- |
| Object | 发起跳转的页面往当前页传入的参数。 | | Object | 发起跳转的页面往当前页传入的参数。 |
**示例:** **示例:**
...@@ -273,7 +273,7 @@ router.getParams(); ...@@ -273,7 +273,7 @@ router.getParams();
**系统能力:** SystemCapability.ArkUI.ArkUI.Lite。 **系统能力:** SystemCapability.ArkUI.ArkUI.Lite。
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ---------------------------------------- |
| url | string | 是 | 表示目标页面的uri,可以用以下两种格式:<br/>-&nbsp;页面绝对路径,由配置文件中pages列表提供,例如:<br/>&nbsp;&nbsp;-&nbsp;pages/index/index<br/>&nbsp;&nbsp;-&nbsp;pages/detail/detail<br/>-&nbsp;特殊值,如果uri的值是"/",则跳转到首页。 | | url | string | 是 | 表示目标页面的uri,可以用以下两种格式:<br/>-&nbsp;页面绝对路径,由配置文件中pages列表提供,例如:<br/>&nbsp;&nbsp;-&nbsp;pages/index/index<br/>&nbsp;&nbsp;-&nbsp;pages/detail/detail<br/>-&nbsp;特殊值,如果uri的值是"/",则跳转到首页。 |
| params | Object | 否 | 跳转时要同时传递到目标页面的数据,跳转到目标页面后,参数可以在页面中直接使用,如this.data1(data1为跳转时params参数中的key值)。如果目标页面中已有该字段,则其值会被传入的字段值覆盖。 | | params | Object | 否 | 跳转时要同时传递到目标页面的数据,跳转到目标页面后,参数可以在页面中直接使用,如this.data1(data1为跳转时params参数中的key值)。如果目标页面中已有该字段,则其值会被传入的字段值覆盖。 |
...@@ -288,7 +288,7 @@ router.getParams(); ...@@ -288,7 +288,7 @@ router.getParams();
**系统能力:** SystemCapability.ArkUI.ArkUI.Full。 **系统能力:** SystemCapability.ArkUI.ArkUI.Full。
| 名称 | 描述 | | 名称 | 描述 |
| -------- | ------------------------------------------------------------ | | -------- | ---------------------------------------- |
| Standard | 标准模式。 | | Standard | 标准模式。 |
| Single | 单实例模式。<br/>如果目标页面的url在页面栈中已经存在同url页面,离栈顶最近的页面会被移动到栈顶,移动后的页面为新建页。<br/>如目标页面的url在页面栈中不存在同url页面,按标准模式跳转。 | | Single | 单实例模式。<br/>如果目标页面的url在页面栈中已经存在同url页面,离栈顶最近的页面会被移动到栈顶,移动后的页面为新建页。<br/>如目标页面的url在页面栈中不存在同url页面,按标准模式跳转。 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册