TextFormat: underlineStyle property
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The underlineStyle
property of the TextFormat
interface indicates the style of the underline that needs to be applied to the text range that is being formatted.
Value
A String
that is one of the following values:
"none"
: No underline."solid"
: A solid underline."double"
: A double underline."dotted"
: A dotted underline."dashed"
: A dashed underline."wavy"
: A wavy underline.
Examples
Reading the underline style that needs to be applied
The following example shows how to use the textformatupdate
event's underlineStyle
property to determine the underline style 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.
<div id="editor" style="height:200px;background:#eee;"></div>
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.underlineStyle} underline between ${format.rangeStart} and ${format.rangeEnd}.`,
);
}
});
Specifications
Specification |
---|
EditContext API # dom-textformat-underlinestyle |
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
underlineStyle |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
See also
- The
TextFormat
interface it belongs to.