Skip to content

feat(slider): add filledChar/emptyChar metadata options #469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bfabio wants to merge 1 commit into
base: main
Choose a base branch
from
+92 −29
Open

feat(slider): add filledChar/emptyChar metadata options #469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/widgets/BlockResetTimer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import {
getUsageLocale,
getUsageProgressBarWidth,
getUsageTimerCustomKeybinds,
getSliderBarChars,
getUsageTimezone,
isUsage12HourClock,
isUsageCompact,
Expand Down Expand Up @@ -108,7 +109,7 @@ export class BlockResetTimerWidget implements Widget {
}

if (isUsageSliderMode(displayMode)) {
const slider = makeSliderBar(previewPercent);
const slider = makeSliderBar(previewPercent, getSliderBarChars(item));
const sliderDisplay = displayMode === 'slider'
? `${slider} ${previewPercent.toFixed(1)}%`
: slider;
Expand Down Expand Up @@ -150,7 +151,7 @@ export class BlockResetTimerWidget implements Widget {

if (isUsageSliderMode(displayMode)) {
const percent = inverted ? window.remainingPercent : window.elapsedPercent;
const slider = makeSliderBar(percent);
const slider = makeSliderBar(percent, getSliderBarChars(item));
const sliderDisplay = displayMode === 'slider'
? `${slider} ${percent.toFixed(1)}%`
: slider;
Expand Down
7 changes: 4 additions & 3 deletions src/widgets/BlockTimer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
cycleUsageDisplayMode,
getUsageDisplayMode,
getUsageDisplayModifierText,
getSliderBarChars,
getUsageProgressBarWidth,
getUsageTimerCustomKeybinds,
isUsageCompact,
Expand Down Expand Up @@ -78,7 +79,7 @@ export class BlockTimerWidget implements Widget {
}

if (isUsageSliderMode(displayMode)) {
const slider = makeSliderBar(previewPercent);
const slider = makeSliderBar(previewPercent, getSliderBarChars(item));
const sliderDisplay = displayMode === 'slider'
? `${slider} ${previewPercent.toFixed(1)}%`
: slider;
Expand All @@ -99,7 +100,7 @@ export class BlockTimerWidget implements Widget {
}

if (isUsageSliderMode(displayMode)) {
const emptySlider = makeSliderBar(0);
const emptySlider = makeSliderBar(0, getSliderBarChars(item));
const sliderDisplay = displayMode === 'slider'
? `${emptySlider} 0.0%`
: emptySlider;
Expand All @@ -119,7 +120,7 @@ export class BlockTimerWidget implements Widget {

if (isUsageSliderMode(displayMode)) {
const percent = inverted ? window.remainingPercent : window.elapsedPercent;
const slider = makeSliderBar(percent);
const slider = makeSliderBar(percent, getSliderBarChars(item));
const sliderDisplay = displayMode === 'slider'
? `${slider} ${percent.toFixed(1)}%`
: slider;
Expand Down
6 changes: 3 additions & 3 deletions src/widgets/ContextBar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {
import { formatTokens } from '../utils/renderer';
import { makeUsageProgressBar } from '../utils/usage';

import { makeSliderBar } from './shared/usage-display';
import { getSliderBarChars, makeSliderBar } from './shared/usage-display';

type DisplayMode = 'progress' | 'progress-short' | 'slider' | 'slider-only';

Expand Down Expand Up @@ -82,7 +82,7 @@ export class ContextBarWidget implements Widget {

if (context.isPreview) {
if (isBarSliderMode(displayMode)) {
const slider = makeSliderBar(25);
const slider = makeSliderBar(25, getSliderBarChars(item));
const sliderDisplay = displayMode === 'slider' ? `${slider} 50k/200k (25%)` : slider;
return item.rawValue ? sliderDisplay : `Context: ${sliderDisplay}`;
}
Expand Down Expand Up @@ -115,7 +115,7 @@ export class ContextBarWidget implements Widget {
const totalDisplay = formatTokens(total, 0);

if (isBarSliderMode(displayMode)) {
const slider = makeSliderBar(clampedPercent);
const slider = makeSliderBar(clampedPercent, getSliderBarChars(item));
const sliderDisplay = displayMode === 'slider' ? `${slider} ${usedDisplay}/${totalDisplay} (${Math.round(clampedPercent)}%)` : slider;
return item.rawValue ? sliderDisplay : `Context: ${sliderDisplay}`;
}
Expand Down
4 changes: 3 additions & 1 deletion src/widgets/ContextPercentageUsable.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
renderContextSlider
} from './shared/context-slider';
import { formatRawOrLabeledValue } from './shared/raw-or-labeled';
import { getSliderBarChars } from './shared/usage-display';

export class ContextPercentageUsableWidget implements Widget {
getDefaultColor(): string { return 'green'; }
Expand Down Expand Up @@ -57,8 +58,9 @@ export class ContextPercentageUsableWidget implements Widget {
const contextWindowMetrics = getContextWindowMetrics(context.data);
const contextConfig = getContextConfig(modelIdentifier, contextWindowMetrics.windowSize);

const chars = getSliderBarChars(item);
const formatContextPercentage = (displayPercentage: number): string => {
const sliderResult = renderContextSlider(sliderMode, displayPercentage);
const sliderResult = renderContextSlider(sliderMode, displayPercentage, chars);
return formatRawOrLabeledValue(item, label, sliderResult ?? `${displayPercentage.toFixed(1)}%`);
};

Expand Down
5 changes: 3 additions & 2 deletions src/widgets/ExtraUsageUtilization.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import { makeTimerProgressBar } from './shared/progress-bar';
import { formatRawOrLabeledValue } from './shared/raw-or-labeled';
import {
cycleUsageDisplayMode,
getSliderBarChars,
getUsageDisplayMode,
getUsageDisplayModifierText,
getUsagePercentCustomKeybinds,
Expand Down Expand Up @@ -74,7 +75,7 @@ export class ExtraUsageUtilizationWidget implements Widget {
}

if (isUsageSliderMode(displayMode)) {
const slider = makeSliderBar(renderedPercent);
const slider = makeSliderBar(renderedPercent, getSliderBarChars(item));
const sliderDisplay = displayMode === 'slider' ? `${slider} ${renderedPercent.toFixed(1)}%` : slider;
return formatRawOrLabeledValue(item, 'Overage: ', sliderDisplay);
}
Expand Down Expand Up @@ -105,7 +106,7 @@ export class ExtraUsageUtilizationWidget implements Widget {
}

if (isUsageSliderMode(displayMode)) {
const slider = makeSliderBar(renderedPercent);
const slider = makeSliderBar(renderedPercent, getSliderBarChars(item));
const sliderDisplay = displayMode === 'slider' ? `${slider} ${renderedPercent.toFixed(1)}%` : slider;
return formatRawOrLabeledValue(item, 'Overage: ', sliderDisplay);
}
Expand Down
6 changes: 4 additions & 2 deletions src/widgets/SessionUsage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import { makeTimerProgressBar } from './shared/progress-bar';
import { formatRawOrLabeledValue } from './shared/raw-or-labeled';
import {
cycleUsageDisplayMode,
getSliderBarChars,
getUsageDisplayMode,
getUsageDisplayModifierText,
getUsagePercentCustomKeybinds,
Expand Down Expand Up @@ -74,7 +75,8 @@ export class SessionUsageWidget implements Widget {
}

if (isUsageSliderMode(displayMode)) {
const slider = makeSliderBar(renderedPercent, undefined, showCursor ? { cursorPercent: 50 } : undefined);
const barChars = getSliderBarChars(item);
const slider = makeSliderBar(renderedPercent, showCursor ? { ...barChars, cursorPercent: 50 } : barChars);
const sliderDisplay = displayMode === 'slider' ? `${slider} ${renderedPercent.toFixed(1)}%` : slider;
return formatRawOrLabeledValue(item, 'Session: ', sliderDisplay);
}
Expand Down Expand Up @@ -109,7 +111,7 @@ export class SessionUsageWidget implements Widget {
}

if (isUsageSliderMode(displayMode)) {
const slider = makeSliderBar(renderedPercent, undefined, getCursorOptions());
const slider = makeSliderBar(renderedPercent, { ...getSliderBarChars(item), ...getCursorOptions() });
const sliderDisplay = displayMode === 'slider' ? `${slider} ${renderedPercent.toFixed(1)}%` : slider;
return formatRawOrLabeledValue(item, 'Session: ', sliderDisplay);
}
Expand Down
4 changes: 2 additions & 2 deletions src/widgets/WeeklyOpusUsage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export class WeeklyOpusUsageWidget implements Widget {
}

if (isUsageSliderMode(displayMode)) {
const slider = makeSliderBar(renderedPercent, undefined, showCursor ? { cursorPercent: 50 } : undefined);
const slider = makeSliderBar(renderedPercent, showCursor ? { cursorPercent: 50 } : undefined);
const sliderDisplay = displayMode === 'slider' ? `${slider} ${renderedPercent.toFixed(1)}%` : slider;
return formatRawOrLabeledValue(item, LABEL, sliderDisplay);
}
Expand Down Expand Up @@ -111,7 +111,7 @@ export class WeeklyOpusUsageWidget implements Widget {
}

if (isUsageSliderMode(displayMode)) {
const slider = makeSliderBar(renderedPercent, undefined, getCursorOptions());
const slider = makeSliderBar(renderedPercent, getCursorOptions());
const sliderDisplay = displayMode === 'slider' ? `${slider} ${renderedPercent.toFixed(1)}%` : slider;
return formatRawOrLabeledValue(item, LABEL, sliderDisplay);
}
Expand Down
6 changes: 4 additions & 2 deletions src/widgets/WeeklySonnetUsage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import { makeTimerProgressBar } from './shared/progress-bar';
import { formatRawOrLabeledValue } from './shared/raw-or-labeled';
import {
cycleUsageDisplayMode,
getSliderBarChars,
getUsageDisplayMode,
getUsageDisplayModifierText,
getUsagePercentCustomKeybinds,
Expand Down Expand Up @@ -76,7 +77,8 @@ export class WeeklySonnetUsageWidget implements Widget {
}

if (isUsageSliderMode(displayMode)) {
const slider = makeSliderBar(renderedPercent, undefined, showCursor ? { cursorPercent: 50 } : undefined);
const barChars = getSliderBarChars(item);
const slider = makeSliderBar(renderedPercent, showCursor ? { ...barChars, cursorPercent: 50 } : barChars);
const sliderDisplay = displayMode === 'slider' ? `${slider} ${renderedPercent.toFixed(1)}%` : slider;
return formatRawOrLabeledValue(item, LABEL, sliderDisplay);
}
Expand Down Expand Up @@ -111,7 +113,7 @@ export class WeeklySonnetUsageWidget implements Widget {
}

if (isUsageSliderMode(displayMode)) {
const slider = makeSliderBar(renderedPercent, undefined, getCursorOptions());
const slider = makeSliderBar(renderedPercent, { ...getSliderBarChars(item), ...getCursorOptions() });
const sliderDisplay = displayMode === 'slider' ? `${slider} ${renderedPercent.toFixed(1)}%` : slider;
return formatRawOrLabeledValue(item, LABEL, sliderDisplay);
}
Expand Down
6 changes: 4 additions & 2 deletions src/widgets/WeeklyUsage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import { makeTimerProgressBar } from './shared/progress-bar';
import { formatRawOrLabeledValue } from './shared/raw-or-labeled';
import {
cycleUsageDisplayMode,
getSliderBarChars,
getUsageDisplayMode,
getUsageDisplayModifierText,
getUsagePercentCustomKeybinds,
Expand Down Expand Up @@ -74,7 +75,8 @@ export class WeeklyUsageWidget implements Widget {
}

if (isUsageSliderMode(displayMode)) {
const slider = makeSliderBar(renderedPercent, undefined, showCursor ? { cursorPercent: 50 } : undefined);
const barChars = getSliderBarChars(item);
const slider = makeSliderBar(renderedPercent, showCursor ? { ...barChars, cursorPercent: 50 } : barChars);
const sliderDisplay = displayMode === 'slider' ? `${slider} ${renderedPercent.toFixed(1)}%` : slider;
return formatRawOrLabeledValue(item, 'Weekly: ', sliderDisplay);
}
Expand Down Expand Up @@ -109,7 +111,7 @@ export class WeeklyUsageWidget implements Widget {
}

if (isUsageSliderMode(displayMode)) {
const slider = makeSliderBar(renderedPercent, undefined, getCursorOptions());
const slider = makeSliderBar(renderedPercent, { ...getSliderBarChars(item), ...getCursorOptions() });
const sliderDisplay = displayMode === 'slider' ? `${slider} ${renderedPercent.toFixed(1)}%` : slider;
return formatRawOrLabeledValue(item, 'Weekly: ', sliderDisplay);
}
Expand Down
38 changes: 34 additions & 4 deletions src/widgets/shared/__tests__/usage-display.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
import type { WidgetItem } from '../../../types/Widget';
import {
cycleUsageDisplayMode,
getSliderBarChars,
makeSliderBar
} from '../usage-display';

Expand All @@ -32,16 +33,45 @@ describe('makeSliderBar', () => {
});

it('accepts custom width', () => {
expect(makeSliderBar(50, 6)).toBe('▓▓▓░░░');
expect(makeSliderBar(50, { width: 6 })).toBe('▓▓▓░░░');
});

it('renders a time cursor when cursorPercent is provided', () => {
expect(makeSliderBar(50, 10, { cursorPercent: 50 })).toBe('▓▓▓▓▓│░░░░');
expect(makeSliderBar(50, { cursorPercent: 50 })).toBe('▓▓▓▓▓│░░░░');
});

it('clamps slider cursor percent', () => {
expect(makeSliderBar(50, 10, { cursorPercent: -10 })).toBe('│▓▓▓▓░░░░░');
expect(makeSliderBar(50, 10, { cursorPercent: 150 })).toBe('▓▓▓▓▓░░░░│');
expect(makeSliderBar(50, { cursorPercent: -10 })).toBe('│▓▓▓▓░░░░░');
expect(makeSliderBar(50, { cursorPercent: 150 })).toBe('▓▓▓▓▓░░░░│');
});

it('uses custom filledChar and emptyChar', () => {
expect(makeSliderBar(50, { filledChar: '▰', emptyChar: '▱' })).toBe('▰▰▰▰▰▱▱▱▱▱');
});

it('uses default chars when filledChar/emptyChar are not provided', () => {
expect(makeSliderBar(50, {})).toBe('▓▓▓▓▓░░░░░');
});

it('custom chars work with cursor', () => {
expect(makeSliderBar(50, { filledChar: '▰', emptyChar: '▱', cursorPercent: 50 })).toBe('▰▰▰▰▰│▱▱▱▱');
});
});

describe('getSliderBarChars', () => {
it('returns defaults when metadata is absent', () => {
const item: WidgetItem = { id: 'test', type: 'session-usage' };
expect(getSliderBarChars(item)).toEqual({ filledChar: '▓', emptyChar: '░' });
});

it('returns custom chars from metadata', () => {
const item: WidgetItem = { id: 'test', type: 'session-usage', metadata: { filledChar: '▰', emptyChar: '▱' } };
expect(getSliderBarChars(item)).toEqual({ filledChar: '▰', emptyChar: '▱' });
});

it('falls back to defaults for empty string metadata values', () => {
const item: WidgetItem = { id: 'test', type: 'session-usage', metadata: { filledChar: '', emptyChar: '' } };
expect(getSliderBarChars(item)).toEqual({ filledChar: '▓', emptyChar: '░' });
});
});

Expand Down
8 changes: 6 additions & 2 deletions src/widgets/shared/context-slider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,15 @@ export function cycleContextSliderMode(item: WidgetItem): WidgetItem {
};
}

export function renderContextSlider(mode: ContextSliderMode, percent: number): string | null {
export function renderContextSlider(
mode: ContextSliderMode,
percent: number,
chars?: { filledChar: string; emptyChar: string }
): string | null {
if (mode === 'none') {
return null;
}
const slider = makeSliderBar(percent);
const slider = makeSliderBar(percent, chars);
if (mode === 'slider') {
return `${slider} ${percent.toFixed(1)}%`;
}
Expand Down
26 changes: 22 additions & 4 deletions src/widgets/shared/usage-display.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,23 +44,41 @@ export function isUsageSliderMode(mode: UsageDisplayMode): boolean {
return mode === 'slider' || mode === 'slider-only';
}

interface SliderBarOptions { cursorPercent?: number }
interface SliderBarOptions {
width?: number;
cursorPercent?: number;
filledChar?: string;
emptyChar?: string;
}

export function getSliderBarChars(item: WidgetItem): { filledChar: string; emptyChar: string } {
const filledChar = typeof item.metadata?.filledChar === 'string' && item.metadata.filledChar.length > 0
? item.metadata.filledChar
: '▓';
const emptyChar = typeof item.metadata?.emptyChar === 'string' && item.metadata.emptyChar.length > 0
? item.metadata.emptyChar
: '░';
return { filledChar, emptyChar };
}

export function makeSliderBar(percent: number, width: number = SLIDER_WIDTH, options?: SliderBarOptions): string {
export function makeSliderBar(percent: number, options?: SliderBarOptions): string {
const width = options?.width ?? SLIDER_WIDTH;
const clamped = Math.max(0, Math.min(100, percent));
const filled = Math.round((clamped / 100) * width);
const cursorPos = options?.cursorPercent !== undefined
? Math.min(Math.floor((Math.max(0, Math.min(100, options.cursorPercent)) / 100) * width), width - 1)
: -1;
const filledChar = options?.filledChar ?? '▓';
const emptyChar = options?.emptyChar ?? '░';

let bar = '';
for (let i = 0; i < width; i++) {
if (i === cursorPos) {
bar += '│';
} else if (i < filled) {
bar += '▓';
bar += filledChar;
} else {
bar += '░';
bar += emptyChar;
}
}

Expand Down