---
name: "navigateTo"
mode: "kit"
versionRequirements:
  - { name: "MiniKit", version: "1.0.0" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
---

## navigateTo

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

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Navigate to a new page

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `url` | `string` | Yes | - | `1.0.0` | Page path; parameters must be URL-encoded |
| `type` | `string` | No | `"full"` | `2.6.0` | Open mode; supports full-screen full and half-screen half; default: full |
| `topMargin` | `number` | No | `100` | `3.11.3` | Distance from the top of the screen for non-full-screen pages; effective when type is half. Range: [1–screen height], unit: px. Note: On Android, the display area excludes the status bar; on iOS, it includes the status bar. Therefore, on Android, the maximum topMargin is screen height minus the status bar height. |
| `topMarginPercent` | `number` | No | - | `3.11.3` | Percentage distance from the top of the screen for non-full-screen pages; effective when type is half and has higher priority than topMargin. Range: [1–99], unit: percent. Note: On Android, the display area excludes the status bar; on iOS, it includes the status bar. |
| `animationType` | `string` | No | - | `3.26.0` | Specify the page enter animation; currently supports "slide-in-bottom". If not specified, the default style is used. |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `() => void` | No | - | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Examples

#### 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); },
});
```