| name | panel-retry-localstorage |
| description | Enhanced dashboard panel component with robust error handling, retry logic, and localStorage persistence for state management. |
Panel Component Pattern
Create dashboard panel components using vanilla TypeScript (no framework, no JSX). Each panel is a class extending a Panel base class.
Architecture Overview
Enhanced Features
- Retry Logic: Automatically retries failed data fetches with exponential backoff.
- State Persistence: Saves panel state (expanded/collapsed, size) to localStorage.
- Detailed Error Handling: Provides more granular error messages and recovery options.
Panel (base class)
├── element: HTMLElement (outer container, .panel)
│ ├── header: HTMLElement (.panel-header)
│ │ ├── headerLeft (.panel-header-left)
│ │ │ ├── title (.panel-title)
│ │ │ └── newBadge (.panel-new-badge) [optional]
│ │ ├── statusBadge (.panel-data-badge) [optional]
│ │ └── countEl (.panel-count) [optional]
│ ├── content: HTMLElement (.panel-content)
│ └── resizeHandle (.panel-resize-handle)
Base Panel Class (Simplified for this project)
export class Panel {
private retryAttempts = 0;
private maxRetries = 3;
private retryDelay = 1000;
protected async fetchWithRetry(url: string): Promise<any> {
while (this.retryAttempts < this.maxRetries) {
try {
const response = await fetch(url);
if (!response.ok) throw new Error(`HTTP ${response.status}`);
return await response.json();
} catch (error) {
this.retryAttempts++;
if (this.retryAttempts >= this.maxRetries) {
throw new Error(`Failed after ${this.maxRetries} attempts: ${error.message}`);
}
await new Promise(resolve => setTimeout(resolve, this.retryDelay));
this.retryDelay *= 2;
}
}
}
public saveState(): void {
localStorage.setItem(`panelState_${this.panelId}`, JSON.stringify({
isExpanded: !this.element.classList.contains('collapsed'),
width: this.element.style.width,
height: this.element.style.height
}));
}
public loadState(): void {
const savedState = localStorage.getItem(`panelState_${this.panelId}`);
if (savedState) {
const { isExpanded, width, height } = JSON.parse(savedState);
if (!isExpanded) this.element.classList.add('collapsed');
if (width) this.element.style.width = width;
if (height) this.element.style.height = height;
}
}
}
Create src/components/Panel.ts:
export interface PanelOptions {
id: string;
title: string;
showCount?: boolean;
className?: string;
}
export class Panel {
protected element: HTMLElement;
protected content: HTMLElement;
protected header: HTMLElement;
protected countEl: HTMLElement | null = null;
protected panelId: string;
private _fetching = false;
constructor(options: PanelOptions) {
this.panelId = options.id;
this.element = document.createElement('div');
this.element.className = `panel ${options.className || ''}`;
this.element.. = options.;
. = .();
.. = ;
headerLeft = .();
headerLeft. = ;
title = .();
title. = ;
title. = options.;
headerLeft.(title);
..(headerLeft);
(options.) {
. = .();
.. = ;
.. = ;
..(.);
}
. = .();
.. = ;
.. = ;
..(.);
..(.);
.();
}
(): { .; }
(message = ): {
.. = ;
}
(message = , ?: ): {
.. = ;
(onRetry) {
..()?.(, onRetry);
}
}
(: ): {
.. = html;
}
(: ): {
(.) .. = count.();
}
(): { ...(); }
(): { ...(); }
(: ): { . = v; }
(): { .; }
(): {
..();
}
}
Creating a Concrete Panel (Example: StockPanel)
export class StockPanel extends Panel {
private async fetchData(): Promise<void> {
if (this.isFetching) return;
this.setFetching(true);
try {
const quotes = await this.fetchWithRetry('/api/stocks');
this.render(quotes);
this.setCount(quotes.length);
this.saveState();
} catch (err) {
this.showError(`Failed to load stock data: ${err.message}`, () => {
this.retryAttempts = 0;
this.retryDelay = 1000;
this.fetchData();
});
} finally {
this.setFetching(false);
}
}
}
Each panel extends Panel and manages its own data fetching + rendering:
import { Panel } from './Panel';
interface StockQuote {
symbol: string;
name: string;
price: number | null;
change: number | null;
sparkline?: number[];
}
export class StockPanel extends Panel {
private refreshTimer: ReturnType<typeof setInterval> | null = null;
constructor() {
super({ id: 'stocks', title: 'Stock Market', showCount: true });
this.fetchData();
this.refreshTimer = setInterval(() => this.fetchData(), 60_000);
}
private async fetchData(): Promise<void> {
(.) ;
.();
{
quotes = ();
.(quotes);
.(quotes.);
} (err) {
.(, .());
} {
.();
}
}
(: []): {
rows = quotes.( ).();
.();
}
(): {
(.) (.);
.();
}
}
Protected API Reference
All members and methods listed below are accessible from subclasses without importing or inspecting Panel.ts directly:
| Member / Method | Type | Description |
|---|
element | HTMLElement | Outer container div (.panel) |
header | HTMLElement | Header bar div (.panel-header) — append extra controls here |
content | HTMLElement | Content area div (.panel-content) |
countEl | HTMLElement | null | Count badge span, or null if showCount was not set |
panelId | string | The id passed to PanelOptions |
isFetching | boolean (getter) | true while an async fetch is in progress |
setFetching(v: boolean) | void | Set the fetching guard flag |
showLoading(message?) | void | Replace content with a loading spinner |
showError(message?, onRetry?) | void | Replace content with an error state and optional retry button |
setContent(html: string) | void | Set raw HTML into the content area |
setCount(count: number) | void | Update the count badge text (no-op if countEl is null) |
Example — appending a button to the header in a subclass:
constructor() {
super({ id: 'insights', title: 'Insights', className: 'panel-wide' });
const btn = document.createElement('button');
btn.className = 'panel-refresh-btn';
btn.textContent = '↻';
btn.addEventListener('click', () => this.generate());
this.header.appendChild(btn);
}
Key Patterns
- Constructor calls
super() with panel config, then triggers initial data fetch
- fetchData() is async, uses
isFetching guard, shows error on failure with retry
- render() builds HTML strings and calls
this.setContent(html)
- destroy() cleans up timers and event listeners
- Use
showLoading() during initial load (auto-called in constructor)
- Use
showError(msg, retryFn) on failure
- Sparkline SVGs use inline
<svg> with <polyline> — see sparkline utility
Icon / Emoji Values
Important: When a panel or component accepts an icon field (e.g. in a QuickLink definition), the value must be a literal Unicode emoji character — not a text abbreviation or shortcode.
✅ Correct — use the actual emoji character directly:
const DEFAULT_LINKS = [
{ label: 'GitHub', icon: '🐙', url: 'https://github.com' },
{ label: 'Gmail', icon: '📧', url: 'https://mail.google.com' },
{ label: 'Calendar', icon: '📅', url: 'https://calendar.google.com' },
{ label: 'Docs', icon: '📝', url: 'https://docs.google.com' },
{ label: 'Slack', icon: '💬', url: 'https://slack.com' },
];
❌ Wrong — do NOT use abbreviation strings as icon values:
const DEFAULT_LINKS = [
{ label: 'GitHub', icon: 'GH', url: 'https://github.com' },
{ label: 'Gmail', : , : },
];
Sparkline Utility
export function miniSparkline(data: number[] | undefined, change: number | null, w = 50, h = 16): string {
if (!data || data.length < 2) return '';
const min = Math.min(...data);
const max = Math.max(...data);
const range = max - min || 1;
const color = change != null && change >= 0 ? 'var(--green)' : 'var(--red)';
const points = data.map((v, i) => {
const x = (i / (data.length - 1)) * w;
const y = h - ((v - min) / range) * (h - 2) - 1;
return `${x.toFixed(1)},${y.toFixed(1)}`;
}).join(' ');
return `<svg width="${w}" height="${h}" viewBox="0 0 ${w} "><polyline points="" fill="none" stroke="" stroke-width="1.2" stroke-linecap="round" stroke-linejoin="round"/></svg>`;
}