Blazor 怎么使用 @ref 引用组件或元素

煙雲

煙雲

2025-12-22

719人浏览

原创

@ref用于获取组件或HTML元素引用,支持调用方法、聚焦等操作;需在OnAfterRender后使用,不可在OnInitialized中访问;配合JS Interop可操作DOM;动态列表应结合@key与字典存储引用。

blazor 怎么使用 @ref 引用组件或元素

在 Blazor 中,@ref 用于获取对已渲染组件实例或 HTML 元素的引用,方便在 C# 代码中直接操作(比如调用组件方法、聚焦输入框、读取 DOM 属性等)。它不是 JavaScript 的 ref,而是 Blazor 的“组件/元素引用机制”,需注意生命周期和使用时机。

引用自定义组件(如 MyButton.razor)

给组件标签加 @ref,绑定一个匹配类型的字段或属性即可。Blazor 会在组件完成首次渲染后自动赋值。

示例:

<mybutton onclick="HandleClick"></mybutton><p>@code {
private MyButton myButton; // 类型必须和组件一致</p><pre class="brush:php;toolbar:false;">private void HandleClick()
{
    myButton?.ShowSuccess(); // 调用组件公开的方法
}

}

⚠️ 注意:该字段在组件初始化(OnInitialized)时仍为 null,必须等到 OnAfterRender 或用户交互触发后才可用;若需立即操作,可结合 StateHasChanged() + 条件判断。

引用原生 HTML 元素(如 input、div)

Blazor 不允许直接操作 DOM,但可通过 @ref 获取 ElementReference,再配合 JS Interop 实现聚焦、滚动、获取尺寸等操作。

示例(自动聚焦输入框):

度加AI
度加AI

度加AI官网入口,百度官方 AIGC 创作平台,支持 AI 成片、AI 生文、数字人、声音克隆、配音字幕与智能剪辑等在线创作能力。

下载
<input type="text"><button>聚焦</button>
<p>@code {
private ElementReference textInput;</p><pre class="brush:php;toolbar:false;">private async Task FocusInput()
{
    await JSRuntime.InvokeVoidAsync("focusElement", textInput);
}

}

对应 JS(在 wwwroot/js/site.js 中):

window.focusElement = (element) => element.focus();

✅ 常见用途:聚焦、scrollIntoView、读取 clientWidth、监听原生事件(需搭配 JS Interop)。

@ref 的关键注意事项

  • 只在首次渲染后生效@ref 绑定的变量在 OnInitializedOnParametersSet 中仍是 null,不要在此阶段调用
  • 不支持条件渲染中的 @ref:如果组件/元素被 @ifforeach 动态控制,且初始为 false,@ref 可能不会更新或变为 null;建议用 @key 配合确保引用稳定
  • 避免在循环中复用同一 ref 变量:如下写法会导致所有项共用最后一个引用 —— 应改用数组或字典存多个引用
  • 组件必须有 public 无参构造函数,否则 @ref 无法实例化(一般默认满足)

替代方案:使用 @key + 状态管理更稳妥

当需要精确控制引用生命周期(例如列表项动态增删),推荐结合 @key 和状态集合:

@foreach (var item in items)
{
    <myitem data="item"></myitem>
}
<p>@code {
private Dictionary<guid myitem> refs = new();
private List<itemmodel> items = new();
}</itemmodel></guid></p>

这样每个组件都有独立引用,增删时 Blazor 能正确复用或销毁对应实例。

基本上就这些。@ref 是 Blazor 实现细粒度交互的基础能力,用对时机、避开常见坑,就能自然衔接组件逻辑与底层 DOM 操作。

相关专题

更多
c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

420

3

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

2024.03.01

1487

6

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

2023.08.22

1020

3

php中foreach用法
php中foreach用法

本专题整合了php中foreach用法的相关介绍,阅读专题下面的文章了解更多详细教程。

2025.12.04

450

13

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

2023.06.20

1857

8

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.28

910

5

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1154

5

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

2023.08.17

7910

11

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

638

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 11.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.1万人学习