Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 | 'use client'; import React from 'react'; /** * DataList Component * * A generic, memoized list component using render props pattern. * Provides consistent patterns for rendering collections with loading, * empty states, and optimized re-rendering. * * @example * ```tsx * <DataList * items={products} * keyExtractor={(p) => p.id} * renderItem={(product) => <ProductCard product={product} />} * renderEmpty={() => <EmptyState message="No products found" />} * /> * ``` */ import { memo, ReactNode, useMemo } from 'react'; import { cn } from '@/lib/core'; // ============================================================================ // TYPES // ============================================================================ export interface DataListProps<T> { /** Array of items to render */ items: T[]; /** Function to extract a unique key from each item */ keyExtractor: (item: T, index: number) => string | number; /** Function to render each item */ renderItem: (item: T, index: number) => ReactNode; /** Optional function to render when items array is empty */ renderEmpty?: () => ReactNode; /** Optional function to render a loading state */ renderLoading?: () => ReactNode; /** Whether the list is currently loading */ isLoading?: boolean; /** Additional CSS classes for the container */ className?: string; /** Layout variant */ layout?: 'list' | 'grid'; /** Number of grid columns (when layout is 'grid') */ gridCols?: 1 | 2 | 3 | 4 | 5 | 6; /** Gap between items */ gap?: 'none' | 'sm' | 'md' | 'lg'; /** Optional header element */ header?: ReactNode; /** Optional footer element */ footer?: ReactNode; /** Optional separator between items */ separator?: ReactNode; /** Whether items should have dividers */ divided?: boolean; } // ============================================================================ // COMPONENT // ============================================================================ function DataListInner<T>({ items, keyExtractor, renderItem, renderEmpty, renderLoading, isLoading = false, className, layout = 'list', gridCols = 4, gap = 'md', header, footer, separator, divided = false, }: DataListProps<T>) { // Gap classes const gapStyles = { none: 'gap-0', sm: 'gap-2', md: 'gap-4', lg: 'gap-6', }; // Grid column classes const gridColStyles = { 1: 'grid-cols-1', 2: 'sm:grid-cols-2', 3: 'sm:grid-cols-2 lg:grid-cols-3', 4: 'sm:grid-cols-2 lg:grid-cols-4', 5: 'sm:grid-cols-2 lg:grid-cols-3 xl:grid-cols-5', 6: 'sm:grid-cols-2 lg:grid-cols-3 xl:grid-cols-6', }; // Layout classes const layoutStyles = { list: 'flex flex-col', grid: `grid grid-cols-1 ${gridColStyles[gridCols]}`, }; // Memoize rendered items const renderedItems = useMemo(() => { return items.map((item, index) => { const key = keyExtractor(item, index); const rendered = renderItem(item, index); const isLast = index === items.length - 1; return ( <div key={key} className={cn( divided && !isLast && layout === 'list' && 'border-b border-gray-200 dark:border-gray-700 pb-4' )} > {rendered} {separator && !isLast && layout === 'list' && ( <div className="my-2">{separator}</div> )} </div> ); }); }, [items, keyExtractor, renderItem, separator, divided, layout]); // Loading state if (isLoading && renderLoading) { return <>{renderLoading()}</>; } // Empty state if (items.length === 0) { if (renderEmpty) { return <>{renderEmpty()}</>; } return null; } return ( <div className={className}> {header && <div className="mb-4">{header}</div>} <div className={cn(layoutStyles[layout], gapStyles[gap])}> {renderedItems} </div> {footer && <div className="mt-4">{footer}</div>} </div> ); } // Memoize the component export const DataList = memo(DataListInner) as typeof DataListInner; // ============================================================================ // SPECIALIZED VARIANTS // ============================================================================ /** * GridList - Pre-configured DataList for grid layouts */ export function GridList<T>( props: Omit<DataListProps<T>, 'layout'> ): React.ReactElement { return <DataList {...props} layout="grid" />; } /** * StackList - Pre-configured DataList for vertical stack layouts */ export function StackList<T>( props: Omit<DataListProps<T>, 'layout'> ): React.ReactElement { return <DataList {...props} layout="list" />; } // ============================================================================ // LOADING SKELETON // ============================================================================ interface DataListSkeletonProps { /** Number of skeleton items to show */ count?: number; /** Layout variant */ layout?: 'list' | 'grid'; /** Grid columns (when layout is 'grid') */ gridCols?: 1 | 2 | 3 | 4 | 5 | 6; /** Height of each skeleton item */ itemHeight?: string; /** Additional CSS classes */ className?: string; } export function DataListSkeleton({ count = 4, layout = 'grid', gridCols = 4, itemHeight = 'h-48', className, }: DataListSkeletonProps) { const gridColStyles = { 1: 'grid-cols-1', 2: 'sm:grid-cols-2', 3: 'sm:grid-cols-2 lg:grid-cols-3', 4: 'sm:grid-cols-2 lg:grid-cols-4', 5: 'sm:grid-cols-2 lg:grid-cols-3 xl:grid-cols-5', 6: 'sm:grid-cols-2 lg:grid-cols-3 xl:grid-cols-6', }; return ( <div className={cn( layout === 'grid' ? `grid grid-cols-1 ${gridColStyles[gridCols]} gap-4` : 'flex flex-col gap-4', className )} > {Array.from({ length: count }).map((_, i) => ( <div key={i} className={cn( 'animate-pulse bg-gray-200 dark:bg-gray-700 rounded-lg', itemHeight )} /> ))} </div> ); } // ============================================================================ // EMPTY STATE // ============================================================================ interface DataListEmptyProps { /** Message to display */ message?: string; /** Description text */ description?: string; /** Icon to display */ icon?: ReactNode; /** Action button */ action?: ReactNode; /** Additional CSS classes */ className?: string; } export function DataListEmpty({ message = 'No items found', description, icon, action, className, }: DataListEmptyProps) { return ( <div className={cn( 'flex flex-col items-center justify-center py-12 text-center', className )} > {icon && ( <div className="mb-4 text-gray-400 dark:text-gray-500">{icon}</div> )} <h3 className="text-lg font-medium text-gray-900 dark:text-white"> {message} </h3> {description && ( <p className="mt-1 text-sm text-gray-500 dark:text-gray-400"> {description} </p> )} {action && <div className="mt-4">{action}</div>} </div> ); } export default DataList; |