/
index.md
59 lines (41 loc) · 1.64 KB
/
index.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
---
title: "TextFormat: underlineThickness property"
short-title: underlineThickness
slug: Web/API/TextFormat/underlineThickness
page-type: web-api-instance-property
status:
- experimental
browser-compat: api.TextFormat.underlineThickness
---
{{APIRef("EditContext API")}}{{SeeCompatTable}}
The **`underlineThickness`** property of the {{domxref("TextFormat")}} interface indicates the thickness of the underline that needs to be applied to the text range that is being formatted.
## Value
A {{jsxref("String")}} that is one of the following values:
- `"none"`: No underline.
- `"thin"`: A thin underline.
- `"thick"`: A thick underline.
## Examples
### Reading the underline thickness that needs to be applied
The following example shows how to use the `textformatupdate` event's `underlineThickness` property to determine the underline thickness that needs to be applied to the text being formatted. Note that the event listener callback in this example is only called when using an IME window to compose text.
```html
<div id="editor" style="height:200px;background:#eee;"></div>
```
```js
const editorEl = document.getElementById("editor");
const editContext = new EditContext(editorEl);
editorEl.editContext = editContext;
editContext.addEventListener("textformatupdate", (e) => {
const formats = e.getTextFormats();
for (const format of formats) {
console.log(
`IME wants to apply a ${format.underlineThickness} underline between ${format.rangeStart} and ${format.rangeEnd}.`,
);
}
});
```
## Specifications
{{Specifications}}
## Browser compatibility
{{Compat}}
## See also
- The {{DOMxRef("TextFormat")}} interface it belongs to.