Search Docs
Loading...
Skip to content

Interface: TextDecorationConfig

Configuration for text decorations on a text run.

All active decoration lines share the same style and thickness. An optional underline color override can be set; overline and strikethrough always use the text color.

Properties#

PropertyTypeDescription
linesTextDecorationLine[]The active decoration line types. Use ['None'] to clear all decorations. When 'None' is present, all other values are ignored.
style?TextDecorationStyleThe style of the decoration lines. Defaults to ‘Solid’.
underlineColor?ColorOptional color override for underlines only. Uses the text color if not set. Overline and strikethrough always use the text color.
underlineThickness?numberMultiplier for the underline thickness. Defaults to 1.0.
underlineOffset?numberRelative offset applied to the underline position as a multiplier on the font-default distance. 0 = font default, positive = proportionally further from baseline, negative = proportionally closer. The actual position is computed as fontDefault * (1 + underlineOffset). Defaults to 0.0.
skipInk?booleanWhen true, underlines skip over glyph descenders (skip-ink). Defaults to true.