---
name: "getElementById"
mode: "kit"
versionRequirements:
  - { name: "@ray-js/ray", version: "0.5.10" }
---

## getElementById

> [VERSION] @ray-js/ray >= 0.5.10

### 描述

获取页面节点

### 参数

`Params`

| 参数 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `id` | `string` | 是 | - | 节点的 id 属性值 |

### 引用对象

##### `interface` BoundingClientRectResult

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `id` | `string` | 节点 id |
| `dataset` | `Record<string, unknown>` | 节点 dataset |
| `left` | `number` | 左边界坐标 |
| `right` | `number` | 右边界坐标 |
| `top` | `number` | 上边界坐标 |
| `bottom` | `number` | 下边界坐标 |
| `width` | `number` | 节点宽度 |
| `height` | `number` | 节点高度 |

##### `interface` SelectorQueryChain

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `exec` | `(callback: (results: unknown[]) => void) => void` | 执行查询 |

##### `interface` ScrollOffsetResult

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `id` | `string` | 节点 id |
| `dataset` | `Record<string, unknown>` | 节点 dataset |
| `scrollLeft` | `number` | 横向滚动位置 |
| `scrollTop` | `number` | 纵向滚动位置 |


### 示例代码

#### 基础用法

```tsx
import React from 'react';
import { View, Button, Text, getElementById } from '@ray-js/ray';

export default function Demo() {
  const handleGetElement = async () => {
    const element = await getElementById('targetView');
    console.log('节点引用:', element);
  };

  return (
    <View style={{ padding: 20 }}>
      <View
        id="targetView"
        style={{
          height: 100,
          backgroundColor: '#1890ff',
          display: 'flex',
          alignItems: 'center',
          justifyContent: 'center',
        }}
      >
        <Text style={{ color: '#fff' }}>目标节点</Text>
      </View>
      <Button style={{ marginTop: 10 }} onClick={handleGetElement}>
        获取节点引用
      </Button>
    </View>
  );
}
```