頁面路由

導(dǎo)入模塊

import router from '@ohos.router'

router.pushUrl9+

pushUrl(options: RouterOptions): Promise<void>

跳轉(zhuǎn)到應(yīng)用內(nèi)的指定頁面。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見ohos.router(頁面路由)錯(cuò)誤碼。

示例：

router.pushUrl({
  url: 'pages/routerpage2',
  params: {
    data1: 'message',
    data2: {
      data3: [123, 456, 789]
    }
  }
})
  .then(() => {
    // success
  })
  .catch(err => {
    console.error(`pushUrl failed, code is ${err.code}, message is ${err.message}`);
  })

router.pushUrl9+

pushUrl(options: RouterOptions, callback: AsyncCallback<void>): void

跳轉(zhuǎn)到應(yīng)用內(nèi)的指定頁面。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

參數(shù)：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見ohos.router(頁面路由)錯(cuò)誤碼。

示例：

router.pushUrl({
  url: 'pages/routerpage2',
  params: {
    data1: 'message',
    data2: {
      data3: [123, 456, 789]
    }
  }
}, (err) => {
  if (err) {
    console.error(`pushUrl failed, code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info('pushUrl success');
});

router.pushUrl9+

pushUrl(options: RouterOptions, mode: RouterMode): Promise<void>

跳轉(zhuǎn)到應(yīng)用內(nèi)的指定頁面。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見ohos.router(頁面路由)錯(cuò)誤碼。

示例：

router.pushUrl({
  url: 'pages/routerpage2',
  params: {
    data1: 'message',
    data2: {
      data3: [123, 456, 789]
    }
  }
}, router.RouterMode.Standard)
  .then(() => {
    // success
  })
  .catch(err => {
    console.error(`pushUrl failed, code is ${err.code}, message is ${err.message}`);
  })

router.pushUrl9+

pushUrl(options: RouterOptions, mode: RouterMode, callback: AsyncCallback<void>): void

跳轉(zhuǎn)到應(yīng)用內(nèi)的指定頁面。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

參數(shù)：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見ohos.router(頁面路由)錯(cuò)誤碼。

示例：

router.pushUrl({
  url: 'pages/routerpage2',
  params: {
    data1: 'message',
    data2: {
      data3: [123, 456, 789]
    }
  }
}, router.RouterMode.Standard, (err) => {
  if (err) {
    console.error(`pushUrl failed, code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info('pushUrl success');
});

router.replaceUrl9+

replaceUrl(options: RouterOptions): Promise<void>

用應(yīng)用內(nèi)的某個(gè)頁面替換當(dāng)前頁面，并銷毀被替換的頁面。不支持設(shè)置頁面轉(zhuǎn)場動(dòng)效，如需設(shè)置，推薦使用Navigation組件。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Lite

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見ohos.router(頁面路由)錯(cuò)誤碼。

示例：

router.replaceUrl({
  url: 'pages/detail',
  params: {
    data1: 'message'
  }
})
  .then(() => {
    // success
  })
  .catch(err => {
    console.error(`replaceUrl failed, code is ${err.code}, message is ${err.message}`);
  })

router.replaceUrl9+

replaceUrl(options: RouterOptions, callback: AsyncCallback<void>): void

用應(yīng)用內(nèi)的某個(gè)頁面替換當(dāng)前頁面，并銷毀被替換的頁面。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Lite

參數(shù)：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見ohos.router(頁面路由)錯(cuò)誤碼。

示例：

router.replaceUrl({
  url: 'pages/detail',
  params: {
    data1: 'message'
  }
}, (err) => {
  if (err) {
    console.error(`replaceUrl failed, code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info('replaceUrl success');
});

router.replaceUrl9+

replaceUrl(options: RouterOptions, mode: RouterMode): Promise<void>

用應(yīng)用內(nèi)的某個(gè)頁面替換當(dāng)前頁面，并銷毀被替換的頁面。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Lite

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見ohos.router(頁面路由)錯(cuò)誤碼。

示例：

router.replaceUrl({
  url: 'pages/detail',
  params: {
    data1: 'message'
  }
}, router.RouterMode.Standard)
  .then(() => {
    // success
  })
  .catch(err => {
    console.error(`replaceUrl failed, code is ${err.code}, message is ${err.message}`);
  })

router.replaceUrl9+

replaceUrl(options: RouterOptions, mode: RouterMode, callback: AsyncCallback<void>): void

用應(yīng)用內(nèi)的某個(gè)頁面替換當(dāng)前頁面，并銷毀被替換的頁面。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Lite

參數(shù)：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見ohos.router(頁面路由)錯(cuò)誤碼。

示例：

router.replaceUrl({
  url: 'pages/detail',
  params: {
    data1: 'message'
  }
}, router.RouterMode.Standard, (err) => {
  if (err) {
    console.error(`replaceUrl failed, code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info('replaceUrl success');
});

router.back

back(options?: RouterOptions ): void

返回上一頁面或指定的頁面。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

參數(shù)：

示例：

router.back({url:'pages/detail'});    

router.clear

clear(): void

清空頁面棧中的所有歷史頁面，僅保留當(dāng)前頁面作為棧頂頁面。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

示例：

router.clear();    

router.getLength

getLength(): string

獲取當(dāng)前在頁面棧內(nèi)的頁面數(shù)量。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

示例：

let size = router.getLength();        
console.log('pages stack size = ' + size);    

router.getState

getState(): RouterState

獲取當(dāng)前頁面的狀態(tài)信息。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

示例：

let page = router.getState();
console.log('current index = ' + page.index);
console.log('current name = ' + page.name);
console.log('current path = ' + page.path);

RouterState

頁面狀態(tài)信息。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full。

router.showAlertBeforeBackPage9+

showAlertBeforeBackPage(options: EnableAlertOptions): void

開啟頁面返回詢問對(duì)話框。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

參數(shù)：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見ohos.router(頁面路由)錯(cuò)誤碼。

示例：

import { BusinessError } from '@ohos.base';

try {
router.showAlertBeforeBackPage({
  message: 'Message Info'
});
} catch(err) {
console.error(`Invoke showAlertBeforeBackPage failed, code is ${err.code}, message is ${err.message}`);
}

EnableAlertOptions

頁面返回詢問對(duì)話框選項(xiàng)。

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.ArkUI.ArkUI.Full。

router.hideAlertBeforeBackPage9+

hideAlertBeforeBackPage(): void

禁用頁面返回詢問對(duì)話框。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

示例：

router.hideAlertBeforeBackPage();    

router.getParams

getParams(): Object

獲取發(fā)起跳轉(zhuǎn)的頁面往當(dāng)前頁傳入的參數(shù)。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

返回值：

示例：

router.getParams();

RouterOptions

路由跳轉(zhuǎn)選項(xiàng)。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Lite。

RouterMode9+

路由跳轉(zhuǎn)模式。

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full。

完整示例

基于JS擴(kuò)展的類Web開發(fā)范式

// 在當(dāng)前頁面中
export default {
  pushPage() {
    router.push({
      url: 'pages/detail/detail',
      params: {
        data1: 'message'
      }
    });
  }
}

// 在detail頁面中
export default {
  onInit() {
    console.info('showData1:' + router.getParams()['data1']);
  }
}

基于TS擴(kuò)展的聲明式開發(fā)范式

// 通過router.pushUrl跳轉(zhuǎn)至目標(biāo)頁攜帶params參數(shù)
import router from '@ohos.router'

@Entry
@Component
struct Index {
  async routePage() {
    let options = {
      url: 'pages/second',
      params: {
        text: '這是第一頁的值',
        data: {
          array: [12, 45, 78]
        }
      }
    }
    try {
      await router.pushUrl(options)
    } catch (err) {
      console.info(` fail callback, code: ${err.code}, msg: ${err.msg}`)
    }
  }

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Text('這是第一頁')
        .fontSize(50)
        .fontWeight(FontWeight.Bold)
      Button() {
        Text('next page')
          .fontSize(25)
          .fontWeight(FontWeight.Bold)
      }.type(ButtonType.Capsule)
      .margin({ top: 20 })
      .backgroundColor('#ccc')
      .onClick(() => {
        this.routePage()
      })
    }
    .width('100%')
    .height('100%')
  }
}

// 在second頁面中接收傳遞過來的參數(shù)
import router from '@ohos.router'

@Entry
@Component
struct Second {
  private content: string = "這是第二頁"
  @State text: string = router.getParams()['text']
  @State data: object = router.getParams()['data']
  @State secondData: string = ''

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
      Text(`${this.content}`)
        .fontSize(50)
        .fontWeight(FontWeight.Bold)
      Text(this.text)
        .fontSize(30)
        .onClick(() => {
          this.secondData = (this.data['array'][1]).toString()
        })
        .margin({ top: 20 })
      Text(`第一頁傳來的數(shù)值:${this.secondData}`)
        .fontSize(20)
        .margin({ top: 20 })
        .backgroundColor('red')
    }
    .width('100%')
    .height('100%')
  }
}

router.push(deprecated)

push(options: RouterOptions): void

跳轉(zhuǎn)到應(yīng)用內(nèi)的指定頁面。

從API version9開始不再維護(hù)，建議使用pushUrl9+

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

參數(shù)：

示例：

router.push({
  url: 'pages/routerpage2',
  params: {
    data1: 'message',
    data2: {
      data3: [123, 456, 789]
    }
  }
});

router.replace(deprecated)

replace(options: RouterOptions): void

用應(yīng)用內(nèi)的某個(gè)頁面替換當(dāng)前頁面，并銷毀被替換的頁面。

從API version9開始不再維護(hù)，建議使用replaceUrl9+

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Lite

參數(shù)：

示例：

router.replace({
  url: 'pages/detail',
  params: {
    data1: 'message'
  }
});

router.enableAlertBeforeBackPage(deprecated)

enableAlertBeforeBackPage(options: EnableAlertOptions): void

開啟頁面返回詢問對(duì)話框。

從API version9開始不再維護(hù)，建議使用showAlertBeforeBackPage9+

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

參數(shù)：

示例：

router.enableAlertBeforeBackPage({            
  message: 'Message Info'        
});    

router.disableAlertBeforeBackPage(deprecated)

disableAlertBeforeBackPage(): void

禁用頁面返回詢問對(duì)話框。

從API version9開始不再維護(hù)，建議使用hideAlertBeforeBackPage9+

系統(tǒng)能力： SystemCapability.ArkUI.ArkUI.Full

示例：

router.disableAlertBeforeBackPage();