---
name: "getMenuButtonBoundingClientRect"
mode: "kit"
versionRequirements:
  - { name: "MiniKit", version: "2.3.0" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
title: "getMenuButtonBoundingClientRect - 获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。"
---

## getMenuButtonBoundingClientRect

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

> [PLATFORM] iOS, Android

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

### 描述

获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。

### 参数

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `complete` | `() => void` | 否 | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `width` | `number` | `3.2.0` | 宽度，单位：px |
| `height` | `number` | `3.2.0` | 高度，单位：px |
| `top` | `number` | `3.2.0` | 上边界坐标，单位：px |
| `right` | `number` | `3.2.0` | 右边界坐标，单位：px |
| `bottom` | `number` | `3.2.0` | 下边界坐标，单位：px |
| `left` | `number` | `3.2.0` | 左边界坐标，单位：px |

#### fail 回调参数

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

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

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


### 示例代码

#### Demo

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

getMenuButtonBoundingClientRect({
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```