Skip to content

Commit f41c8d3

Browse files
axisrowclaude
andcommitted
fix(tui): compact-label toggle cycles over the effective state
The per-widget (j) toggle only wrote/removed 'true', so with the global Compact Labels setting on it became a visual no-op: the render-time injection re-compactified the widget after the key was removed, and no row marker showed the effective state. - toggleCompactLabel now takes the settings and cycles the EFFECTIVE state: compact (saved 'true' or inherited global on) -> write 'false'; forced off -> drop the key and inherit; otherwise -> write 'true'. - getCompactLabelModifierText reports the effective state: '(compact label)' / '(compact label: on)' / '(compact label: off)'. - ItemsEditor/input-handlers pass settings through to both. - docs/USAGE.md: fix preset savings arithmetic (Model -4, Context -4). Co-Authored-By: Claude Code <[email protected]>
1 parent 9be29cd commit f41c8d3

5 files changed

Lines changed: 70 additions & 23 deletions

File tree

‎docs/USAGE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Configure global formatting preferences that apply to all widgets:
119119
- **Default padding is empty** (`defaultPadding` unset), so widgets add no padding unless you configure it. A non-empty padding of N characters adds up to 2N columns per widget (one per enabled side).
120120
- **Manual `|` separators render as ` | `** (3 columns); in Powerline mode separator widgets are ignored and replaced by the powerline separators.
121121
- **Labels are the dominant fixed cost** of labeled widgets. Defaults: `Model: ` (7), `Ctx: ` (5), `Cost: ` (6), token widgets `In: `/`Out: `/`Total: `/`Cached: ` (4–8), cache widgets `Cache Read: `/`Cache Write: `/`Cache Hit: ` (10–12), timers `Block: `/`Reset: `/`Cache: ` (7) and `Weekly Reset: ` (13), usage widgets `Session: `/`Weekly: `/`Weekly Sonnet: `/`Weekly Opus: `/`Weekly Fable: ` (8–15).
122-
- **Compact Labels** (above) trims the presets it covers (`Model:` −5, `Context:` −3, `Cost:` −6, label gone — the value's own `$` remains); Minimalist Mode strips labels entirely.
122+
- **Compact Labels** (above) trims the presets it covers (`Model:` −4, `Context:` −4, `Cost:` −6, label gone — the value's own `$` remains); Minimalist Mode strips labels entirely.
123123
- **Unbounded-content widgets** (paths, names, URLs) can overflow a narrow terminal: Git Branch, Git Root Dir, Current Working Dir, and Session Name support a per-widget max-width cap — select the widget in the line editor and press **(w)idth**. The line renderer truncates the whole line with an ellipsis regardless.
124124

125125
</details>

‎src/tui/components/ItemsEditor.tsx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,8 @@ export const ItemsEditor: React.FC<ItemsEditorProps> = ({ widgets, onUpdate, onB
270270
openWidgetPicker,
271271
getCustomKeybindsForWidget,
272272
setCustomEditorWidget,
273-
getUniqueBackgroundColor
273+
getUniqueBackgroundColor,
274+
settings
274275
});
275276
});
276277

@@ -594,7 +595,7 @@ export const ItemsEditor: React.FC<ItemsEditorProps> = ({ widgets, onUpdate, onB
594595
: undefined;
595596
const hideModifierText = widgetImpl ? getHideModifierText(widget, widgetImpl.getHideableStates?.() ?? []) : undefined;
596597
const compactModifierText = widgetImpl && getCompactLabelCapableTypes().has(widget.type)
597-
? getCompactLabelModifierText(widget)
598+
? getCompactLabelModifierText(widget, settings)
598599
: undefined;
599600

600601
return (

‎src/tui/components/items-editor/input-handlers.ts‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import type { Settings } from '../../../types/Settings';
12
import type {
23
CustomKeybind,
34
Widget,
@@ -358,6 +359,7 @@ export interface HandleNormalInputModeArgs {
358359
getCustomKeybindsForWidget: (widgetImpl: Widget, widget: WidgetItem) => CustomKeybind[];
359360
setCustomEditorWidget: (state: CustomEditorWidgetState | null) => void;
360361
getUniqueBackgroundColor?: (insertIndex: number) => string | undefined;
362+
settings?: Settings;
361363
}
362364

363365
export function handleNormalInputMode({
@@ -375,7 +377,8 @@ export function handleNormalInputMode({
375377
openWidgetPicker,
376378
getCustomKeybindsForWidget,
377379
setCustomEditorWidget,
378-
getUniqueBackgroundColor
380+
getUniqueBackgroundColor,
381+
settings
379382
}: HandleNormalInputModeArgs): void {
380383
if (key.upArrow && widgets.length > 0) {
381384
setSelectedIndex(selectedIndex - 1 < 0 ? widgets.length - 1 : selectedIndex - 1);
@@ -508,8 +511,10 @@ export function handleNormalInputMode({
508511
} else if (matchedKeybind.action === TOGGLE_COMPACT_LABEL_ACTION) {
509512
// The compact-label toggle is shared by every labeled
510513
// widget, so like the precision cycle it is applied here.
514+
// The settings let the cycle start from the effective
515+
// (possibly globally inherited) state.
511516
const newWidgets = [...widgets];
512-
newWidgets[selectedIndex] = toggleCompactLabel(currentWidget);
517+
newWidgets[selectedIndex] = toggleCompactLabel(currentWidget, settings);
513518
onUpdate(newWidgets);
514519
} else if (widgetImpl.handleEditorAction) {
515520
const updatedWidget = widgetImpl.handleEditorAction(matchedKeybind.action, currentWidget);

‎src/widgets/shared/__tests__/raw-or-labeled.test.ts‎

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,32 @@ describe('formatRawOrLabeledValue', () => {
4242
});
4343

4444
describe('toggleCompactLabel', () => {
45-
it('adds and removes only the compactLabel metadata key', () => {
46-
const enabled = toggleCompactLabel(ITEM);
47-
expect(enabled.metadata).toEqual({ compactLabel: 'true' });
45+
it('cycles inherit -> on -> forced off -> inherit without the global setting', () => {
46+
const on = toggleCompactLabel(ITEM);
47+
expect(on.metadata).toEqual({ compactLabel: 'true' });
4848

49-
const disabled = toggleCompactLabel(enabled);
50-
expect(disabled.metadata).toBeUndefined();
51-
expect(disabled).toEqual(ITEM);
49+
const forcedOff = toggleCompactLabel(on);
50+
expect(forcedOff.metadata).toEqual({ compactLabel: 'false' });
51+
52+
const inherit = toggleCompactLabel(forcedOff);
53+
expect(inherit.metadata).toBeUndefined();
54+
expect(inherit).toEqual(ITEM);
55+
});
56+
57+
it('starts from the effective state while the global setting is on', () => {
58+
const settings = { ...DEFAULT_SETTINGS, compactLabels: true };
59+
// Inherited compact -> first press forces off instead of a no-op.
60+
const forcedOff = toggleCompactLabel(ITEM, settings);
61+
expect(forcedOff.metadata).toEqual({ compactLabel: 'false' });
62+
63+
// Second press drops the key and inherits the global setting again.
64+
expect(toggleCompactLabel(forcedOff, settings).metadata).toBeUndefined();
5265
});
5366

5467
it('preserves sibling metadata', () => {
5568
const item: WidgetItem = { id: '1', type: 'model', metadata: { hide: 'no-git' } };
5669
expect(toggleCompactLabel(item).metadata).toEqual({ hide: 'no-git', compactLabel: 'true' });
57-
expect(toggleCompactLabel(toggleCompactLabel(item)).metadata).toEqual({ hide: 'no-git' });
70+
expect(toggleCompactLabel(toggleCompactLabel(toggleCompactLabel(item))).metadata).toEqual({ hide: 'no-git' });
5871
});
5972
});
6073

@@ -92,9 +105,13 @@ describe('startsWithCompactLabel', () => {
92105
});
93106

94107
describe('compact label keybind', () => {
95-
it('uses a key no widget binds and advertises the enabled state', () => {
108+
it('uses a key no widget binds and reports the effective state', () => {
96109
expect(getCompactLabelKeybind().key).toBe('j');
97-
expect(getCompactLabelModifierText(toggleCompactLabel(ITEM))).toBe('(compact label)');
110+
const settings = { ...DEFAULT_SETTINGS, compactLabels: true };
111+
98112
expect(getCompactLabelModifierText(ITEM)).toBeUndefined();
113+
expect(getCompactLabelModifierText(ITEM, settings)).toBe('(compact label: on)');
114+
expect(getCompactLabelModifierText(toggleCompactLabel(ITEM))).toBe('(compact label)');
115+
expect(getCompactLabelModifierText(toggleCompactLabel(toggleCompactLabel(ITEM)), settings)).toBe('(compact label: off)');
99116
});
100117
});

‎src/widgets/shared/raw-or-labeled.ts‎

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,21 +50,33 @@ export function formatRawOrLabeledValue(item: WidgetItem, labelPrefix: string, v
5050
return `${labelPrefix}${value}`;
5151
}
5252

53-
// Toggle the per-widget compact-label override. Turning it off removes the
54-
// metadata key so untouched items keep minimal metadata.
55-
export function toggleCompactLabel(item: WidgetItem): WidgetItem {
56-
const { [COMPACT_LABEL_METADATA_KEY]: removed, ...restMetadata } = item.metadata ?? {};
57-
if (isCompactLabelEnabled(item)) {
53+
// Cycle the per-widget compact-label override over the widget's EFFECTIVE
54+
// state, so the toggle stays useful while the global setting is on: compact
55+
// now (saved 'true', or inherited because the global flag is on) -> write an
56+
// explicit 'false'; forced off -> drop the key and inherit the global setting
57+
// again; otherwise -> write 'true'. Dropping the key keeps untouched items'
58+
// metadata minimal.
59+
export function toggleCompactLabel(item: WidgetItem, settings?: Settings): WidgetItem {
60+
const saved = item.metadata?.[COMPACT_LABEL_METADATA_KEY];
61+
if (saved === 'true' || (saved === undefined && settings?.compactLabels === true)) {
62+
return withCompactLabel(item, 'false');
63+
}
64+
if (saved === 'false') {
65+
const { [COMPACT_LABEL_METADATA_KEY]: removed, ...restMetadata } = item.metadata ?? {};
5866
return {
5967
...item,
6068
metadata: Object.keys(restMetadata).length > 0 ? restMetadata : undefined
6169
};
6270
}
71+
return withCompactLabel(item, 'true');
72+
}
73+
74+
function withCompactLabel(item: WidgetItem, value: string): WidgetItem {
6375
return {
6476
...item,
6577
metadata: {
66-
...restMetadata,
67-
[COMPACT_LABEL_METADATA_KEY]: 'true'
78+
...item.metadata,
79+
[COMPACT_LABEL_METADATA_KEY]: value
6880
}
6981
};
7082
}
@@ -73,8 +85,20 @@ export function getCompactLabelKeybind(): CustomKeybind {
7385
return COMPACT_LABEL_KEYBIND;
7486
}
7587

76-
export function getCompactLabelModifierText(item: WidgetItem): string | undefined {
77-
return isCompactLabelEnabled(item) ? '(compact label)' : undefined;
88+
// Modifier text reflects the effective state, not just saved metadata, so a
89+
// widget that renders compact via the global setting is still marked.
90+
export function getCompactLabelModifierText(item: WidgetItem, settings?: Settings): string | undefined {
91+
const saved = item.metadata?.[COMPACT_LABEL_METADATA_KEY];
92+
if (saved === 'true') {
93+
return '(compact label)';
94+
}
95+
if (saved === 'false') {
96+
return '(compact label: off)';
97+
}
98+
if (saved === undefined && settings?.compactLabels === true) {
99+
return '(compact label: on)';
100+
}
101+
return undefined;
78102
}
79103

80104
// Fold the global Compact Labels setting into the item's metadata right before

0 commit comments

Comments
 (0)