Blazor ElementReference.FocusAsync() 使用方法

ElementReference.FocusAsync() 用于让 HTML 元素获得焦点,需 await 调用且仅在组件已渲染、元素存在于 DOM 时有效;应通过 @ref 绑定 ElementReference,避免在 OnInitialized 中调用,推荐在 OnAfterRender(配合标志位)或用户事件中使用,并注意元素状态与兼容性。

在 Blazor 中,ElementReference.FocusAsync() 用于让某个 HTML 元素获得焦点,常用于表单自动聚焦、键盘导航或用户交互触发后快速定位输入框。它返回一个 ValueTask,需用 await 调用,且只在组件已渲染、元素真实存在于 DOM 中时才有效。

确保 ElementReference 已正确绑定

必须先通过 @ref 将元素引用到 ElementReference 类型的字段或属性上,不能直接对字符串或未初始化的变量调用:

  • 在 Razor 文件中:
  • 在 C# 代码块中声明:private ElementReference myInput;
  • 避免在 OnInitialized 中立即调用 FocusAsync —— 此时 DOM 尚未生成,会静默失败

推荐在 OnAfterRender 或事件处理中调用

最稳妥的时机是 OnAfterRender(配合标志位)或用户触发的事件(如按钮点击、输入完成):

  • 点击按钮聚焦:await myInput.FocusAsync(); 放在 async Task HandleClick() { ... }
  • 首次渲染后自动聚焦:用私有布尔字段标记是否已聚焦,在 OnAfterRender 中检查并调用,之后设为 true 防止重复
  • 注意:不要在 OnInitializedAsync 中 await FocusAsync,它不保证 DOM 可用

处理可能的异常和兼容性

FocusAsync 在元素被移除、禁用(disabled)、隐藏(display: nonevisibility: hidden)时可能无效,但通常不会抛异常。可做基础防护:

  • 检查元素是否“可聚焦”:确保不是 disabled 状态,且 tabindex 未设为 -1(除非你主动控制)
  • 若需兼容旧浏览器或 SSR 初始阶段,建议包裹在 try/catch 或判断 JSRuntime 是否可用(服务端渲染时 JS 不可用)
  • Blazor WebAssembly 和 Blazor Server 均支持该方法,但 Server 模式下焦点行为受 SignalR 延迟影响,视觉反馈可能稍滞后

基本上就这些。只要引用存在、时机得当、元素可交互,FocusAsync 就能可靠工作。