ts-container-navigator.md

# Navigator

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。


路由容器组件，提供路由跳转能力。


## 权限列表

无


## 子组件

可以包含子组件。


## 接口

Navigator(value?: {target: string, type?: NavigationType})

创建路由组件。

- 参数
  | 参数名    | 参数类型           | 必填   | 默认值                 | 参数描述         |
  | ------ | -------------- | ---- | ------------------- | ------------ |
  | target | string         | 是    | -                   | 指定跳转目标页面的路径。 |
  | type   | NavigationType | 否    | NavigationType.Push | 指定路由方式。      |

- NavigationType枚举说明
  | 名称      | 描述                         |
  | ------- | -------------------------- |
  | Push    | 跳转到应用内的指定页面。               |
  | Replace | 用应用内的某个页面替换当前页面，并销毁被替换的页面。 |
  | Back    | 返回上一页面或指定的页面。              |


## 属性

| 名称     | 参数      | 默认值       | 描述                                       |
| ------ | ------- | --------- | ---------------------------------------- |
| active | boolean | -         | 当前路由组件是否处于激活状态，处于激活状态时，会生效相应的路由操作。       |
| params | Object  | undefined | 跳转时要同时传递到目标页面的数据，可在目标页面使用router.getParams()获得。 |


## 示例

```ts
// Navigator.ets
@Entry
@Component
struct NavigatorExample {
  @State active: boolean = false
  @State Text: string = 'news'

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Start, justifyContent: FlexAlign.SpaceBetween }) {
      Navigator({ target: 'pages/container/navigator/Detail', type: NavigationType.Push }) {
        Text('Go to ' + this.Text + ' page').width('100%').textAlign(TextAlign.Center)
      }.params({ text: this.Text })

      Navigator() {
        Text('Back to previous page').width('100%').textAlign(TextAlign.Center)
      }.active(this.active)
      .onClick(() => {
        this.active = true
      })
    }.height(150).width(350).padding(35)
  }
}
```

```ts
// Detail.ets
import router from '@system.router'

@Entry
@Component
struct DetailExample {
  @State text: string = router.getParams().text

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Start, justifyContent: FlexAlign.SpaceBetween }) {
      Navigator({ target: 'pages/container/navigator/Back', type: NavigationType.Push }) {
        Text('Go to back page').width('100%').height(20)
      }

      Text('This is ' + this.text + ' page').width('100%').textAlign(TextAlign.Center)
    }
    .width('100%').height(200).padding({ left: 35, right: 35, top: 35 })
  }
}

```

```ts
// Back.ets
@Entry
@Component
struct BackExample {
  build() {
    Column() {
      Navigator({ target: 'pages/container/navigator/Navigator', type: NavigationType.Back }) {
        Text('Return to Navigator Page').width('100%').textAlign(TextAlign.Center)
      }
    }.width('100%').height(200).padding({ left: 35, right: 35, top: 35 })
  }
}
```

![zh-cn_image_0000001219864145](figures/zh-cn_image_0000001219864145.gif)