getRect 节点布局信息 | uView Pro - 多平台快速开发的UI框架

# getRect 节点布局信息

此方法封装自uni的nodesRef.boundingClientRect (opens new window)，它极大简化了使用复杂度，内部使用Promise，可以让用户同步获取节点信息。

# getRect(selector, instance, all)

selector <String> 此参数为元素节点，可以是id或者class，比如"#user-name"，".box"
instance <ComponentInternalInstance> 此参数为组件实例，通过 getCurrentInstance() 获得
all <Boolean> 是否返回全部节点信息，当页面有多个相同selector的元素时，all为true，会以数组形式返回所有节点的信息(结果为数组，数组元素为对象)，否则只返回第一个节点的信息(结果为一个对象)

注意：该方法返回的结果，共有如下有用信息：

res = {
	left: 0,
	right: 414,
	top: 323,
	height: 2597,
	bottom: 2920,
	width: 414
}

受限于nodesRef.boundingClientRect，其上结果中的left，top，right，bottom，是会随着页面滚动而变化的，因为这个查询的相对于屏幕窗口，而不是相对于页面根元素的，但width，height，是恒定不变的，所以一般情况我们推荐您想要获取节点宽高的时候采用这个方法。

注意

由于onLoad生命周期元素尚未创建完成，请勿在此生命周期使用此方法，如果是页面，应该在onReady生命周期，组件内应该在mounted生命周期调用。如果要查询的目标，是通过服务端获取数据后才渲染的，那么应该在获取数据后，通过this.$nextTick调用此方法。

# 异步使用方法

通过then调用即可

const instance = getCurrentInstance()

getElInfo() {
	uni.$u.getRect('.user-avatar', instance).then(res => {
		console.log(res);
	})
}

# 同步使用方法

该方法的使用场景为您下一步的操作需要获取元素的节点后才能进行的情况，可以通过async/await方式调用，注意，无论是生命周期还是methods中的方法，都可以在其前面添加async修饰符

const instance = getCurrentInstance()

async getElInfo() {
	let rectInfo = await uni.$u.getRect('.user-avatar', instance);
	console.log(rectInfo);
}

# 请求数据后再获取节点信息

此场景为元素内容为后端获取数据填充的，节点填充数据前后，元素的大小尺寸是不一样的，所以需要在获取后再执行此方法，这里通过this.$nextTick调用，是因为它会等待数据赋值，元素创建完成后再执行，此时才是准确的尺寸，以下演示，为uView自带的http 请求方法调用

<template>
	<view>
		<view class="user-name">
			{{ userName }}
		</view>
	</view>
</template>

<script setup >
import { ref, onMounted, getCurrentInstance } from 'vue';

const userName = ref('');
const instance = getCurrentInstance();

onMounted(() => {
	getElInfo();
});

async function getElInfo() {
	try {
		const res = await uni.$u.post('http://www.example.com/user/info');
		userName.value = res.name;
		await nextTick();
		const rect = await uni.$u.getRect('.user-avatar', instance);
		console.log(rect);
	} catch (error) {
		console.error(error);
	}
}
</script>

# 获取全部节点信息

设置第二个参数为true，此场景为页面有多个相同类名的元素，需要获取所有同类名节点信息时候使用，返回结果为一个数组

<template>
	<view>
		<view class="item">
			uView Pro
		</view>
		<view class="item">
			<view>红豆生南国，春来发几枝</view>
			<view>愿君多采撷，此物最相思</view>
		</view>
	</view>
</template>

<script setup>
import { ref, onMounted, getCurrentInstance } from 'vue';

const instance = getCurrentInstance();

onMounted(() => {
	getElInfo();
});

async function getElInfo() {
	try {
		const rect = await uni.$u.getRect('.item', instance, true);
		console.log(rect); // rect为一个数组(内有2个元素)，因为页面有2个.item节点
	} catch (error) {
		console.error(error);
	}
}
</script>

# 如何让让某个元素滚动到页面顶部

这里说的顶部，指的是导航栏的下方，比如我们点击某个操作，页面自动滚动，指定元素位于导航栏下方时停止。
我们需要结合onPageScroll生命周期，获得实时的页面滚动条位置。

<template>
	<view class="wrap">
		<view class="item">
			uView Pro
		</view>
		<view class="item">
			uView Pro
		</view>
		<view class="item">
			uView Pro
		</view>
		<view class="item">
			uView Pro
		</view>
		<view class="item object-item" @tap="scrollEl">
			点我，我就会滚动到导航栏下方
		</view>
	</view>
</template>

<script setup>
import { ref, onMounted, getCurrentInstance } from 'vue';
import { onPageScroll } from '@dcloudio/uni-app';

const instance = getCurrentInstance();

const scrollTop = ref(0);

onPageScroll((e: { scrollTop: number }) => {
    scrollTop.value = e.scrollTop;
});

const scrollEl = () => {
  uni.$u.getRect('.object-item', instance).then(res => {
    uni.pageScrollTo({
      scrollTop: scrollTop.value + res.top,
      duration: 0
    });
  });
}
</script>

<style lang="scss" scoped>
	.wrap {
		height: 200vh;
	}
</style>

← 去除空格