@micha.bigler/ui-core-micha 2.33.0 → 2.33.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/WORK_ORDERS.md +4 -1
- package/dev/entries.jsx +29 -7
- package/dist/components/MobileBottomNav.js +20 -10
- package/dist/theme/createAppTheme.js +0 -1
- package/dist/theme/themeCompleteness.js +1 -4
- package/dist/theme/tokens.js +2 -3
- package/package.json +1 -1
- package/src/components/MobileBottomNav.jsx +22 -8
- package/src/theme/createAppTheme.js +0 -1
- package/src/theme/themeCompleteness.js +1 -4
- package/src/theme/tokens.js +2 -3
- package/tests/MobileBottomNav.test.jsx +101 -2
- package/tests/createAppTheme.test.js +8 -3
- package/tests/themeCompleteness.test.js +45 -5
- package/work-orders/SHELL-4.md +351 -0
- package/work-orders/THEME-3.md +210 -0
- package/work-orders/THEME-4.md +185 -0
|
@@ -0,0 +1,351 @@
|
|
|
1
|
+
# SHELL-4 — Give each bottom-nav property exactly one home
|
|
2
|
+
|
|
3
|
+
**Target repo:** `ui-core-micha` (branch `main` — this repo has no `develop`)
|
|
4
|
+
**Tier:** 3 (shared core)
|
|
5
|
+
**Review:** independent `reviewer` **and** `ui_reviewer` — spawned concurrently, both mandatory before commit
|
|
6
|
+
**Version target:** `2.33.1` — patch. See "Why patch" below.
|
|
7
|
+
**Precondition of:** `jg-ferien/NAV-36`, which is `blocked` on this
|
|
8
|
+
**Follows:** `SHELL-3` (`2.33.0`) and its fix `586ac9c`
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## A. Envelope
|
|
13
|
+
|
|
14
|
+
### Goal
|
|
15
|
+
|
|
16
|
+
`SHELL-3` shipped `MobileBottomNav` with **all** visible styling in the theme layer and only
|
|
17
|
+
position, `zIndex` and safe-area padding in the component. For an app that has adopted
|
|
18
|
+
`createAppTheme` that is correct and renders as specified. For an app that has **not**, the bar
|
|
19
|
+
arrives structurally broken — and jg-ferien, the migration consumer the promotion exists for, is
|
|
20
|
+
exactly that app.
|
|
21
|
+
|
|
22
|
+
Fix the layer split so the component works on any theme, without reintroducing the shadowing bug
|
|
23
|
+
that `586ac9c` removed.
|
|
24
|
+
|
|
25
|
+
### How this happened, because the reasoning matters more than the diff
|
|
26
|
+
|
|
27
|
+
`SHELL-3`'s `ui_reviewer` found the component duplicating `borderTop` and `borderColor` inline in
|
|
28
|
+
`sx` — the same properties the same work order had just registered as theme defaults. Inline `sx`
|
|
29
|
+
beats `styleOverrides`, so the new defaults were inert. The fix removed the component's copies.
|
|
30
|
+
|
|
31
|
+
**That resolved the duplication by deleting the wrong copy.** The defect was the *duplication*, not
|
|
32
|
+
the *location*. For a property a component needs in order to function on an arbitrary theme, the
|
|
33
|
+
component is the correct home — and the fix moved exactly those into a layer that only baseline apps
|
|
34
|
+
have.
|
|
35
|
+
|
|
36
|
+
### What a non-baseline consumer loses today
|
|
37
|
+
|
|
38
|
+
Read against MUI's installed source, not assumed. Every item below currently lives **only** in the
|
|
39
|
+
baseline theme:
|
|
40
|
+
|
|
41
|
+
| Property | MUI's default | Consequence |
|
|
42
|
+
|---|---|---|
|
|
43
|
+
| `MuiBottomNavigationAction` `minWidth: 0` | **`minWidth: 80`** | **layout break** — see below |
|
|
44
|
+
| `maxWidth: 'none'` | `maxWidth: 168` | actions cannot fill a wide bar |
|
|
45
|
+
| `MuiBottomNavigation` `borderTop: '1px solid'` | MUI sets **no border** | the bar has no top edge |
|
|
46
|
+
| `borderColor: palette.divider` | — | same |
|
|
47
|
+
| label `fontSize: '12px'` + the `&.Mui-selected` pin | `12px`, **`14px` when selected** | the label jumps on tap |
|
|
48
|
+
| label `fontWeight: 500` | unset | thinner |
|
|
49
|
+
| label `lineHeight: 1.2` | unset | taller label row |
|
|
50
|
+
| action `padding: '0 2px'`, `gap: '2px'` | MUI's own | looser density |
|
|
51
|
+
| icon `22px` | MUI's `24px` | slightly larger icons |
|
|
52
|
+
|
|
53
|
+
`backgroundColor` and the action/selected colours are **not** losses — MUI sets equivalents itself.
|
|
54
|
+
|
|
55
|
+
**The first row is not cosmetic.** jg has five destinations: `5 × 80 = 400px` against a 375 px
|
|
56
|
+
viewport, and `min-width` overrides `flex-shrink`, so the container overflows. jg's current code sets
|
|
57
|
+
`minWidth: 0` explicitly for exactly this reason. **Computed from MUI's source, not rendered** —
|
|
58
|
+
confirm it in the rendered check rather than trusting the arithmetic.
|
|
59
|
+
|
|
60
|
+
### The rule to apply
|
|
61
|
+
|
|
62
|
+
**Each property gets exactly one home, chosen by who needs it:**
|
|
63
|
+
|
|
64
|
+
- **The component owns what keeps it functional on any theme.** These are deliberately *not*
|
|
65
|
+
theme-overridable, and that is a feature: overriding them breaks the bar.
|
|
66
|
+
- **The theme owns what makes it look like this estate.** These stay overridable per app, which is
|
|
67
|
+
what makes the component design-agnostic.
|
|
68
|
+
|
|
69
|
+
**And the distinction that was missed the first time:** a **token reference** in the component's `sx`
|
|
70
|
+
(`borderColor: 'divider'`) is not the same thing as a hex literal and not the same thing as a
|
|
71
|
+
duplicate. It resolves against *whatever* theme is mounted — every app still gets its own divider
|
|
72
|
+
colour — while a duplicate of a theme default silently shadows it. Reference without duplication is
|
|
73
|
+
the correct pattern; "contains no hex values" is the wrong test for it.
|
|
74
|
+
|
|
75
|
+
### Scope
|
|
76
|
+
|
|
77
|
+
**Move into the component, and delete from `tokens.js`:**
|
|
78
|
+
|
|
79
|
+
- `MuiBottomNavigationAction`: `minWidth: 0`, `maxWidth: 'none'`
|
|
80
|
+
- `MuiBottomNavigation`: `borderTop: '1px solid'`, and `borderColor: 'divider'` as an `sx` token
|
|
81
|
+
reference (delete `borderColor: palette.divider` from `createAppTheme.js`'s palette-aware block)
|
|
82
|
+
|
|
83
|
+
**Leave in the theme, unchanged:** the label `fontSize` / `fontWeight` / `lineHeight` and its
|
|
84
|
+
selected pin, the action and selected `color`, `backgroundColor`, `boxShadow: 'none'`, `padding`,
|
|
85
|
+
`gap`, and the icon size. A bar with MUI's density and 24 px icons still works; a bar with
|
|
86
|
+
`minWidth: 80` does not.
|
|
87
|
+
|
|
88
|
+
**Deregister the four moved surfaces** from `themeCompleteness.js`:
|
|
89
|
+
`components.MuiBottomNavigation.styleOverrides.root.borderTop`, `…root.borderColor`,
|
|
90
|
+
`components.MuiBottomNavigationAction.styleOverrides.root.minWidth`, `…root.maxWidth`. Six of the ten
|
|
91
|
+
`SHELL-3` surfaces remain. **This cannot turn any app red**: the assertion validates that each
|
|
92
|
+
declared exemption names a surface and a reason, and then ignores exemptions that match no
|
|
93
|
+
registered surface — verified in `themeCompleteness.js`, not assumed.
|
|
94
|
+
|
|
95
|
+
**Add an `sx` prop to the component**, merged **after** its own defaults. This is the honest
|
|
96
|
+
mitigation for the properties that just became theme-unoverridable: a call site that genuinely needs
|
|
97
|
+
a different edge can still get one, without the theme layer being the escape route.
|
|
98
|
+
|
|
99
|
+
### Non-goals / do not touch
|
|
100
|
+
|
|
101
|
+
- **No new props beyond `sx`.** `destinations`, `activeRoute`, `onNavigate`, `hideAbove`, `zIndex`
|
|
102
|
+
and the destination field shape stay exactly as `SHELL-3` shipped them.
|
|
103
|
+
- **No visual change for baseline apps.** The values are identical; only their layer moves. If a
|
|
104
|
+
baseline app renders differently, that is a defect in this WO.
|
|
105
|
+
- No other component, no other baseline token, no palette or typography change.
|
|
106
|
+
- No change to `emphasis`, `badgeCount`, `shortLabel` semantics.
|
|
107
|
+
- No migration of jg-ferien — that stays `NAV-36`.
|
|
108
|
+
|
|
109
|
+
### Risks
|
|
110
|
+
|
|
111
|
+
- **Reintroducing the shadow.** The whole point is that a property lives in one layer. Deleting from
|
|
112
|
+
`tokens.js` and adding to the component must happen together; doing half leaves either a shadow or
|
|
113
|
+
a gap. The test below makes this checkable rather than a matter of care.
|
|
114
|
+
- **No staging net.** A version bump on `main` publishes to npm; the independent review is the only
|
|
115
|
+
gate and cannot be back-filled.
|
|
116
|
+
- **A property moved into `sx` is no longer theme-configurable**, which is a real capability
|
|
117
|
+
reduction for the four moved properties. Accepted deliberately: three of the four break the
|
|
118
|
+
component when changed, and the `sx` prop covers the fourth.
|
|
119
|
+
|
|
120
|
+
### Why patch, not minor
|
|
121
|
+
|
|
122
|
+
No new capability: this relocates existing values and adds one escape-hatch prop. Baseline apps
|
|
123
|
+
render byte-identically. The narrowed assertion contract asks adopting apps for **less**, not more.
|
|
124
|
+
Per the estate's rule that a version bump follows scope rather than novelty, that is a patch.
|
|
125
|
+
|
|
126
|
+
The one argument for minor — a capability reduction, since four properties stop being
|
|
127
|
+
theme-overridable — is noted and rejected: `MobileBottomNav` is one release old with **no** consumer
|
|
128
|
+
yet on any published version, so no app can be relying on that override path.
|
|
129
|
+
|
|
130
|
+
### Required tests to WRITE
|
|
131
|
+
|
|
132
|
+
Extend `tests/MobileBottomNav.test.jsx` and `tests/themeCompleteness.test.js`.
|
|
133
|
+
|
|
134
|
+
1. **The non-baseline case, which is the whole point.** Render under a plain `createTheme()` and
|
|
135
|
+
assert the bar has a top border and its actions resolve `minWidth: 0` — the two failures that
|
|
136
|
+
block `NAV-36`. Prove non-vacuity: this test must fail against `2.33.0`'s arrangement.
|
|
137
|
+
2. **No property lives in two layers.** Assert the intersection of the component's own `sx` keys and
|
|
138
|
+
the baseline's `MuiBottomNavigation` / `MuiBottomNavigationAction` `styleOverrides` keys is
|
|
139
|
+
**empty**. This is the mechanical guard for the regression class `SHELL-3` hit, and it is the
|
|
140
|
+
reason to prefer it over a reviewer noticing.
|
|
141
|
+
3. `sx` passed by the caller wins over the component's own defaults.
|
|
142
|
+
4. Baseline rendering is unchanged: the same assertions `SHELL-3`'s spec makes about a
|
|
143
|
+
`createAppTheme` theme still hold, including test 5b's cross-theme colour resolution.
|
|
144
|
+
5. `assertThemeComplete(createAppTheme({ palette: { primary: { main: '#0F62FE' } } })).findings`
|
|
145
|
+
stays `[]` with six surfaces registered instead of ten.
|
|
146
|
+
6. An exemption naming one of the four deregistered surfaces produces **no** finding — the
|
|
147
|
+
forward-compatibility claim above, asserted rather than trusted.
|
|
148
|
+
|
|
149
|
+
Plus `tsc -p tsconfig.build.json --noEmit` clean. **No full-suite run** — the affected set is those
|
|
150
|
+
two specs plus `tests/createAppTheme.test.js`.
|
|
151
|
+
|
|
152
|
+
### Verification
|
|
153
|
+
|
|
154
|
+
The rendered two-width side-by-side per `DS-1`. `SHELL-3` added a bottom-nav specimen to
|
|
155
|
+
`dev/entries.jsx`; extend it with **a second instance mounted under a plain `createTheme` theme**
|
|
156
|
+
side by side with the baseline one. That comparison is the actual deliverable of this WO made
|
|
157
|
+
visible: both bars must have an edge and evenly divided actions, and they may legitimately differ in
|
|
158
|
+
label size and density.
|
|
159
|
+
|
|
160
|
+
State in the register note whether real screenshots were obtained or DOM inspection substituted.
|
|
161
|
+
`SHELL-3`'s session could not composite frames and fell back to computed-style inspection — if that
|
|
162
|
+
recurs, the computed `min-width` and `border-top-width` on the plain-theme instance are the two
|
|
163
|
+
values that carry this WO's claim.
|
|
164
|
+
|
|
165
|
+
### Parity guardrail
|
|
166
|
+
|
|
167
|
+
Byte-identical rendering for baseline apps. The only intended change is that a non-baseline
|
|
168
|
+
consumer's bar gains its edge and its evenly divided actions.
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
## B. Implementation map
|
|
173
|
+
|
|
174
|
+
*Filled by the Orchestrator on `git pull` — see `AGENTS.md` → "Work Order".*
|
|
175
|
+
|
|
176
|
+
### Execution directive (read this first)
|
|
177
|
+
|
|
178
|
+
> **If you are the implementer reading this work order as your own specification: this section is
|
|
179
|
+
> NOT addressed to you.** It tells the Orchestrator how to invoke you. **You ARE that invocation —
|
|
180
|
+
> do NOT shell out to `codex exec`.**
|
|
181
|
+
>
|
|
182
|
+
> Implement through `codex exec` in the background — invoked directly via Bash (never the
|
|
183
|
+
> `debugger`/`*_coder` Agent wrappers) with BOTH flags `--skip-git-repo-check` and
|
|
184
|
+
> `--dangerously-bypass-approvals-and-sandbox`. **Pass the WO via stdin, not as a positional
|
|
185
|
+
> argument** (a positional arg hits Windows' command-line length limit — proven repeatedly in this
|
|
186
|
+
> repo). Fallback to direct Claude implementation only on Codex quota/rate-limit/non-zero exit —
|
|
187
|
+
> and note that the fallback flips authorship, so both reviewers stay mandatory either way.
|
|
188
|
+
>
|
|
189
|
+
> **`SHELL-3` note for the Orchestrator:** on that WO Codex committed its own change and marked the
|
|
190
|
+
> register row `done` with a self-reported review. That is a breach (`AGENTS.md`: author ≠ reviewer,
|
|
191
|
+
> a spawned implementer never commits). Read `git log origin/main..HEAD` before your own review and
|
|
192
|
+
> treat any implementer commit as a blocker to surface, not something to build on.
|
|
193
|
+
|
|
194
|
+
### Context package
|
|
195
|
+
|
|
196
|
+
**Note on the Envelope's "ten to six" arithmetic:** the actually-landed `SHELL-3` surface count in
|
|
197
|
+
`themeCompleteness.js` is **twenty**, not ten (SHELL-3's own scope grew mid-implementation to cover
|
|
198
|
+
icon size/padding/gap/label truncation, beyond the ten originally sketched). This does not change
|
|
199
|
+
the instruction — deregister exactly the four surfaces named below, no more, no less — but do not
|
|
200
|
+
be thrown by the stale count in the prose above.
|
|
201
|
+
|
|
202
|
+
**Files to change, with current line numbers (verified against the landed `SHELL-3` + `586ac9c`
|
|
203
|
+
state, may drift slightly if Codex edits top-to-bottom — re-grep `MuiBottomNavigation` if a line
|
|
204
|
+
number is off by a few):**
|
|
205
|
+
|
|
206
|
+
1. **`src/theme/tokens.js:309-334`** — the current `BASELINE_STATIC.components` entries:
|
|
207
|
+
```js
|
|
208
|
+
MuiBottomNavigation: {
|
|
209
|
+
styleOverrides: {
|
|
210
|
+
root: { borderTop: '1px solid', boxShadow: 'none' },
|
|
211
|
+
},
|
|
212
|
+
},
|
|
213
|
+
MuiBottomNavigationAction: {
|
|
214
|
+
styleOverrides: {
|
|
215
|
+
root: {
|
|
216
|
+
minWidth: 0,
|
|
217
|
+
maxWidth: 'none',
|
|
218
|
+
padding: '0 2px',
|
|
219
|
+
gap: '2px',
|
|
220
|
+
'& .MuiSvgIcon-root': { width: '22px', height: '22px' },
|
|
221
|
+
},
|
|
222
|
+
label: { /* fontSize/fontWeight/lineHeight/... unchanged, leave as-is */ },
|
|
223
|
+
},
|
|
224
|
+
},
|
|
225
|
+
```
|
|
226
|
+
Remove `borderTop: '1px solid'` from `MuiBottomNavigation.styleOverrides.root` (keep
|
|
227
|
+
`boxShadow: 'none'` — it stays per the Envelope's "leave in the theme" list). Remove
|
|
228
|
+
`minWidth: 0, maxWidth: 'none'` from `MuiBottomNavigationAction.styleOverrides.root` (keep
|
|
229
|
+
`padding`, `gap`, the icon-size entry, and the entire `label` block unchanged).
|
|
230
|
+
|
|
231
|
+
2. **`src/theme/createAppTheme.js:119-134`** — the current `createPaletteAwareComponents()` entries:
|
|
232
|
+
```js
|
|
233
|
+
MuiBottomNavigation: {
|
|
234
|
+
styleOverrides: {
|
|
235
|
+
root: {
|
|
236
|
+
backgroundColor: palette.background.paper,
|
|
237
|
+
borderColor: palette.divider,
|
|
238
|
+
},
|
|
239
|
+
},
|
|
240
|
+
},
|
|
241
|
+
MuiBottomNavigationAction: {
|
|
242
|
+
styleOverrides: {
|
|
243
|
+
root: {
|
|
244
|
+
color: palette.text.secondary,
|
|
245
|
+
'&.Mui-selected': { color: palette.primary.main },
|
|
246
|
+
},
|
|
247
|
+
},
|
|
248
|
+
},
|
|
249
|
+
```
|
|
250
|
+
Remove `borderColor: palette.divider` (keep `backgroundColor: palette.background.paper` — not a
|
|
251
|
+
loss per the Envelope's own table, MUI sets an equivalent). `MuiBottomNavigationAction` here is
|
|
252
|
+
untouched — `color`/`.Mui-selected` stay exactly as-is.
|
|
253
|
+
|
|
254
|
+
3. **`src/theme/themeCompleteness.js:99-118`** (`COMPONENT_SURFACES` array) — delete exactly these
|
|
255
|
+
four lines:
|
|
256
|
+
```js
|
|
257
|
+
componentPath('MuiBottomNavigation', 'styleOverrides.root.borderTop'),
|
|
258
|
+
componentPath('MuiBottomNavigation', 'styleOverrides.root.borderColor'),
|
|
259
|
+
componentPath('MuiBottomNavigationAction', 'styleOverrides.root.minWidth'),
|
|
260
|
+
componentPath('MuiBottomNavigationAction', 'styleOverrides.root.maxWidth'),
|
|
261
|
+
```
|
|
262
|
+
Leave every other `MuiBottomNavigation`/`MuiBottomNavigationAction` line untouched (boxShadow,
|
|
263
|
+
backgroundColor, padding, gap, icon width/height, color, all label surfaces, both `.Mui-selected`
|
|
264
|
+
pins).
|
|
265
|
+
|
|
266
|
+
4. **`src/components/MobileBottomNav.jsx`** (current full file, 69 lines, reproduced above in this
|
|
267
|
+
session) — add a `sx` prop (default `{}`), and merge these four properties into the root
|
|
268
|
+
`BottomNavigation`'s `sx`, with the caller's `sx` applied **last** so it wins:
|
|
269
|
+
```js
|
|
270
|
+
export function MobileBottomNav({
|
|
271
|
+
destinations,
|
|
272
|
+
activeRoute,
|
|
273
|
+
onNavigate,
|
|
274
|
+
hideAbove = 'md',
|
|
275
|
+
zIndex = defaultZIndex,
|
|
276
|
+
sx,
|
|
277
|
+
}) {
|
|
278
|
+
...
|
|
279
|
+
<BottomNavigation
|
|
280
|
+
...
|
|
281
|
+
sx={{
|
|
282
|
+
position: 'fixed',
|
|
283
|
+
left: 0,
|
|
284
|
+
right: 0,
|
|
285
|
+
bottom: 0,
|
|
286
|
+
zIndex,
|
|
287
|
+
borderTop: '1px solid',
|
|
288
|
+
borderColor: 'divider',
|
|
289
|
+
paddingBottom: 'env(safe-area-inset-bottom)',
|
|
290
|
+
...sx,
|
|
291
|
+
}}
|
|
292
|
+
>
|
|
293
|
+
```
|
|
294
|
+
`borderColor: 'divider'` here is a **string token reference** (MUI resolves `'divider'` against
|
|
295
|
+
`theme.palette.divider` at render time on whatever theme is mounted) — this is NOT the same
|
|
296
|
+
pattern as the `586ac9c` regression, which duplicated an already-*resolved* hex-bearing default.
|
|
297
|
+
The `BottomNavigationAction`'s own `sx` (not the top-level prop) needs `minWidth: 0,
|
|
298
|
+
maxWidth: 'none'` added directly — these are per-action, not per-bar, so they do NOT go through
|
|
299
|
+
the new `sx` prop. Today the `emphasis` styling sits on the inner `<Icon sx={...}>`, not on
|
|
300
|
+
`<BottomNavigationAction>` itself — leave that untouched, and simply add a new
|
|
301
|
+
`sx={{ minWidth: 0, maxWidth: 'none' }}` prop directly on the `<BottomNavigationAction>` element,
|
|
302
|
+
independent of the `icon` prop's own conditional emphasis styling.
|
|
303
|
+
|
|
304
|
+
5. **`tests/MobileBottomNav.test.jsx`** — extend with the six numbered tests from the Envelope.
|
|
305
|
+
Test 2 (no property in two layers) should import `BASELINE_STATIC` (or the theme object) and the
|
|
306
|
+
component's rendered/declared `sx` keys and assert
|
|
307
|
+
`intersection(Object.keys(componentSxDefaults), Object.keys(theme.components.MuiBottomNavigation
|
|
308
|
+
.styleOverrides.root)).length === 0` — read the existing test file's structure first
|
|
309
|
+
(`createAppTheme`/`createTheme` imports are already there from `SHELL-3`'s test 5b) and follow its
|
|
310
|
+
conventions rather than introducing a new test-setup style.
|
|
311
|
+
|
|
312
|
+
6. **`tests/themeCompleteness.test.js`** — the existing `SHELL-3` assertion (added at line ~19-40,
|
|
313
|
+
the `expect(bare.findings...).toEqual(expect.arrayContaining([...20 surfaces...]))` block) needs
|
|
314
|
+
its four now-deregistered entries removed from that array, plus the Envelope's test 5 (findings
|
|
315
|
+
stays `[]` with six surfaces) and test 6 (an exemption naming a deregistered surface produces no
|
|
316
|
+
finding — because `assertThemeComplete` ignores exemptions matching no registered surface, this
|
|
317
|
+
is provable without special-casing: declare an exemption for e.g.
|
|
318
|
+
`'components.MuiBottomNavigation.styleOverrides.root.borderTop'` against a theme built without
|
|
319
|
+
that surface and assert no finding names it, since the surface list itself no longer contains it).
|
|
320
|
+
|
|
321
|
+
7. **`dev/entries.jsx:69-94`** (`MobileBottomNavEntry`) — add a second `MobileBottomNav` instance
|
|
322
|
+
wrapped in its own `<ThemeProvider theme={createTheme()}>` (plain MUI, no `createAppTheme`),
|
|
323
|
+
rendered side-by-side with the existing baseline-themed one (which is already inside the harness's
|
|
324
|
+
own `createAppTheme` root — no need to wrap that one again). Import `ThemeProvider`, `createTheme`
|
|
325
|
+
from `@mui/material/styles` (createTheme is likely already imported elsewhere in this file — grep
|
|
326
|
+
first). Keep both bars visible at once (e.g. stacked in a `Stack`) so the two-width verification
|
|
327
|
+
can compare them directly: both need a visible top edge and evenly divided actions; they may
|
|
328
|
+
legitimately differ in label size/density.
|
|
329
|
+
|
|
330
|
+
**Invariants / do-not-touch:** no change to `destinations`/`activeRoute`/`onNavigate`/`hideAbove`/
|
|
331
|
+
`zIndex` prop semantics, `emphasis`/`badgeCount`/`shortLabel` behaviour, or any other baseline token.
|
|
332
|
+
No visual change for a `createAppTheme` consumer — the four relocated properties must render
|
|
333
|
+
byte-identically before and after.
|
|
334
|
+
|
|
335
|
+
**Pitfalls already known:**
|
|
336
|
+
- Deleting from `tokens.js`/`createAppTheme.js` and adding to the component must land in the SAME
|
|
337
|
+
commit/chunk — a partial move reintroduces either a gap (non-baseline still broken) or a shadow
|
|
338
|
+
(the exact `586ac9c` bug, just with the copies swapped).
|
|
339
|
+
- `boxShadow: 'none'` and `backgroundColor` are explicitly NOT part of this move — re-reading the
|
|
340
|
+
Envelope's table, only `borderTop`, `borderColor`, `minWidth`, `maxWidth` relocate.
|
|
341
|
+
- Version target is `2.33.1` (patch) — confirm `package.json` reads `2.33.1` after Codex is done, not
|
|
342
|
+
a minor bump.
|
|
343
|
+
- **Per `SHELL-3`'s own execution-directive note added to this WO: verify no implementer self-commit
|
|
344
|
+
happened before doing anything else** — `git log --oneline -3` should show the Orchestrator's own
|
|
345
|
+
`1106f51`-style "fill Implementation map" commit as the most recent, not a Codex-authored `feat(...)`
|
|
346
|
+
commit. If a self-commit is present, treat it as a breach per `AGENTS.md`, not as a base to build on.
|
|
347
|
+
|
|
348
|
+
### Mini-handover
|
|
349
|
+
|
|
350
|
+
Repo: `ui-core-micha` (`C:\Users\biglmi\Documents\webapps\ui-core-micha`), branch `main`.
|
|
351
|
+
WO: `work-orders/SHELL-4.md`. Follow `orchestrate-codex`.
|
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
# THEME-3 — Add the missing "subtle surface" baseline token
|
|
2
|
+
|
|
3
|
+
**Target repo:** `ui-core-micha` (branch `main` — this repo has no `develop`; a push touching
|
|
4
|
+
`src/**`/`package.json` publishes to npm immediately via `publish.yml`)
|
|
5
|
+
**Tier:** 3 — shared-core theme baseline, consumed by every `createAppTheme` adopter.
|
|
6
|
+
**Review:** independent `reviewer` **and** `ui_reviewer`, concurrently, both mandatory before commit
|
|
7
|
+
(no staging net in this repo — the independent review is the only gate and is not back-fillable).
|
|
8
|
+
**Found by:** `cockpit/UI-6` (adopting `createAppTheme` with the frozen `UI-4` token table). The
|
|
9
|
+
sheet's canonical token table (section 8, "what cockpit stops owning") lists an *inset surface*
|
|
10
|
+
`#F4F5F6` as a baseline-supplied value, replacing `cockpit.surface2` (16 of 195 token reads in that
|
|
11
|
+
WO). It does not exist anywhere in the shipped package — confirmed by grepping
|
|
12
|
+
`src/theme/tokens.js`/`themeCompleteness.js` for the hex and for any "surface"/"inset" key. The value
|
|
13
|
+
was one of the design-language instrument's *own* internal comparison-stack entries
|
|
14
|
+
(`cockpit/work-orders/assets/UI-4-design-language.html:681`), never actually wired into
|
|
15
|
+
`createAppTheme`. Per this estate's own rule ("a gap in the shared kit discovered mid-adoption is a
|
|
16
|
+
`ui-core-micha` work order and cockpit's item waits — not a local workaround"), `UI-6` is blocked on
|
|
17
|
+
this landing and publishing first.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## A. Envelope
|
|
22
|
+
|
|
23
|
+
### Goal
|
|
24
|
+
|
|
25
|
+
Add a third baseline background tier — `palette.background.subtle` — to `createAppTheme`'s shared
|
|
26
|
+
palette, for panels/table stripes/excerpt boxes that need to read as slightly recessed from
|
|
27
|
+
`background.paper` without a bespoke per-app colour. Register it in the completeness-assertion
|
|
28
|
+
surface inventory so every adopter (present and future) gets the same guarantee the other baseline
|
|
29
|
+
surfaces already have.
|
|
30
|
+
|
|
31
|
+
### Scope
|
|
32
|
+
|
|
33
|
+
1. **`src/theme/tokens.js`** — add `background.subtle: '#F4F5F6'` to `BASELINE_PALETTE.background`
|
|
34
|
+
(alongside the existing `default`/`paper`). This is a **fixed baseline constant**, not
|
|
35
|
+
accent-derived — the same treatment as `default`/`paper`, not the accent-tint derivation used for
|
|
36
|
+
`cockpit.accentTint`.
|
|
37
|
+
2. **`src/theme/themeCompleteness.js`** — add `pathSurface('palette.background.subtle')` to
|
|
38
|
+
`THEME_COMPLETENESS_SURFACES`.
|
|
39
|
+
3. **Recompute the contrast claim independently** — the frozen sheet's "muted ink on it: 4.81" was
|
|
40
|
+
computed on the sheet's own static comparison canvas, not via this package's
|
|
41
|
+
`calculateContrastRatio`. Recompute `calculateContrastRatio('#5B6670', '#F4F5F6')` (baseline
|
|
42
|
+
`ink.secondary`, the tone most likely to sit on this surface) directly against the shipped
|
|
43
|
+
function before treating the sheet's number as confirmed.
|
|
44
|
+
4. Publish (version bump — see Risks for the semver call).
|
|
45
|
+
|
|
46
|
+
### Non-goals / do not touch
|
|
47
|
+
|
|
48
|
+
- Renaming or removing any existing palette token.
|
|
49
|
+
- `CHART-*`/`SHELL-*`/`AUTH-*` surfaces — unrelated to this addition.
|
|
50
|
+
- `fitness-monitor` or any other consuming app's own repo — this WO lands and publishes the token
|
|
51
|
+
only; `cockpit/UI-6` consumes it afterward, in its own repo, as a separate step.
|
|
52
|
+
- Any accent-derived tint/shade math — this token is a fixed baseline value, structurally unlike
|
|
53
|
+
`cockpit.accentTint`/`accentLight`/`accentDark`.
|
|
54
|
+
|
|
55
|
+
### Risks
|
|
56
|
+
|
|
57
|
+
- **`fitness-monitor` is a real, already-shipped adopter** (`frontend/src/theme.js` +
|
|
58
|
+
`frontend/src/theme.test.js`) that hard-asserts `assertThemeComplete(theme).findings` equals `[]`.
|
|
59
|
+
A new *required* completeness surface must resolve automatically for every adopter with zero
|
|
60
|
+
app-level action — the same guarantee `background.default`/`background.paper` already give,
|
|
61
|
+
**not** an opt-in the app must declare. Concretely: the new key must come from
|
|
62
|
+
`BASELINE_PALETTE` so every real `createAppTheme(...)` output has it defined, and MUI's own
|
|
63
|
+
default theme must never define `background.subtle` itself (a novel key — verify this, don't
|
|
64
|
+
assume it), so `descriptor.get(MUI_DEFAULT_THEME)` returns `undefined` and the "still equals MUI's
|
|
65
|
+
untouched default" branch never fires. If either assumption is wrong, `fitness-monitor`'s CI
|
|
66
|
+
breaks on its next pin bump and this WO must not ship that way.
|
|
67
|
+
- **Semver classification** — additive to the factory's *output* (no adopter passes anything new to
|
|
68
|
+
get it), which argues for a patch, mirroring `SHELL-4`'s "narrows the contract, cannot turn
|
|
69
|
+
cockpit red" precedent in the opposite direction (widens the contract, but resolves automatically,
|
|
70
|
+
so it also cannot turn an adopter red). Confirm no adopter needs a code change before treating
|
|
71
|
+
this as settled rather than asserting it.
|
|
72
|
+
- **Do not silently rename cockpit's `surface2` in this repo** — this WO adds the baseline token;
|
|
73
|
+
cockpit's own re-point of 16 call sites from `cockpit.surface2` to the new baseline token is
|
|
74
|
+
`UI-6`'s job, in cockpit's repo, not this one's.
|
|
75
|
+
|
|
76
|
+
### Required tests to WRITE
|
|
77
|
+
|
|
78
|
+
1. `assertThemeComplete` stays empty-findings for a minimal adopter call —
|
|
79
|
+
`createAppTheme({ palette: { primary: { main: '#0F62FE' } } })` (mirroring `fitness-monitor`'s
|
|
80
|
+
real usage) — proving the new surface resolves with zero adopter action, not just for a theme
|
|
81
|
+
that happens to declare it.
|
|
82
|
+
2. `theme.palette.background.subtle` equals `'#F4F5F6'` on an unconfigured `createAppTheme(...)`
|
|
83
|
+
call.
|
|
84
|
+
3. `calculateContrastRatio('#5B6670', '#F4F5F6')` (baseline `ink.secondary` on the new surface)
|
|
85
|
+
passes AA (≥ 4.5:1) — computed via the shipped function, not asserted from the sheet's number.
|
|
86
|
+
4. Existing `tests/createAppTheme.test.js` and `tests/themeCompleteness.test.js` stay green
|
|
87
|
+
unmodified in intent (only extended where the new surface must appear in an enumeration they
|
|
88
|
+
already assert against, e.g. a surface-count or key-list check if one exists).
|
|
89
|
+
|
|
90
|
+
### Verification
|
|
91
|
+
|
|
92
|
+
No visual/prototype gate — this is a token-level palette addition with no rendered specimen of its
|
|
93
|
+
own in this repo. The rendered check for what this token actually looks like on real cockpit
|
|
94
|
+
surfaces happens downstream, in `cockpit/UI-6`'s own two-width verification.
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## B. Implementation map
|
|
99
|
+
|
|
100
|
+
*Filled by the Orchestrator on `git pull` — see `AGENTS.md` → "Work Order".*
|
|
101
|
+
|
|
102
|
+
### Context package
|
|
103
|
+
|
|
104
|
+
- **`src/theme/tokens.js`** — `BASELINE_PALETTE.background` currently reads:
|
|
105
|
+
```js
|
|
106
|
+
background: {
|
|
107
|
+
default: '#FAFAFA',
|
|
108
|
+
paper: '#FFFFFF',
|
|
109
|
+
},
|
|
110
|
+
```
|
|
111
|
+
Add `subtle: '#F4F5F6'` as a third key. This is the ONLY change needed in this file for the new
|
|
112
|
+
value itself — do not touch `SERIES_COLOURS`, `STATUS_KEYS`, `BASELINE_STATIC`, or the exemptions
|
|
113
|
+
list.
|
|
114
|
+
- **`src/theme/themeCompleteness.js`** — `THEME_COMPLETENESS_SURFACES` (around line 155-192) already
|
|
115
|
+
has `pathSurface('palette.background.default')` and `pathSurface('palette.background.paper')` in
|
|
116
|
+
its list. Add `pathSurface('palette.background.subtle')` immediately next to them — same helper,
|
|
117
|
+
same pattern, no new machinery needed.
|
|
118
|
+
- **Why this can't collide with an existing adopter (verified, not assumed):** `MUI_DEFAULT_THEME =
|
|
119
|
+
createTheme()` (line 5 of `themeCompleteness.js`) is vanilla MUI with no `background.subtle` key —
|
|
120
|
+
MUI's own palette only ever defines `background.default`/`.paper`. So for every real
|
|
121
|
+
`createAppTheme(...)` output, `descriptor.get(theme)` resolves to `'#F4F5F6'` (defined) while
|
|
122
|
+
`descriptor.get(MUI_DEFAULT_THEME)` resolves to `undefined` — the `sameValue` check in
|
|
123
|
+
`assertThemeComplete` (around line 354) therefore never flags it, with no exemption required. This
|
|
124
|
+
is exactly why `background.default` needs no exemption today; `background.subtle` gets the same
|
|
125
|
+
treatment. `background.paper` is the one that DOES need an exemption, because MUI's own default
|
|
126
|
+
theme also happens to be white — do not copy that exemption pattern here, it does not apply.
|
|
127
|
+
- **`calculateContrastRatio` is already exported** from `src/theme/themeCompleteness.js` and
|
|
128
|
+
re-exported from `src/theme/index.js` — use it directly for the required contrast test, do not
|
|
129
|
+
reimplement contrast math.
|
|
130
|
+
- **Test file conventions** (read `tests/themeCompleteness.test.js` and
|
|
131
|
+
`tests/createAppTheme.test.js` for the existing style before writing new assertions — minimal
|
|
132
|
+
`createAppTheme({ palette: { primary: { main: '#0F62FE' } } })` is the repo's own established
|
|
133
|
+
"minimal adopter" fixture, already used in both files; reuse it rather than inventing a new one).
|
|
134
|
+
- Directive: work from this package; do not explore broadly from scratch; open only the two named
|
|
135
|
+
source files plus the two named test files to verify. If you must dig deeper, delegate to a
|
|
136
|
+
read-only Explore sub-agent (Haiku).
|
|
137
|
+
|
|
138
|
+
### Target repo working directory (absolute)
|
|
139
|
+
|
|
140
|
+
`C:\Users\biglmi\Documents\webapps\ui-core-micha`
|
|
141
|
+
|
|
142
|
+
### Preamble
|
|
143
|
+
|
|
144
|
+
> The text of this whole file is the COMPLETE spec — not a plan to refine; there is no separate plan
|
|
145
|
+
> file. Read the nearest `AGENTS.md`, the relevant `.codex/skills/<role>/SKILL.md`, and this repo's
|
|
146
|
+
> own `DESIGN.md`/conventions ONLY for conventions. Stay in scope; do not touch
|
|
147
|
+
> `CHART-*`/`SHELL-*`/`AUTH-*` surfaces or any file outside `src/theme/` and `tests/` unless this
|
|
148
|
+
> spec says so; do not update any `MEMORY.md`. Do NOT `git add` / `commit` / `push` — leave every
|
|
149
|
+
> change uncommitted in the working tree for the orchestrator's independent review; do NOT bump
|
|
150
|
+
> `package.json`'s version yourself — the Orchestrator decides and applies the semver bump after
|
|
151
|
+
> review, per the Risks section's still-open patch/minor question. WRITE the tests the "Required
|
|
152
|
+
> tests to WRITE" section calls for AND **RUN the tests you just wrote** (plus the two named existing
|
|
153
|
+
> spec files, to confirm no regression) to confirm they execute and pass — that is the ONLY test run
|
|
154
|
+
> you do (NOT this repo's full suite, NOT any review). The orchestrator re-runs the authoritative set
|
|
155
|
+
> + does the independent review after you finish — those are the gate; your own run does not count
|
|
156
|
+
> as the gate.
|
|
157
|
+
>
|
|
158
|
+
> Narrate continuously: a `PLAN: <step1> | <step2> | …` line up front, then a single-line
|
|
159
|
+
> `PROGRESS: [<n>/<total>] <present-tense action>` before every relevant action (and `… done` on
|
|
160
|
+
> completion), spaced so no gap exceeds ~2 min, stdout unbuffered, plus exactly one final
|
|
161
|
+
> `RESULT: DONE|BLOCKED <reason>`.
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## C. Orchestrator only — NOT ADDRESSED TO THE IMPLEMENTER
|
|
166
|
+
|
|
167
|
+
> **If you are the implementer reading this work order as your own specification: STOP at this line.
|
|
168
|
+
> Everything below describes what the Orchestrator does AFTER you finish. You do none of it — no
|
|
169
|
+
> reviewers, no verification run, no register edit, no commit.** You ARE the invocation described
|
|
170
|
+
> below; do NOT shell out to `codex exec`.
|
|
171
|
+
|
|
172
|
+
### Execution directive
|
|
173
|
+
|
|
174
|
+
Implement through `codex exec` in the background — invoked directly via Bash (never the
|
|
175
|
+
`debugger`/`*_coder` Agent wrappers) with BOTH flags `--skip-git-repo-check` and
|
|
176
|
+
`--dangerously-bypass-approvals-and-sandbox`. **Pass the work order via stdin, not as a positional
|
|
177
|
+
argument** (this repo's own `THEME-1` row already documents the Windows command-line length limit
|
|
178
|
+
hitting this via the npm shim). Fallback to direct Claude implementation only on Codex
|
|
179
|
+
quota/rate-limit/non-zero exit — the fallback flips authorship, so both reviewers stay mandatory
|
|
180
|
+
either way.
|
|
181
|
+
|
|
182
|
+
### Review routing
|
|
183
|
+
|
|
184
|
+
Tier 3: `reviewer` (Sonnet) + `ui_reviewer` (Sonnet), concurrent, same background batch, before
|
|
185
|
+
commit. No `sec_reviewer` — no auth/security surface in scope. `ui_reviewer`'s job here is narrow
|
|
186
|
+
(no rendered surface to review) — focus it on the completeness-contract and adopter-safety question
|
|
187
|
+
rather than visual design.
|
|
188
|
+
|
|
189
|
+
### Verification
|
|
190
|
+
|
|
191
|
+
No rendered two-width check — token-only change with no specimen in this repo (per the Envelope).
|
|
192
|
+
The authoritative check is: the two new/extended test files pass, `tests/createAppTheme.test.js` +
|
|
193
|
+
`tests/themeCompleteness.test.js` stay green, and a direct read of `fitness-monitor`'s
|
|
194
|
+
`frontend/src/theme.test.js` assertion confirms it would still pass unmodified against the new
|
|
195
|
+
package version (do not just reason about it — actually run `fitness-monitor`'s own scoped theme
|
|
196
|
+
test against the locally-built `ui-core-micha` if practical, or explain why not).
|
|
197
|
+
|
|
198
|
+
### Register + commit
|
|
199
|
+
|
|
200
|
+
Decide and apply the semver bump (patch, per the Risks section's reasoning, unless the
|
|
201
|
+
implementation reveals an adopter needs a code change — then escalate to minor and say why). Update
|
|
202
|
+
the `WORK_ORDERS.md` THEME-3 row to `done` with the named review verdicts and version, then commit +
|
|
203
|
+
push to `main` on green (this push publishes to npm — confirm everything is green first, there is no
|
|
204
|
+
staging net here).
|
|
205
|
+
|
|
206
|
+
### Mini-handover
|
|
207
|
+
|
|
208
|
+
Repo: `ui-core-micha` (`C:\Users\biglmi\Documents\webapps\ui-core-micha`), branch `main`.
|
|
209
|
+
WO: `work-orders/THEME-3.md`. **Ready to run** — no preconditions, small well-bounded addition.
|
|
210
|
+
Follow `orchestrate-codex`.
|