1# Web组件焦点管理 2 3开发者可利用Web组件的焦点管理功能,有效管理Web组件的聚焦与失焦,同时利用H5侧的W3C标准接口,管理网页界面上唯一可交互的元素聚焦与失焦。 4 5- Web组件与ArkUI组件焦点控制的常用接口及其使用场景: 6 7 1. 通过requestFocus主动请求Web组件获焦:当应用内有多个组件时,开发者可通过Web组件的[requestFocus](../reference/apis-arkweb/js-apis-webview.md#requestfocus)接口主动将焦点转移到Web组件上。 8 2. 根据焦点情况更改Web组件样式:组件监听焦点事件上报,为组件修改样式,例如边框、背景色等,以提供视觉和交互反馈。 9 10- Web组件内H5元素焦点控制的常用接口及其使用场景: 11 12 1. 通过tabindex属性管理元素焦点:定义Web组件内元素的焦点顺序。可以通过将元素的tabindex设置为"-1",使其能够通过脚本进行聚焦,同时在CSS中对元素的可见性进行控制。 13 2. 键盘事件更新焦点位置:监听键盘事件,例如Tab键和方向键,依据用户的操作更新Web内元素焦点位置。 14 3. 根据焦点情况更改Web组件内元素样式:为焦点元素添加样式,例如边框、背景色等,以提供视觉和交互反馈。 15 16## 基础概念 17Web组件焦点、焦点链和走焦的详情说明请参考[ArkUI焦点基础概念](../ui/arkts-common-events-focus-event.md#基础概念)。 18 19- 焦点: 20 - 组件焦点:指当前应用界面上唯一的一个可交互元素。 21 - 网页内元素焦点:指当前网页界面上唯一的一个可交互元素。 22 - 当用户使用键盘、遥控器、遥杆等非指向性输入设备与应用程序进行间接交互时,基于焦点的导航和交互是重要的输入手段。 23- 走焦: 24 - 组件走焦:指焦点在应用内的组件之间转移的行为。这一过程对用户透明,开发者可以通过监听onFocus(焦点获取)和onBlur(焦点失去)事件来捕捉这些变化。 25 - 网页内元素走焦:指焦点在网页内的元素之间转移的行为。该行为遵循W3C标准,开发者可以通过监听focus(在元素获取焦点时触发)和blur(在元素失去焦点时触发)事件来捕捉这些变化。 26 27## Web组件走焦规范 28根据走焦的触发方式,可以分为主动走焦和被动走焦,Web组件走焦规范详情参考[ArkUI走焦规范](../ui/arkts-common-events-focus-event.md#走焦规范)。 29 30### 主动走焦 31指开发者或用户主观行为导致的焦点移动。包括:使用requestFocus申请焦点、外接键盘的按键走焦(TAB键/Shift+TAB键/方向键)、点击申请焦点(手势/鼠标/触摸板)等导致的焦点转移。 32 33- requestFocus 34 35 详见[Web组件与ArkUI组件焦点控制](./web-focus.md#web组件与arkui组件焦点控制),可以主动将焦点转移到Web组件上。 36 37- 按键走焦 38 39 - 支持ArkWeb与其他组件通过TAB键、Shift+TAB键或方向键走焦。 40 - 支持ArkWeb内部网页元素通过TAB键、Shift+TAB键或方向键走焦,网页元素走焦完成后,抛回ArkUI继续框架侧走焦。 41 42- 点击申请获焦 43 44 开发者或用户可通过手势、鼠标或触摸板点击Web组件,使其主动获得焦点。当具体点击到Web组件内的某个元素时,该元素能够获得焦点,例如,点击网页内的输入框,可使其从不可编辑状态转变为可编辑状态,并激活输入法。 45 46### 被动走焦 47被动走焦指焦点因系统获其他操作而转移,无需开发者直接干预,是焦点系统的默认行为。 48 49目前会被动走焦的场景有: 50 51- 组件删除:当焦点所在的Web组件被移除时,系统会按照先向后再向前的原则,将焦点转移至相邻的同级组件。倘若所有同级组件均无法获取焦点,则焦点将被释放,并提示其父级组件接管焦点处理。 52 53- 属性变更:如果将处于焦点状态的组件的focusable或enabled属性设置为false,或者将visibility属性设置为不可见,系统会自动将焦点转移到其他可获得焦点的组件上,转移方式同组件删除。 54 55- Web组件不可见:ArkWeb获焦后,应用前后台切换、页面切换、Navigation导航等场景,ArkWeb会失焦再获焦。 56 57- Web组件加载网页:ArkWeb通过src、loadUrl、loadData加载网页,默认会获取焦点,但如果此时web组件为不可获焦状态则会获焦失败(常见的不可获焦状态原因有:过场动画过程中父组件不可获焦、应用侧设置了web组件或其父组件不可获焦属性等),应用侧可以调用主动请求焦点接口[requestFocus](../reference/apis-arkweb/js-apis-webview.md#requestfocus)再次尝试使web组件获焦。当获焦成功后,应用侧onFocus、w3c focus事件均会上报。 58 59- autofocus样式:设置了autofocus样式的元素网页完成加载时默认获焦。若该元素支持文字输入,则输入框会有光标闪烁,但不拉起软键盘。 60 61- 菜单弹出:ArkUI的overlay属性类型组件默认抢焦,在与此类组件结合的ArkWeb场景中([menu](../reference/apis-arkui/arkui-ts/ts-basic-components-menu.md)、[datepicker](../reference/apis-arkui/arkui-ts/ts-basic-components-datepicker.md)、[timepicker](../reference/apis-arkui/arkui-ts/ts-basic-components-timepicker.md)、下拉框、弹窗等),ArkWeb均会失焦。 62 63## Web组件与ArkUI组件焦点控制 64 65- 应用侧通用获焦回调接口[onFocus](../reference/apis-arkui/arkui-ts/ts-universal-focus-event.md#onfocus),获焦事件回调,绑定该接口的组件获焦时,回调响应。 66- 应用侧通用失焦回调接口[onBlur](../reference/apis-arkui/arkui-ts/ts-universal-focus-event.md#onblur),失焦事件回调,绑定该接口的组件失焦时,回调响应。 67- 应用侧主动请求焦点接口[requestFocus](../reference/apis-arkweb/js-apis-webview.md#requestfocus),组件主动请求焦点。 68 69**示例:** 701. requestFocus能够让应用开发者主动选择控制组件走焦到Web组件上。 712. onFocus和onBlur两个接口通常成对使用,来监听组件的焦点变化。 72 73```ts 74// xxx.ets 75import { webview } from '@kit.ArkWeb'; 76import { BusinessError } from '@kit.BasicServicesKit'; 77 78@Entry 79@Component 80struct WebComponent { 81 controller: webview.WebviewController = new webview.WebviewController(); 82 controller2: webview.WebviewController = new webview.WebviewController(); 83 @State webborderColor: Color = Color.Red; 84 @State webborderColor2: Color = Color.Red; 85 86 build() { 87 Column() { 88 Row() { 89 Button('web1 requestFocus') 90 .onClick(() => { 91 try { 92 this.controller.requestFocus(); 93 } catch (error) { 94 console.error(`ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`); 95 } 96 }); 97 Button('web2 requestFocus') 98 .onClick(() => { 99 try { 100 this.controller2.requestFocus(); 101 } catch (error) { 102 console.error(`ErrorCode: ${(error as BusinessError).code}, Message: ${(error as BusinessError).message}`); 103 } 104 }); 105 } 106 Web({ src: 'www.example.com', controller: this.controller }) 107 .onFocus(() => { 108 this.webborderColor = Color.Green; 109 }) 110 .onBlur(() => { 111 this.webborderColor = Color.Red; 112 }) 113 .margin(3) 114 .borderWidth(10) 115 .borderColor(this.webborderColor) 116 .height("45%") 117 118 Web({ src: 'www.example.com', controller: this.controller2 }) 119 .onFocus(() => { 120 this.webborderColor2 = Color.Green; 121 }) 122 .onBlur(() => { 123 this.webborderColor2 = Color.Red; 124 }) 125 .margin(3) 126 .borderWidth(10) 127 .borderColor(this.webborderColor2) 128 .height("45%") 129 } 130 } 131} 132``` 133**示例图1** 组件焦点获焦/失焦事件 134 135通过requestfocus接口主动请求获焦,并监听通用接口onFocus、onBlur事件,改变Web组件边框颜色。 136 137 138 139## Web组件内H5元素焦点控制 140- W3C标准事件focus,前端感知网页获焦 141``` 142addEventListener("focus", (event) => {}); 143 144onfocus = (event) => {}; 145``` 146- W3C标准事件blur,前端感知网页失焦 147``` 148addEventListener("blur", (event) => {}); 149 150onblur = (event) => {}; 151``` 152- W3C autofocus,表示元素应在页面加载时或其所属的 `dialog` 显示时被聚焦 153``` 154<input name="q" autofocus /> 155``` 156在文档或对话框中,最多只能有一个元素具有 autofocus 属性。如果应用于多个元素,第一个元素将获得焦点。 157 158**示例:** 159```ts 160// xxx.ets 161import { webview } from '@kit.ArkWeb'; 162import { BusinessError } from '@kit.BasicServicesKit'; 163 164@Entry 165@Component 166struct WebComponent { 167 controller: webview.WebviewController = new webview.WebviewController(); 168 169 build() { 170 Column() { 171 Web({ src: $rawfile("test.html"), controller: this.controller }) 172 } 173 } 174} 175``` 176 177```js 178// test.html 179<!DOCTYPE html> 180<html> 181<head> 182<meta charset="utf-8"> 183<title>test</title> 184</head> 185<body> 186 <form id="form"> 187 <input type="text" placeholder="text input" /> 188 <input type="password" placeholder="password" /> 189 </form> 190</body> 191<script> 192const form = document.getElementById("form"); 193 194form.addEventListener( 195 "focus", 196 (event) => { 197 event.target.style.background = "pink"; 198 }, 199 true, 200); 201 202form.addEventListener( 203 "blur", 204 (event) => { 205 event.target.style.background = ""; 206 }, 207 true, 208); 209</script> 210</html> 211``` 212 213**示例图2** Web组件内元素焦点获焦/失焦事件 214 215通过监听W3C接口focus、blur事件,改变输入背景色。 216 217