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