docs(ui): expand neutral background migration notes

Add full shift mapping (old --bui-bg-neutral-1..4 → new --bui-bg-neutral-2..5)
to the changeset, ESLint rule docs, and PR description so adopters
understand the complete renaming of the neutral background scale.

Signed-off-by: Charles de Dreuille <charles.dedreuille@gmail.com>
This commit is contained in:
Charles de Dreuille
2026-05-27 13:14:30 +02:00
parent 657aad6cf0
commit 9f1dd4ae9b
2 changed files with 20 additions and 6 deletions
@@ -40,9 +40,17 @@ Replace deprecated tokens with their equivalents from the new semantic families.
### Neutral backgrounds
| Deprecated | Replacement |
| -------------- | -------------------- |
| `--bui-bg-app` | `--bui-bg-neutral-1` |
The neutral background scale has been renamed and extended. `--bui-bg-app` is replaced by the new `--bui-bg-neutral-1`, and the old overlay-based `--bui-bg-neutral-1..4` shift up by one to become `--bui-bg-neutral-2..5`:
| Deprecated | Replacement |
| ---------------------------------- | -------------------- |
| `--bui-bg-app` | `--bui-bg-neutral-1` |
| `--bui-bg-neutral-1` (old overlay) | `--bui-bg-neutral-2` |
| `--bui-bg-neutral-2` (old overlay) | `--bui-bg-neutral-3` |
| `--bui-bg-neutral-3` (old overlay) | `--bui-bg-neutral-4` |
| `--bui-bg-neutral-4` (old overlay) | `--bui-bg-neutral-5` |
> Note: the old `--bui-bg-neutral-1..4` names are now reused for the new solid-color tokens, so this rule does not warn on them directly. The `-hover`, `-pressed`, and `-disabled` variants of those tokens remain deprecated.
### Foreground