From 6316cfd828a1185eb3061127edb530b540515f0b Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 6 Sep 2026 17:58:47 +0000 Subject: [PATCH] docs(plugin-kanban): document the badge element's colorClass / colorStyle members The README's `KanbanCard` block wrote the `badges` element with 2 of the 4 members shipped by `packages/types/src/complex.ts` (`KanbanCard` at :63, which `@object-ui/plugin-kanban` re-exports through `src/types.ts`). Add the missing `colorClass` and `colorStyle` in the shipped order, with one comment line naming the pairing rule: a `colorClass` derived from `getBadgeHexAppearance` must carry that helper's style as `colorStyle`, because the class reads CSS custom properties only that style declares. Neither gate reds on this by design: `check-readme-exports.mjs` compares top-level property names only and deliberately does not walk nested declarations, and this README sits on `check-doc-snippet-types.mjs`'s `UNGATED_DOCS` ledger, so its fences are never compiled. The interface pin still reads `matches interface KanbanCard doc 7 key(s) vs own 7 of 7`, unchanged, because the addition is nested. Co-Authored-By: Claude Fable 5.1 Claude-Session: https://claude.ai/code/session_01FhBNJcLRZLe8M87VcUgpKr --- packages/plugin-kanban/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/plugin-kanban/README.md b/packages/plugin-kanban/README.md index 9729622688..612b92e268 100644 --- a/packages/plugin-kanban/README.md +++ b/packages/plugin-kanban/README.md @@ -129,6 +129,8 @@ interface KanbanCard { badges?: Array<{ label: string; variant?: 'default' | 'secondary' | 'destructive' | 'outline'; + colorClass?: string; + colorStyle?: React.CSSProperties; // Required whenever colorClass came from getBadgeHexAppearance(color) in @object-ui/fields — the class reads CSS custom properties only this style declares (objectui#5183) }>; cardSubtitle?: string; // Synthesized subtitle, rendered in preference to description cardFieldCells?: Array<{ // Structured per-field cells; wins over cardSubtitle/description