Navigator
The <Navigator> component provides redirection.
NOTE
This component is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.
Child Components
Supported
APIs
Navigator(value?: {target: string, type?: NavigationType})
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
target | string | Yes | Path of the target page to be redirected to. |
type | NavigationType | No | Navigation type. Default value: NavigationType.Push |
NavigationType
Name | Description |
---|---|
Push | Navigates to the specified page in the application. |
Replace | Replaces the current page with another one in the application and destroys the current page. |
Back | Returns to the specified page. If the specified page does not exist in the stack, no response is returned. If no page is specified, the previous page is returned to. |
Attributes
Name | Parameter | Description |
---|---|---|
active | boolean | Whether the <Navigator> component is activated. If the component is activated, the corresponding navigation takes effect. |
params | object | Data that needs to be passed to the target page during redirection. You can use router.getParams() to obtain the data on the target page. |
target | string | Path of the target page to be redirected to. The target page must be added to the main_pages.json file. |
type | NavigationType | Navigation type. Default value: NavigationType.Push |
Example
// Navigator.ets
@Entry
@Component
struct NavigatorExample {
@State active: boolean = false
@State Text: object = {name: '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['name'] + ' page')
.width('100%').textAlign(TextAlign.Center)
}.params({ text: this.Text}) // Transfer parameters to the Detail page.
Navigator() {
Text('Back to previous page').width('100%').textAlign(TextAlign.Center)
}.active(this.active)
.onClick(() => {
this.active = true
})
}.height(150).width(350).padding(35)
}
}
// Detail.ets
import router from '@ohos.router'
@Entry
@Component
struct DetailExample {
// Receive the input parameters of Navigator.ets.
@State text: any = 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['name'] + ' page')
.width('100%').textAlign(TextAlign.Center)
}
.width('100%').height(200).padding({ left: 35, right: 35, top: 35 })
}
}
// 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 })
}
}