Dashboard Plugin
Build a data dashboard plugin with charts, stats, and real-time updates.
Overview#
This example builds a monitoring dashboard plugin with:
- Stat cards showing key metrics
- A chart component
- Real-time data refresh via events
- Theme-aware styling
App Component#
TypeScript
| 1 | import { useState, useEffect } from 'react'; |
| 2 | import { usePluginApi, useEvents, useThemeService } from '@naap/plugin-sdk'; |
| 3 | |
| 4 | interface Stats { |
| 5 | totalNodes: number; |
| 6 | activeNodes: number; |
| 7 | totalRequests: number; |
| 8 | errorRate: number; |
| 9 | } |
| 10 | |
| 11 | export default function DashboardApp() { |
| 12 | const api = usePluginApi(); |
| 13 | const events = useEvents(); |
| 14 | const theme = useThemeService(); |
| 15 | const [stats, setStats] = useState<Stats | null>(null); |
| 16 | const [loading, setLoading] = useState(true); |
| 17 | |
| 18 | const loadStats = async () => { |
| 19 | try { |
| 20 | const data = await api.get('/stats'); |
| 21 | setStats(data); |
| 22 | } finally { |
| 23 | setLoading(false); |
| 24 | } |
| 25 | }; |
| 26 | |
| 27 | useEffect(() => { |
| 28 | loadStats(); |
| 29 | |
| 30 | // Refresh every 30 seconds |
| 31 | const interval = setInterval(loadStats, 30000); |
| 32 | |
| 33 | // Also refresh on relevant events |
| 34 | const unsub = events.on('gateway:status-changed', loadStats); |
| 35 | |
| 36 | return () => { |
| 37 | clearInterval(interval); |
| 38 | unsub(); |
| 39 | }; |
| 40 | }, []); |
| 41 | |
| 42 | if (loading) { |
| 43 | return ( |
| 44 | <div className="p-6 grid grid-cols-1 md:grid-cols-4 gap-4"> |
| 45 | {[...Array(4)].map((_, i) => ( |
| 46 | <div key={i} className="h-24 bg-muted animate-pulse rounded-xl" /> |
| 47 | ))} |
| 48 | </div> |
| 49 | ); |
| 50 | } |
| 51 | |
| 52 | return ( |
| 53 | <div className="p-6 space-y-6"> |
| 54 | <h1 className="text-2xl font-bold">Network Dashboard</h1> |
| 55 | |
| 56 | {/* Stat Cards */} |
| 57 | <div className="grid grid-cols-1 sm:grid-cols-2 lg:grid-cols-4 gap-4"> |
| 58 | <StatCard |
| 59 | label="Total Nodes" |
| 60 | value={stats?.totalNodes || 0} |
| 61 | format="number" |
| 62 | /> |
| 63 | <StatCard |
| 64 | label="Active Nodes" |
| 65 | value={stats?.activeNodes || 0} |
| 66 | format="number" |
| 67 | trend={5.2} |
| 68 | /> |
| 69 | <StatCard |
| 70 | label="Total Requests" |
| 71 | value={stats?.totalRequests || 0} |
| 72 | format="compact" |
| 73 | trend={12.8} |
| 74 | /> |
| 75 | <StatCard |
| 76 | label="Error Rate" |
| 77 | value={stats?.errorRate || 0} |
| 78 | format="percent" |
| 79 | trend={-2.1} |
| 80 | invertTrend |
| 81 | /> |
| 82 | </div> |
| 83 | |
| 84 | {/* Placeholder for chart */} |
| 85 | <div className="p-6 rounded-xl border border-border bg-card"> |
| 86 | <h2 className="text-lg font-semibold mb-4">Request Volume</h2> |
| 87 | <div className="h-64 flex items-center justify-center text-muted-foreground"> |
| 88 | Chart would go here (use Recharts or similar) |
| 89 | </div> |
| 90 | </div> |
| 91 | </div> |
| 92 | ); |
| 93 | } |
| 94 | |
| 95 | // Stat Card Component |
| 96 | function StatCard({ |
| 97 | label, |
| 98 | value, |
| 99 | format, |
| 100 | trend, |
| 101 | invertTrend, |
| 102 | }: { |
| 103 | label: string; |
| 104 | value: number; |
| 105 | format: 'number' | 'compact' | 'percent'; |
| 106 | trend?: number; |
| 107 | invertTrend?: boolean; |
| 108 | }) { |
| 109 | const formatted = formatValue(value, format); |
| 110 | const trendColor = trend |
| 111 | ? (trend > 0 ? (invertTrend ? 'text-red-500' : 'text-emerald-500') |
| 112 | : (invertTrend ? 'text-emerald-500' : 'text-red-500')) |
| 113 | : ''; |
| 114 | |
| 115 | return ( |
| 116 | <div className="p-4 rounded-xl border border-border bg-card"> |
| 117 | <p className="text-sm text-muted-foreground">{label}</p> |
| 118 | <p className="text-2xl font-bold mt-1">{formatted}</p> |
| 119 | {trend !== undefined && ( |
| 120 | <p className={`text-sm mt-1 ${trendColor}`}> |
| 121 | {trend > 0 ? '+' : ''}{trend}% |
| 122 | </p> |
| 123 | )} |
| 124 | </div> |
| 125 | ); |
| 126 | } |
| 127 | |
| 128 | function formatValue(value: number, format: string): string { |
| 129 | switch (format) { |
| 130 | case 'compact': |
| 131 | return value >= 1000000 |
| 132 | ? `${(value / 1000000).toFixed(1)}M` |
| 133 | : value >= 1000 |
| 134 | ? `${(value / 1000).toFixed(1)}K` |
| 135 | : String(value); |
| 136 | case 'percent': |
| 137 | return `${value.toFixed(1)}%`; |
| 138 | default: |
| 139 | return value.toLocaleString(); |
| 140 | } |
| 141 | } |
Backend API#
TypeScript
| 1 | // backend/src/routes/stats.ts |
| 2 | import { Router } from 'express'; |
| 3 | |
| 4 | export const statsRoutes = Router(); |
| 5 | |
| 6 | statsRoutes.get('/stats', async (req, res) => { |
| 7 | // In production, query your database or external APIs |
| 8 | const stats = { |
| 9 | totalNodes: 1247, |
| 10 | activeNodes: 892, |
| 11 | totalRequests: 4567890, |
| 12 | errorRate: 0.3, |
| 13 | }; |
| 14 | |
| 15 | res.json(stats); |
| 16 | }); |
Key Patterns Used#
- Polling + Events: Combines interval-based refresh with event-driven updates
- Loading skeletons: Shows animated placeholders while data loads
- Semantic colors: Uses
border-border,bg-card,text-muted-foregroundfor theme compatibility - Responsive grid: Adapts from 1 column on mobile to 4 columns on desktop