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 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 | /** * Shop Feature Types * * Centralized type definitions for shop-related components including * search, filters, and product display. * * @module types/shop */ // ============================================================================ // Search Types // ============================================================================ /** * Search Bar Component Props * * Props for the SearchBar component that handles product search functionality. * * @example * ```tsx * <SearchBar * onSearch={(query) => handleSearch(query)} * placeholder="Search products..." * /> * ``` */ export interface SearchBarProps { /** Callback function triggered when search is performed */ onSearch?: (query: string) => void; /** Placeholder text for the search input */ placeholder?: string; } // ============================================================================ // Filter Types // ============================================================================ /** * Sort By Option * * Available sorting options for product listings. */ export type SortByOption = "price_asc" | "price_desc" | "rating" | "newest" | "popularity"; /** * Filter State * * Represents the current state of all active filters applied to product listings. * * @example * ```tsx * const filters: FilterState = { * categories: [1, 3, 5], * minPrice: 50, * maxPrice: 500, * minRating: 4, * sortBy: "price_asc", * inStock: true * }; * ``` */ export interface FilterState { /** Array of selected category IDs */ categories: number[]; /** Minimum price filter value */ minPrice: number; /** Maximum price filter value */ maxPrice: number; /** Minimum rating filter (1-5 stars) */ minRating: number; /** Sort order for product results */ sortBy: SortByOption; /** Filter to show only in-stock products */ inStock: boolean; } /** * Category Filter Option * * Represents a product category with count for filtering. * * @example * ```tsx * const category: Category = { * id: 1, * title: "Bounce Houses", * count: 42 * }; * ``` */ export interface Category { /** Unique category identifier */ id: number; /** Display name of the category */ title: string; /** Number of products in this category */ count: number; } /** * Filter Panel Component Props * * Props for the FilterPanel component that displays all filter controls. * * @example * ```tsx * <FilterPanel * onFiltersChange={(filters) => applyFilters(filters)} * /> * ``` */ export interface FilterPanelProps { /** Callback function triggered when filters are changed */ onFiltersChange?: (filters: FilterState) => void; } // ============================================================================ // Price Range Types // ============================================================================ /** * Price Range * * Represents the minimum and maximum price values for filtering. * * @example * ```tsx * const priceRange: PriceRange = { * min: 0, * max: 10000 * }; * ``` */ export interface PriceRange { /** Minimum price value */ min: number; /** Maximum price value */ max: number; } // ============================================================================ // Filter Options Types // ============================================================================ /** * Filter Options Data * * Contains all available filter options fetched from the API. * * @example * ```tsx * const filterOptions: FilterOptionsData = { * categories: [...], * priceRange: { min: 0, max: 10000 } * }; * ``` */ export interface FilterOptionsData { /** Available product categories with counts */ categories: Category[]; /** Available price range for products */ priceRange: PriceRange; } // ============================================================================ // Product Display Types // ============================================================================ /** * Product Card Props * * Props for displaying a single product card in the shop grid. * * @example * ```tsx * <ProductCard * productId={123} * layout="grid" * showQuickView={true} * /> * ``` */ export interface ProductCardProps { /** Product ID to display */ productId: number; /** Layout mode for the product card */ layout?: 'grid' | 'list'; /** Show quick view button */ showQuickView?: boolean; /** Show add to cart button */ showAddToCart?: boolean; /** Custom className for styling */ className?: string; } /** * Shop Grid Layout * * Layout options for the product grid. */ export type ShopGridLayout = 'grid-2' | 'grid-3' | 'grid-4' | 'list'; /** * Shop View Mode * * Viewing mode for the shop page. */ export type ShopViewMode = 'with-sidebar' | 'without-sidebar' | 'fullwidth'; /** * Products Per Page Option * * Available options for number of products to display per page. */ export type ProductsPerPageOption = 9 | 12 | 18 | 24 | 36; // ============================================================================ // Sidebar Types // ============================================================================ /** * Shop Sidebar Props * * Props for the shop sidebar component containing filters and categories. * * @example * ```tsx * <ShopSidebar * isOpen={sidebarOpen} * onClose={() => setSidebarOpen(false)} * /> * ``` */ export interface ShopSidebarProps { /** Whether the sidebar is open (for mobile) */ isOpen?: boolean; /** Callback to close the sidebar */ onClose?: () => void; /** Custom className for styling */ className?: string; } // ============================================================================ // Pagination Types // ============================================================================ /** * Pagination Info * * Information about the current pagination state. * * @example * ```tsx * const pagination: PaginationInfo = { * currentPage: 1, * totalPages: 10, * totalItems: 100, * itemsPerPage: 12 * }; * ``` */ export interface PaginationInfo { /** Current page number (1-based) */ currentPage: number; /** Total number of pages */ totalPages: number; /** Total number of items across all pages */ totalItems: number; /** Number of items per page */ itemsPerPage: number; } // ============================================================================ // Shop Data Types // ============================================================================ /** * Shop Page Data * * Complete data structure for shop page including products, filters, and pagination. * * @example * ```tsx * const shopData: ShopPageData = { * products: [...], * filters: {...}, * pagination: {...}, * filterOptions: {...} * }; * ``` */ export interface ShopPageData { /** Array of product IDs to display */ products: number[]; /** Currently applied filters */ filters: FilterState; /** Pagination information */ pagination: PaginationInfo; /** Available filter options */ filterOptions: FilterOptionsData; } |