mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-07-16 21:45:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup previous PR

Browse Source
This commit is contained in:
Kovid Goyal
2025-03-19 21:25:02 +05:30
parent 80db9b4734
commit 0db9b882fe
4 changed files with 33 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
kitty/options/definition.py
View File

@@ -265,31 +265,32 @@ Then adjust the second parameter until it looks good. Then switch to a light the
and adjust the first parameter until the perceived thickness matches the dark theme.
''')
opt('text_fg_override_threshold', '0 %', option_type='text_fg_override_threshold', long_text='''
A setting to prevent low contrast scenarios, configurable in two different modes (suffix :code:` %` and suffix :code:` ratio`).
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 value with the suffix :code:` %` 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.
opt('text_fg_override_threshold', '0', option_type='text_fg_override_threshold', long_text='''
A setting to prevent low contrast between foreground and background colors.
Useful when working with applications that use colors that do not contrast
well with your preferred color scheme. The default value is :code:`0`, which means no color overriding is performed.
There are two modes of operation:
A value with the suffix :code:` ratio` represents the minimum accepted contrast ratio between the foreground and background color.
Possible values range from :code:`0.0 ratio` to :code:`21.0 ratio`.
To for example meet :link:`WCAG level AA <https://en.wikipedia.org/wiki/Web_Content_Accessibility_Guidelines>`
For example, to meet :link:`WCAG level AA <https://en.wikipedia.org/wiki/Web_Content_Accessibility_Guidelines>`
a value of :code:`4.5 ratio` 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.
A value with the suffix :code:` %` 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.
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,
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 or consider the minimum contrast ratio (negative value)
over the minimum difference as it implements a basic workaround for this scenario.
see if this is the cause of the problem or consider using the :code:`ratio` mode of operation
described above instead of the :code:`%` mode of operation.
''')
egr() # }}}

5
kitty/options/utils.py
View File

@@ -754,10 +754,7 @@ def active_tab_title_template(x: str) -> str | None:
def text_fg_override_threshold(x: str) -> tuple[float, str]:
value, unit = number_with_unit(x, default_unit='%')
if unit not in ['%', 'ratio']:
raise ValueError(f'The unit {unit} is not a valid choice for text_fg_override_threshold')
return value, unit
return number_with_unit(x, '%', 'ratio')
ClearOn = Literal['next', 'focus']