mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-06-08 22:28:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add min contrast ratio

Browse Source
This commit is contained in:
arne314
2025-03-13 15:10:11 +01:00
parent a6379d9003
commit d09327581e
1 changed files with 15 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
kitty/options/definition.py
View File

@@ -266,20 +266,30 @@ and adjust the first parameter until the perceived thickness matches the dark th
''')
opt('text_fg_override_threshold', 0, option_type='float', long_text='''
The minimum accepted difference in luminance between the foreground and background
A setting to prevent low contrast scenarios, configurable in two different modes (positive and negative value).
The default value is :code:`0`, which means no overriding is performed. Useful when working with applications
that use colors that do not contrast well with your preferred color scheme.
A positive value represents the minimum accepted difference in luminance between the foreground and background
color, below which kitty will override the foreground color. It is percentage
ranging from :code:`0` to :code:`100`. If the difference in luminance of the
foreground and background is below this threshold, the foreground color will be set
to white if the background is dark or black if the background is light. The default
value is :code:`0`, which means no overriding is performed. Useful when working with applications
that use colors that do not contrast well with your preferred color scheme.
to white if the background is dark or black if the background is light.
A negative value represents the minimum accepted contrast ratio between the foreground and background color.
Possible values range from :code:`-0.0` to :code:`-21.0`.
To for example meet :link:`WCAG level AA <https://en.wikipedia.org/wiki/Web_Content_Accessibility_Guidelines>`
a value of :code:`-4.5` can be provided.
The algorithm is implemented using :link:`HSLuv <https://www.hsluv.org/>` which enables it to change
the perceived lightness of a color just as much as needed without really changing its hue and saturation.
WARNING: Some programs use characters (such as block characters) for graphics
display and may expect to be able to set the foreground and background to the
same color (or similar colors). If you see unexpected stripes, dots, lines,
incorrect color, no color where you expect color, or any kind of graphic
display problem try setting :opt:`text_fg_override_threshold` to :code:`0` to
see if this is the cause of the problem.
see if this is the cause of the problem or consider the minimum contrast ratio (negative value)
over the minimum difference as it implements a basic workaround for this scenario.
''')
egr() # }}}