-
Notifications
You must be signed in to change notification settings - Fork 1
docs: color palette aliases design decisions #22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| # Decyzje projektowe: Warstwa aliasów kolorystycznych dla SLASHED | ||
|
|
||
| ## Kontekst i problem | ||
|
|
||
| Framework SLASHED posiada trójwarstwową architekturę kolorów: | ||
| 1. **Source tokens** (`@property`) - 11 par `-light`/`-dark` do themowania | ||
| 2. **Resolved tokens** - `--sf-color-primary` via `light-dark()` auto-switch | ||
| 3. **Palette (optional)** - numeryczne odcienie 100-900 + alpha a10-a75 | ||
|
|
||
| Brakuje warstwy **semantycznych aliasów**, która: | ||
| - Daje czytelne, samodokumentujące nazwy (`--sf-color-primary-xdark` zamiast `--sf-color-primary-900`) | ||
| - Pozwala na globalne remapowanie jednym nadpisaniem (zmiana `xdark` z 950 na 800 zmienia całą stronę) | ||
| - Oddziela intencję od implementacji | ||
|
|
||
| --- | ||
|
|
||
| ## Decyzja 1: Rozszerzenie palety numerycznej | ||
|
|
||
| **Obecna skala**: 100, 200, 300, 400, 600, 700, 800, 900 (8 kroków, brak 500/50/950) | ||
|
|
||
| **Nowa skala**: 50, 100, 200, 300, 400, **500**, 600, 700, 800, 900, 950 (11 kroków) | ||
|
|
||
| - `500` = alias do `var(--sf-color-primary)` (base kolor) | ||
| - `50` = najjaśniejszy (prawie biały z nutą koloru) | ||
| - `950` = najciemniejszy (prawie czarny z nutą koloru) | ||
| - Model zgodny z Tailwind (de facto standard w branży) | ||
|
|
||
| **Dotyczy**: 6 brand colors (primary, secondary, tertiary, action, neutral, base) | ||
|
|
||
| --- | ||
|
|
||
| ## Decyzja 2: Rozszerzenie skali alfa | ||
|
|
||
| **Obecna skala**: a10, a20, a30, a50, a75 (5 kroków, niesymetryczna) | ||
|
|
||
| **Nowa skala**: a5, a10, a20, a30, a40, a50, a60, a70, a80, a90, a95 (11 kroków) | ||
|
|
||
| - Symetryczna z zagęszczeniem na krańcach (a5 i a95) | ||
| - Środek co 10pp | ||
| - a5 = subtelne tła, hovers | ||
| - a95 = prawie opaque, przydatne dla overlays | ||
| - Pełne 100% nie jest potrzebne - to jest sam base kolor | ||
|
|
||
| **Dotyczy**: 6 brand colors | ||
|
|
||
| --- | ||
|
|
||
| ## Decyzja 3: Aliasy semantyczne odcieniowe (6 per brand color) | ||
|
|
||
| ``` | ||
| --sf-color-{color}-superlight → 50 | ||
| --sf-color-{color}-xlight → 200 | ||
| --sf-color-{color}-lighter → 400 | ||
| [base = 500 = --sf-color-{color}] | ||
| --sf-color-{color}-darker → 600 | ||
| --sf-color-{color}-xdark → 800 | ||
| --sf-color-{color}-superdark → 950 | ||
| ``` | ||
|
|
||
| **Logika nazewnicza**: | ||
| - 3 stopnie po jasnej stronie: `superlight` > `xlight` > `lighter` | ||
| - 3 stopnie po ciemnej stronie: `darker` > `xdark` > `superdark` | ||
| - Forma comparative (`-er`) = najbliżej base | ||
| - Prefix `x-` = dalej od base | ||
| - Prefix `super-` = ekstrema | ||
| - Symetria jest natychmiast czytelna | ||
|
|
||
| **Dlaczego nie `-light`/`-dark`**: zajęte przez source tokens (`--sf-color-primary-light` = wartość dla light mode). Suffix `-er` eliminuje kolizję i jednocześnie sugeruje bliskość do base. | ||
|
|
||
| **Dotyczy**: 6 brand colors (primary, secondary, tertiary, action, neutral, base) | ||
|
|
||
| --- | ||
|
|
||
| ## Decyzja 4: Aliasy funkcjonalne (per brand color) | ||
|
|
||
| ``` | ||
| --sf-color-{color}-hover → var(--sf-color-{color}-darker) | ||
| --sf-color-{color}-active → var(--sf-color-{color}-xdark) | ||
| --sf-color-{color}-subtle → var(--sf-color-{color}-a10) | ||
| --sf-color-{color}-muted → var(--sf-color-{color}-a30) | ||
| --sf-color-{color}-ghost → var(--sf-color-{color}-a5) | ||
| ``` | ||
|
|
||
| - Opisują intencję, nie wygląd | ||
| - Wskazują na inne aliasy (nie bezpośrednio na numerykę) - chain of aliases, jedno nadpisanie propaguje | ||
| - `hover`/`active` = interakcje | ||
| - `subtle`/`muted`/`ghost` = transparentne warianty od ledwo widocznego do delikatnego | ||
|
|
||
| --- | ||
|
|
||
| ## Decyzja 5: Kolory statusowe - mini-paleta | ||
|
|
||
| Kolory statusowe (success, warning, error, info, danger) **nie potrzebują pełnej skali 50-950**. Dostają mini-paletę 3 aliasów: | ||
|
|
||
| ``` | ||
| --sf-color-{status}-subtle → tło (alpha ~10%) | ||
| --sf-color-{status}-muted → border/soft bg (alpha ~30%) | ||
| --sf-color-{status}-strong → emphasis/tekst (shade ~700) | ||
| ``` | ||
|
|
||
| **Uzasadnienie**: kolory statusowe mają wąskie zastosowanie (alerty, badge'e, walidacja). Pełna paleta byłaby overengineering. Te 3 aliasy pokrywają 95% use cases: tło alertu, border alertu, tekst/ikona alertu. | ||
|
|
||
| **Uwaga**: core/tokens.css już definiuje `--sf-status-{x}-bg/text/border` - nowe aliasy mogą być albo ich uzupełnieniem, albo zastąpieniem. Do decyzji przy implementacji. | ||
|
|
||
| --- | ||
|
|
||
| ## Decyzja 6: Lokalizacja w pliku | ||
|
|
||
| Wszystko trafia do istniejącego `optional/tokens.palette.css`: | ||
| - Rozszerzona paleta numeryczna (50, 500, 950 dodane) | ||
| - Rozszerzona alfa (11 kroków) | ||
| - Aliasy semantyczne odcieniowe | ||
| - Aliasy funkcjonalne | ||
| - Mini-paleta statusowa | ||
|
|
||
| Jeden plik, jedna warstwa (`slashed.tokens`), opcjonalny import. | ||
|
|
||
| --- | ||
|
|
||
| ## Decyzja 7: Mechanizm remapowania | ||
|
|
||
| Aliasy odcieniowe wskazują na paletę numeryczną via `var()`: | ||
| ```css | ||
| --sf-color-primary-xdark: var(--sf-color-primary-800); | ||
| ``` | ||
|
|
||
| Aliasy funkcjonalne wskazują na aliasy odcieniowe via `var()`: | ||
| ```css | ||
| --sf-color-primary-hover: var(--sf-color-primary-darker); | ||
| ``` | ||
|
|
||
| Użytkownik nadpisuje w swoim CSS: | ||
| ```css | ||
| :root { | ||
| --sf-color-primary-xdark: var(--sf-color-primary-700); /* jaśniejszy xdark */ | ||
| --sf-color-primary-hover: var(--sf-color-primary-xdark); /* hover = xdark */ | ||
| } | ||
| ``` | ||
|
|
||
| Jedno nadpisanie propaguje do wszystkich miejsc używających aliasu. | ||
|
|
||
| --- | ||
|
|
||
| ## Podsumowanie ilościowe | ||
|
|
||
| Per brand color (6 kolorów): | ||
| - 11 tokenów numerycznych (50-950) | ||
| - 11 tokenów alfa (a5-a95) | ||
| - 6 aliasów odcieniowych | ||
| - 5 aliasów funkcjonalnych | ||
|
|
||
| **Łącznie brand**: 6 x 33 = **198 tokenów** | ||
|
|
||
| Per status color (5 kolorów): | ||
| - 3 aliasy | ||
|
|
||
| **Łącznie status**: 5 x 3 = **15 tokenów** | ||
|
|
||
| **Razem**: ~213 tokenów w `tokens.palette.css` | ||
|
|
||
| --- | ||
|
|
||
| ## Wzorce z branży użyte jako inspiracja | ||
|
|
||
| | System | Co wzięliśmy | | ||
| |---|---| | ||
| | Automatic.CSS | Koncepcja aliasów remapowanych (`ultra-dark` etc.) | | ||
| | Radix Colors | Każdy stopień palety ma zdefiniowany cel użytkowy | | ||
| | Tailwind | Skala 50-950, de facto standard numeryczny | | ||
| | Material Design 3 | Role-based tokens (functional aliases) | | ||
| | W3C Design Tokens spec | Alias token = referencja do innego tokena | | ||
|
|
||
| --- | ||
|
|
||
| ## Otwarte pytania do weryfikacji | ||
|
|
||
| 1. **Czy aliasy funkcjonalne (`hover`, `active`) nie duplikują logiki z `core/tokens.css`?** - Tam są `--sf-color-bg--hover` (generyczne), tu byłyby `--sf-color-primary-hover` (per kolor). Inne scope, ale warto potwierdzić brak konfuzji. | ||
| 2. **Relacja `--sf-color-{status}-subtle/muted/strong` vs istniejące `--sf-status-{x}-bg/text/border`** - zastępujemy, aliasujemy, czy współistnieją? | ||
| 3. **Czy `500` alias powinien być literalnie `var(--sf-color-primary)` czy `color-mix(in oklch, var(--sf-color-primary) 100%, transparent)`** - dla spójności z resztą palety (wszystko jest color-mix)? | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add fence languages to code blocks to satisfy markdown linting.
Line 50, Line 76, and Line 95 use fenced blocks without a language, which triggers MD040 and can fail doc CI in stricter setups. Please annotate them (e.g.,
css).Also applies to: 76-82, 95-99
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 50-50: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents