---
name: "navigateTo"
mode: "kit"
versionRequirements:
  - { name: "MiniKit", version: "1.0.0" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
title: "navigateTo - 路由到新页面"
---

## navigateTo

> [VERSION] MiniKit >= 1.0.0 | @ray-js/ray >= 0.3.23

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

路由到新页面

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `url` | `string` | 是 | - | `1.0.0` | 页面路径, 参数需要做 url encode 处理 |
| `type` | `string` | 否 | `"full"` | `2.6.0` | 打开方式，支持全屏full，半屏half；默认全屏full |
| `topMargin` | `number` | 否 | `100` | `3.11.3` | 非全屏页面距离屏幕顶部的距离，type 为 half 时有效 取值范围：【1-屏幕的高度】单位：px 注意：Android 显示区域不包括状态栏，iOS显示区域包括状态栏。 因此 Android 的 topMargin 的最大值是屏幕高度减去状态栏的高度。 |
| `topMarginPercent` | `number` | 否 | - | `3.11.3` | 非全屏页面距离屏幕顶部的百分比，type 为 half 时有效，优先级高于 topMargin 取值范围【1-99】单位：百分比 注意：Android 显示区域不包括状态栏，iOS显示区域包括状态栏。 |
| `animationType` | `string` | 否 | - | `3.26.0` | 指定页面进入动画效果，目前支持 "slide-in-bottom" 如果未指定，则使用默认式样 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `() => void` | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 示例代码

#### Demo

```tsx
import { navigateTo } from '@ray-js/ray'

navigateTo({
  url: "pages/index/index",
  type: "full",
  success: data => { console.log(data); },
  fail: error => { console.error(error); },
});
```