提交 3314356d 编写于 作者: G gmy

update docs

Signed-off-by: Ngmy <guanmingyue@h-partners.com>
上级 b6425a38
...@@ -24,13 +24,13 @@ push(options: RouterOptions): void ...@@ -24,13 +24,13 @@ push(options: RouterOptions): void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| options | [RouterOptions](#routeroptions) | 是 | 跳转页面描述信息。 | | options | [RouterOptions](#routeroptions) | 是 | 跳转页面描述信息。 |
**示例:** **示例:**
``` ```js
// 在当前页面中 // 在当前页面中
export default { export default {
pushPage() { pushPage() {
...@@ -46,7 +46,7 @@ push(options: RouterOptions): void ...@@ -46,7 +46,7 @@ push(options: RouterOptions): void
} }
} }
``` ```
``` ```js
// 在routerpage2页面中 // 在routerpage2页面中
export default { export default {
data: { data: {
...@@ -72,12 +72,13 @@ replace(options: RouterOptions): void ...@@ -72,12 +72,13 @@ replace(options: RouterOptions): void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| options | [RouterOptions](#routeroptions) | 是 | 替换页面描述信息。 | | options | [RouterOptions](#routeroptions) | 是 | 替换页面描述信息。 |
**示例:** **示例:**
```
```js
// 在当前页面中 // 在当前页面中
export default { export default {
replacePage() { replacePage() {
...@@ -91,7 +92,7 @@ replace(options: RouterOptions): void ...@@ -91,7 +92,7 @@ replace(options: RouterOptions): void
} }
``` ```
``` ```js
// 在detail页面中 // 在detail页面中
export default { export default {
data: { data: {
...@@ -112,12 +113,12 @@ back(options?: RouterOptions ): void ...@@ -112,12 +113,12 @@ back(options?: RouterOptions ): void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| options | [RouterOptions](#routeroptions) | 是 | 返回页面描述信息,其中参数url指路由跳转时会返回到指定url的界面,如果页面栈上没有url页面,则不响应该情况。如果url未设置,则返回上一页。 | | options | [RouterOptions](#routeroptions) | 是 | 返回页面描述信息,其中参数url指路由跳转时会返回到指定url的界面,如果页面栈上没有url页面,则不响应该情况。如果url未设置,则返回上一页。 |
**示例:** **示例:**
``` ```js
// index页面 // index页面
export default { export default {
indexPushPage() { indexPushPage() {
...@@ -128,7 +129,7 @@ back(options?: RouterOptions ): void ...@@ -128,7 +129,7 @@ back(options?: RouterOptions ): void
} }
``` ```
``` ```js
// detail页面 // detail页面
export default { export default {
detailPushPage() { detailPushPage() {
...@@ -139,7 +140,7 @@ back(options?: RouterOptions ): void ...@@ -139,7 +140,7 @@ back(options?: RouterOptions ): void
} }
``` ```
``` ```js
// mall页面通过back,将返回detail页面 // mall页面通过back,将返回detail页面
export default { export default {
mallBackPage() { mallBackPage() {
...@@ -148,7 +149,7 @@ back(options?: RouterOptions ): void ...@@ -148,7 +149,7 @@ back(options?: RouterOptions ): void
} }
``` ```
``` ```js
// detail页面通过back,将返回index页面 // detail页面通过back,将返回index页面
export default { export default {
defaultBack() { defaultBack() {
...@@ -157,7 +158,7 @@ back(options?: RouterOptions ): void ...@@ -157,7 +158,7 @@ back(options?: RouterOptions ): void
} }
``` ```
``` ```js
// 通过back,返回到detail页面 // 通过back,返回到detail页面
export default { export default {
backToDetail() { backToDetail() {
...@@ -175,12 +176,12 @@ clear(): void ...@@ -175,12 +176,12 @@ clear(): void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**示例:** **示例:**
``` ```js
export default { export default {
clearPage() { clearPage() {
router.clear(); router.clear();
} }
} }js
``` ```
## router.getLength ## router.getLength
...@@ -190,12 +191,12 @@ getLength(): string ...@@ -190,12 +191,12 @@ getLength(): string
获取当前在页面栈内的页面数量。 获取当前在页面栈内的页面数量。
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| string | 页面数量,页面栈支持最大数值是32。 | | string | 页面数量,页面栈支持最大数值是32。 |
**示例:** **示例:**
``` ```js
export default { export default {
getLength() { getLength() {
var size = router.getLength(); var size = router.getLength();
...@@ -222,14 +223,14 @@ getState(): RouterState ...@@ -222,14 +223,14 @@ getState(): RouterState
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| index | number | 表示当前页面在页面栈中的索引。<br/>>&nbsp;![icon-note.gif](public_sys-resources/icon-note.gif)&nbsp;**说明:**<br/>>&nbsp;从栈底到栈顶,index从1开始递增。 | | index | number | 表示当前页面在页面栈中的索引。<br/>>&nbsp;![icon-note.gif](public_sys-resources/icon-note.gif)&nbsp;**说明:**<br/>>&nbsp;从栈底到栈顶,index从1开始递增。 |
| name | string | 表示当前页面的名称,即对应文件名。 | | name | string | 表示当前页面的名称,即对应文件名。 |
| path | string | 表示当前页面的路径。 | | path | string | 表示当前页面的路径。 |
**示例:** **示例:**
``` ```js
export default { export default {
getState() { getState() {
var page = router.getState(); var page = router.getState();
...@@ -249,13 +250,13 @@ enableAlertBeforeBackPage(options: EnableAlertOptions): void ...@@ -249,13 +250,13 @@ enableAlertBeforeBackPage(options: EnableAlertOptions): void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| options | [EnableAlertOptions](#enablealertoptions) | 是 | 文本弹窗信息描述。 | | options | [EnableAlertOptions](#enablealertoptions) | 是 | 文本弹窗信息描述。 |
**示例:** **示例:**
``` ```js
export default { export default {
enableAlertBeforeBackPage() { enableAlertBeforeBackPage() {
router.enableAlertBeforeBackPage({ router.enableAlertBeforeBackPage({
...@@ -289,7 +290,7 @@ disableAlertBeforeBackPage(): void ...@@ -289,7 +290,7 @@ disableAlertBeforeBackPage(): void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**示例:** **示例:**
``` ```js
export default { export default {
disableAlertBeforeBackPage() { disableAlertBeforeBackPage() {
router.disableAlertBeforeBackPage(); router.disableAlertBeforeBackPage();
...@@ -314,7 +315,7 @@ getParams(): Object ...@@ -314,7 +315,7 @@ getParams(): Object
**示例:** **示例:**
- 类Web范示例 - 类Web范示例
``` ```js
// 在当前页面中 // 在当前页面中
export default { export default {
pushPage() { pushPage() {
...@@ -327,7 +328,7 @@ getParams(): Object ...@@ -327,7 +328,7 @@ getParams(): Object
} }
} }
``` ```
``` ```js
// 在detail页面中 // 在detail页面中
export default { export default {
onInit() { onInit() {
...@@ -338,7 +339,7 @@ getParams(): Object ...@@ -338,7 +339,7 @@ getParams(): Object
- 声明式示例 - 声明式示例
``` ```ts
//通过router.push跳转至目标页携带params参数 //通过router.push跳转至目标页携带params参数
import router from '@ohos.router' import router from '@ohos.router'
...@@ -384,7 +385,7 @@ getParams(): Object ...@@ -384,7 +385,7 @@ getParams(): Object
} }
``` ```
``` ```ts
//在second页面中接收传递过来的参数 //在second页面中接收传递过来的参数
import router from '@ohos.router' import router from '@ohos.router'
...@@ -392,8 +393,8 @@ getParams(): Object ...@@ -392,8 +393,8 @@ getParams(): Object
@Component @Component
struct Second { struct Second {
private content: string = "这是第二页" private content: string = "这是第二页"
@State text: string = router.getParams().text @State text: string = router.getParams()['text']
@State data: any = router.getParams().data @State data: any = router.getParams()['data']
@State secondData : string = '' @State secondData : string = ''
build() { build() {
......
...@@ -138,7 +138,8 @@ setImageRawDataCacheSize(value: number): void ...@@ -138,7 +138,8 @@ setImageRawDataCacheSize(value: number): void
export default { export default {
onCreate() { onCreate() {
app.setImageRawDataCacheSize(100) // 设置解码前图片数据内存缓存上限为100MB app.setImageRawDataCacheSize(104857600)
// 设置解码前图片数据内存缓存上限为100MB (100MB=100*1024*1024B=104857600B)
console.info('Application onCreate') console.info('Application onCreate')
}, },
onDestroy() { onDestroy() {
...@@ -168,7 +169,8 @@ setImageFileCacheSize(value: number): void ...@@ -168,7 +169,8 @@ setImageFileCacheSize(value: number): void
export default { export default {
onCreate() { onCreate() {
app.setImageFileCacheSize(200) // 设置图片文件数据缓存上限为200MB app.setImageFileCacheSize(209715200)
// 设置图片文件数据缓存上限为200MB (200MB=200*1024*1024B=209715200B)
console.info('Application onCreate') console.info('Application onCreate')
}, },
onDestroy() { onDestroy() {
......
...@@ -33,29 +33,29 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F ...@@ -33,29 +33,29 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F
| alignContent | FlexAlign | 否 | FlexAlign.Start | 交叉轴中有额外的空间时,多行内容的对齐方式。仅在wrap为Wrap或WrapReverse下生效。 | | alignContent | FlexAlign | 否 | FlexAlign.Start | 交叉轴中有额外的空间时,多行内容的对齐方式。仅在wrap为Wrap或WrapReverse下生效。 |
- FlexDirection枚举说明 - FlexDirection枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| Row | 主轴与行方向一致作为布局模式。 | | Row | 主轴与行方向一致作为布局模式。 |
| RowReverse | 与Row方向相反方向进行布局。 | | RowReverse | 与Row方向相反方向进行布局。 |
| Column | 主轴与列方向一致作为布局模式。 | | Column | 主轴与列方向一致作为布局模式。 |
| ColumnReverse | 与Column相反方向进行布局。 | | ColumnReverse | 与Column相反方向进行布局。 |
- FlexWrap枚举说明 - FlexWrap枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| NoWrap | Flex容器的元素单行/列布局,子项允许超出容器。 | | NoWrap | Flex容器的元素单行/列布局,子项允许超出容器。 |
| Wrap | Flex容器的元素多行/列排布,子项允许超出容器。 | | Wrap | Flex容器的元素多行/列排布,子项允许超出容器。 |
| WrapReverse | Flex容器的元素反向多行/列排布,子项允许超出容器。 | | WrapReverse | Flex容器的元素反向多行/列排布,子项允许超出容器。 |
- FlexAlign枚举说明 - FlexAlign枚举说明
| 名称 | 描述 | | 名称 | 描述 |
| -------- | -------- | | -------- | -------- |
| Start | 元素在主轴方向首端对齐,&nbsp;第一个元素与行首对齐,同时后续的元素与前一个对齐。 | | Start | 元素在主轴方向首端对齐,&nbsp;第一个元素与行首对齐,同时后续的元素与前一个对齐。 |
| Center | 元素在主轴方向中心对齐,第一个元素与行首的距离与最后一个元素与行尾距离相同。 | | Center | 元素在主轴方向中心对齐,第一个元素与行首的距离与最后一个元素与行尾距离相同。 |
| End | 元素在主轴方向尾部对齐,&nbsp;&nbsp;最后一个元素与行尾对齐,其他元素与后一个对齐。 | | End | 元素在主轴方向尾部对齐,&nbsp;&nbsp;最后一个元素与行尾对齐,其他元素与后一个对齐。 |
| SpaceBetween | Flex主轴方向均匀分配弹性元素,相邻元素之间距离相同。&nbsp;第一个元素与行首对齐,最后一个元素与行尾对齐。 | | SpaceBetween | Flex主轴方向均匀分配弹性元素,相邻元素之间距离相同。&nbsp;第一个元素与行首对齐,最后一个元素与行尾对齐。 |
| SpaceAround | Flex主轴方向均匀分配弹性元素,相邻元素之间距离相同。&nbsp;第一个元素到行首的距离和最后一个元素到行尾的距离时相邻元素之间距离的一半。 | | SpaceAround | Flex主轴方向均匀分配弹性元素,相邻元素之间距离相同。&nbsp;第一个元素到行首的距离和最后一个元素到行尾的距离是相邻元素之间距离的一半。 |
| SpaceEvenly | Flex主轴方向元素等间距布局,&nbsp;相邻元素之间的间距、第一个元素与行首的间距、最后一个元素到行尾的间距都完全一样。 | | SpaceEvenly | Flex主轴方向元素等间距布局,&nbsp;相邻元素之间的间距、第一个元素与行首的间距、最后一个元素到行尾的间距都完全一样。 |
## 示例 ## 示例
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册