wikimedia/mediawiki-skins-MinervaNeue
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/skins/MinervaNeue synced 2024-11-23 22:03:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Edit Less color functions ADR.

Browse source 
Editing ADR for clarity, fixing a few typos.

Change-Id: Ife38d66c0ddd333eff926744a1c22f54abb7400e
This commit is contained in:
Jan Drewniak 2024-03-14 11:56:48 -04:00
parent b91942025b
commit b813c44202
2 changed files with 41 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
adr/0004-drop-support-for-LESS-color-functions-with-codex-tokens.md Normal file
View file

@ -0,0 +1,41 @@
# 1. Drop support for Less color functions with Codex design tokens
Date: 2024-02-16
Last Edited: 2024-03-14
## Status
Accepted.
## Context
In order to reduce the strain on other teams/developers to update their extensions to use
CSS variables rather than LESS, we decided to use [Wikimedia skin variables](https://www.mediawiki.org/wiki/Codex#Using_Codex_design_tokens_in_MediaWiki_and_extensions) to re-map LESS variables to their
CSS variable equivalent.
e.i. `@color-progressive: var( --color-progressive )`;
This is consistent with the Codex design token experimental build which we will
make use of in [T358059](https://phabricator.wikimedia.org/T358059).
This approach has implications on LESS function that manipulate colors, such as
`average`, `fade` and `tint`. These functions expect a parameter of type color.
This approach changes the variable type from color to string, causing these
functions to fail.
## Decision
Given there are few consumers of these LESS functions, we've decided to remove support
for LESS functions that operate on colors. The benefit of this decision is that
it will reduce non-standard colors across the UI.
## Consequences
Extensions that need to work with MinervaNeue for the time being can no longer
use Less color functions with Codex design tokens. They can continue to use
these function if they instead make use of hardcoded hex values (with an
accompanying comment explaining this reason).
We filed [a ticket](https://phabricator.wikimedia.org/T357740) for addressing this on the
long term. This may require upgrading our version of LESS to a more modern
version or a decision to drop support altogether.

23
adr/0004-drop-support-for-codex-design-tokens-with-LESS-mixins.md
View file

@ -1,23 +0,0 @@
# 1. Drop support for Codex Design Tokens with LESS mixins
Date: 2024-02-16
## Status
Accepted.
## Context
In order to reduce the strain on other teams/developers to update their extensions to use
CSS variables rather than LESS, we decided to use [Wikimedia skin variables](https://www.mediawiki.org/wiki/Codex#Using_Codex_design_tokens_in_MediaWiki_and_extensions) to re-map LESS variables to their
CSS variable equivalent. This is consistent with the Codex design token experimental build which we will
make use of in [T358059](https://phabricator.wikimedia.org/T358059) This had implications on native LESS mixins such as `average`, `fade` and `tint`.
## Decision
Given the few consumers of these LESS mixins, we decided to remove support for LESS mixins that operate on colors. One of the downsides of using these LESS mixins is that it produces colors that are not approved by the design style guide.
## Consequences
Skins or extensions that need to work with Vector 2022 for the time being can no longer use Codex design tokens. They can continue to use these mixins if they instead make use of hardcoded hex codes with a comment. We filed [a ticket](https://phabricator.wikimedia.org/T357740) for addressing this on the long term. This may require upgrading our version of LESS to a more modern version or a decision to drop support altogether.