From 9f1dd4ae9b11a1b1c1fb931aa8c58a35e1003545 Mon Sep 17 00:00:00 2001 From: Charles de Dreuille Date: Wed, 27 May 2026 13:14:30 +0200 Subject: [PATCH] docs(ui): expand neutral background migration notes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- .changeset/ui-semantic-color-tokens.md | 12 +++++++++--- .../docs/rules/no-deprecated-bui-tokens.md | 14 +++++++++++--- 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/.changeset/ui-semantic-color-tokens.md b/.changeset/ui-semantic-color-tokens.md index 41dc2de160..c7ebad471a 100644 --- a/.changeset/ui-semantic-color-tokens.md +++ b/.changeset/ui-semantic-color-tokens.md @@ -10,9 +10,15 @@ The previous tokens remain in place for backward compatibility but are now depre **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` | **Foreground** diff --git a/packages/eslint-plugin/docs/rules/no-deprecated-bui-tokens.md b/packages/eslint-plugin/docs/rules/no-deprecated-bui-tokens.md index c31617c333..ab2b3e9578 100644 --- a/packages/eslint-plugin/docs/rules/no-deprecated-bui-tokens.md +++ b/packages/eslint-plugin/docs/rules/no-deprecated-bui-tokens.md @@ -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