--- name: 客戶端後台 UI 統一規範 description: 確保 Star ERP 客戶端(租戶端)後台所有頁面的 UI 元件保持統一的樣式與行為 --- # 客戶端後台 UI 統一規範 ## 概述 本技能提供 Star ERP 系統**客戶端(租戶端)後台**的 UI 統一性規範,確保所有頁面使用一致的元件、樣式類別、圖標和佈局模式。 > **適用範圍**:本規範適用於租戶端後台(使用 `AuthenticatedLayout` 的頁面),**不適用於**中央管理後台(`LandlordLayout`)。 ## 核心原則 1. **使用統一的 UI 組件庫**:優先使用 `@/Components/ui/` 中的 47 個元件 2. **遵循既定的樣式類別**:使用 `app.css` 中定義的自定義按鈕類別 3. **統一的圖標系統**:全面使用 `lucide-react` 圖標 4. **一致的佈局模式**:表格、分頁、操作按鈕等保持相同結構 5. **權限控制**:所有操作按鈕必須使用 `` 元件包裹 --- ## 1. 專案結構 ### 1.1 關鍵目錄 ``` resources/ ├── css/ │ └── app.css # 全域樣式與設計 Token ├── js/ │ ├── Components/ │ │ ├── ui/ # 47 個基礎 UI 元件 (shadcn/ui) │ │ ├── shared/ # 共用業務元件 (Pagination, BreadcrumbNav 等) │ │ └── Permission/ # 權限控制元件 (Can, HasRole, CanAll) │ ├── Layouts/ │ │ ├── AuthenticatedLayout.tsx # 客戶端後台佈局 ⬅️ 本規範適用 │ │ └── LandlordLayout.tsx # 中央管理後台佈局 │ └── Pages/ # 頁面元件 ``` ### 1.2 可用 UI 元件清單 ``` accordion, alert, alert-dialog, avatar, badge, breadcrumb, button, calendar, card, carousel, chart, checkbox, collapsible, command, context-menu, dialog, drawer, dropdown-menu, form, hover-card, input, input-otp, label, menubar, navigation-menu, pagination, popover, progress, radio-group, resizable, scroll-area, searchable-select, select, separator, sheet, sidebar, skeleton, slider, sonner, switch, table, tabs, textarea, toggle, toggle-group, tooltip ``` --- ## 2. 色彩系統 ### 2.1 主題色 (Primary) - **動態租戶品牌色** > **注意**:主題色會根據租戶設定(Branding)動態改變,**嚴禁**在程式碼中 Hardcode 色碼(如 `#01ab83`)。 > 請務必使用 Tailwind Utility Class 或 CSS 變數。 | Tailwind Class | CSS Variable | 說明 | |----------------|--------------|------| | `*-primary-main` | `--primary-main` | **主色**:與租戶設定一致(預設綠色),用於主要按鈕、連結、強調文字 | | `*-primary-dark` | `--primary-dark` | **深色**:系統自動計算,用於 Hover 狀態 | | `*-primary-light` | `--primary-light` | **淺色**:系統自動計算,用於次要強調 | | `*-primary-lightest` | `--primary-lightest` | **最淺色**:系統自動計算,用於背景底色、Active 狀態 | **運作機制**: `AuthenticatedLayout` 會根據後端回傳的 `branding` 資料,自動注入 CSS 變數覆寫預設值。 ```tsx // ✅ 正確:使用 Tailwind Class
...
// ✅ 正確:使用 CSS 變數 (自定義樣式時)
...
// ❌ 錯誤:寫死色碼 (會導致租戶無法換色)
...
``` ### 2.2 灰階 (Grey Scale) ```css --grey-0: #1a1a1a; /* 深黑 - 標題文字 */ --grey-1: #4a4a4a; /* 深灰 - 主要內文 */ --grey-2: #6b6b6b; /* 中灰 - 次要內文、Placeholder */ --grey-3: #9e9e9e; /* 淺灰 - 禁用文字、輔助說明 */ --grey-4: #e0e0e0; /* 極淺灰 - 邊框、分隔線 */ --grey-5: #fff; /* 白色 - 背景、按鈕文字 */ ``` ### 2.3 狀態色 (State Colors) ```css --other-success: #01ab83; /* 成功 - 同主題色 */ --other-error: #dc2626; /* 錯誤 - 刪除、警示 */ --other-warning: #f59e0b; /* 警告 - 提醒、注意 */ --other-info: #3b82f6; /* 資訊 - 說明、提示 */ ``` --- ## 3. 按鈕規範 ### 3.1 按鈕樣式類別 專案在 `resources/css/app.css` 中定義了統一的按鈕樣式,**必須**使用這些類別: #### Filled 按鈕(實心按鈕)— 用於主要操作 ```tsx // ✅ 主要操作按鈕(綠色主題色)- 新增、儲存、確認 // ✅ 成功操作 // ✅ 資訊操作(用於系統提示、說明等非業務主流程) // ✅ 警告操作 // ✅ 錯誤/刪除操作(AlertDialog 內確認按鈕) ``` #### Outlined 按鈕(邊框按鈕)— 用於次要操作 ```tsx // ✅ 編輯按鈕(表格操作列) // ✅ 刪除按鈕(表格操作列) ``` #### Text 按鈕(文字按鈕) ```tsx ``` ### 3.2 按鈕大小 | Size | 高度 | 使用情境 | |------|------|----------| | `size="sm"` | h-8 | 表格操作列、緊湊佈局 | | `size="default"` | h-9 | 一般操作、表單提交 | | `size="lg"` | h-10 | 主要 CTA、頁面主操作 | | `size="icon"` | 9×9 | 純圖標按鈕 | ### 3.3 常見操作按鈕模式 #### 頁面頂部新增按鈕 ```tsx ``` #### 表格操作列檢視按鈕 ```tsx ``` #### 表格操作列編輯按鈕 ```tsx ``` #### 表格操作列刪除按鈕(帶確認對話框) ```tsx 確認刪除 確定要刪除「{item.name}」嗎?此操作無法復原。 取消 handleDelete(item.id)} className="bg-red-600 hover:bg-red-700" > 刪除 ``` ### 3.4 返回按鈕規範 詳情頁面(如:查看庫存、進貨單詳情)的返回按鈕應統一放置於 **頁面標題上方**,並採用「**圖標 + 文字**」的 Outlined 樣式。 **樣式規格**: - **位置**:標題區域上方 (`mb-6`),獨立於標題列 - **樣式**:`variant="outline"` + `className="gap-2 button-outlined-primary"` - **圖標**:`` - **文字**:清楚說明返回目的地,例如「返回倉庫管理」、「返回列表」 ```tsx
``` --- ## 4. 圖標規範 ### 4.1 統一使用 lucide-react **統一使用 `lucide-react`**,禁止使用其他圖標庫(如 FontAwesome、Material Icons、react-icons 等)。 ### 4.2 圖標尺寸標準 | 尺寸 | 類別 | 使用情境 | |------|------|----------| | 小型 | `h-3 w-3` | Badge 內、小文字旁 | | 標準 | `h-4 w-4` | 按鈕內、表格操作 | | 標題 | `h-5 w-5` | 側邊欄選單 | | 大型 | `h-6 w-6` | 頁面標題 | ### 4.3 常用操作圖標映射 | 操作 | 圖標組件 | 使用情境 | |------|----------|----------| | 新增 | `` | 新增按鈕 | | 編輯 | `` | 編輯按鈕 | | 刪除 | `` | 刪除按鈕 | | 查看 | `` | 查看詳情 | | 搜尋 | `` | 搜尋欄位 | | 篩選 | `` | 篩選功能 | | 下載 | `` | 下載/匯出 | | 上傳 | `` | 上傳/匯入 | | 設定 | `` | 設定功能 | | 複製 | `` | 複製內容 | | 郵件 | `` | Email 顯示 | | 使用者 | ``, `` | 使用者管理 | | 權限 | `` | 角色/權限 | | 排序 | ``, ``, `` | 表格排序 | | 儀表板 | `` | 首頁/總覽 | | 商品 | `` | 商品管理 | | 倉庫 | `` | 倉庫管理 | | 廠商 | ``, `` | 廠商管理 | | 採購 | `` | 採購管理 | ### 4.4 圖標使用範例 ```tsx import { Plus, Pencil, Trash2, Users } from 'lucide-react'; // 頁面標題

使用者管理

// 按鈕內圖標(圖標在左,帶文字) // 純圖標按鈕(表格操作列) ``` --- ## 5. 表格規範 ### 5.1 表格容器 ```tsx
{/* 表格內容 */}
``` ### 5.2 表格標題列 ```tsx # 名稱 操作 ``` **關鍵要點**: - 使用 `bg-gray-50` 背景色 - 序號欄位固定寬度 `w-[50px]` 並置中 - 操作欄位置中顯示 ### 5.3 表格主體 ```tsx {items.length === 0 ? ( 無符合條件的資料 ) : ( items.map((item, index) => ( {startIndex + index} {/* 其他欄位 */}
{/* 操作按鈕 */}
)) )}
``` **關鍵要點**: - 空狀態訊息使用置中、灰色文字 - 序號欄使用 `text-gray-500 font-medium text-center` - 操作欄使用 `flex items-center justify-center gap-2` 排列按鈕 ### 5.4 欄位排序規範 當表格需要支援排序時,請遵循以下模式: 1. **圖標邏輯**: * 未排序:`ArrowUpDown` (class: `text-muted-foreground`) * 升冪 (asc):`ArrowUp` (class: `text-primary`) * 降冪 (desc):`ArrowDown` (class: `text-primary`) 2. **結構**:在 `TableHead` 內使用 `button` 元素。 3. **後端配合**:後端 Controller **必須** 處理 `sort_by` 與 `sort_order` 參數。 ```tsx // 1. 定義 Helper Component (在元件內部) const SortIcon = ({ field }: { field: string }) => { if (filters.sort_by !== field) { return ; } if (filters.sort_order === "asc") { return ; } return ; }; // 2. 表格標題應用 // 3. 排序處理函式 (三態切換:未排序 -> 升冪 -> 降冪 -> 未排序) const handleSort = (field: string) => { let newSortBy: string | undefined = field; let newSortOrder: 'asc' | 'desc' | undefined = 'asc'; if (filters.sort_by === field) { if (filters.sort_order === 'asc') { newSortOrder = 'desc'; } else { // desc -> reset (回到預設排序) newSortBy = undefined; newSortOrder = undefined; } } router.get( route(route().current()!), { ...filters, sort_by: newSortBy, sort_order: newSortOrder }, { preserveState: true, replace: true } ); }; ``` --- ## 6. 分頁規範 ### 6.1 統一分頁元件 使用 `@/Components/shared/Pagination` 元件: ```tsx import Pagination from "@/Components/shared/Pagination"; import { SearchableSelect } from "@/Components/ui/searchable-select"; // 在表格下方
每頁顯示
``` ### 6.2 每頁筆數狀態管理 ```tsx const [perPage, setPerPage] = useState(filters.per_page || "10"); const handlePerPageChange = (value: string) => { setPerPage(value); router.get( route('resource.index'), { per_page: value }, { preserveState: false, replace: true, preserveScroll: true } ); }; ``` --- ## 7. Badge 與狀態顯示 ### 7.1 基本 Badge ```tsx import { Badge } from "@/Components/ui/badge"; // Outline 樣式(最常用) {item.category?.name || '-'} // 預設樣式(主題色背景) 啟用中 // 錯誤樣式 停用 ``` ### 7.2 角色顯示(特殊樣式) ```tsx
{user.roles.map(role => (
{role.name === 'super-admin' && } {role.display_name}
))}
``` --- ## 8. 頁面佈局規範 ### 8.1 頁面結構 ```tsx export default function ResourceIndex() { return (
{/* 頁面頭部 */} {/* 主要內容 */} {/* 分頁元件 */}
); } ``` ### 8.2 標準頁面頭部 ```tsx

頁面標題

頁面說明文字

``` --- ## 9. 權限控制規範 ### 9.1 使用 Can 元件 **所有**涉及權限的 UI 元素都必須使用 `` 元件包裹: ```tsx import { Can } from "@/Components/Permission/Can"; {/* 新增按鈕 */} {/* 編輯按鈕 */} {/* 刪除按鈕 */} ``` ### 9.2 權限命名規範 遵循 `resource.action` 格式: - `resource.view`:查看列表/詳情 - `resource.create`:新增 - `resource.edit`:編輯 - `resource.delete`:刪除 ### 9.3 多權限判斷 ```tsx // 滿足任一權限即可
管理操作
// 必須滿足所有權限 import { CanAll } from "@/Components/Permission/Can"; ``` --- ## 10. 通知訊息規範 ### 10.1 使用 Toast 通知 使用 `sonner` 的 `toast` 進行通知: ```tsx import { toast } from 'sonner'; // 成功訊息 toast.success('操作成功'); // 錯誤訊息 toast.error('操作失敗'); // 資訊訊息 toast.info('提示訊息'); // 警告訊息 toast.warning('警告訊息'); ``` ### 10.2 常見操作的 Toast 訊息 ```tsx // 新增成功 router.post(route('resource.store'), data, { onSuccess: () => toast.success('新增成功'), onError: () => toast.error('新增失敗,請檢查輸入內容'), }); // 更新成功 router.put(route('resource.update', id), data, { onSuccess: () => toast.success('更新成功'), onError: () => toast.error('更新失敗'), }); // 刪除成功 router.delete(route('resource.destroy', id), { onSuccess: () => toast.success('已刪除'), onError: () => toast.error('刪除失敗,請檢查權限'), }); ``` --- ## 11. 表單規範 ### 11.1 表單容器 ```tsx
{/* 表單欄位 */}
``` ### 11.2 表單欄位 ```tsx
setData("field", e.target.value)} placeholder="請輸入..." className="w-full px-4 py-2 border border-slate-300 rounded-lg focus:ring-2 focus:ring-primary-main focus:border-primary-main" /> {errors.field &&

{errors.field}

}
``` ### 11.3 下拉選單 使用 `SearchableSelect` 元件: ```tsx import { SearchableSelect } from "@/Components/ui/searchable-select"; setData("category_id", value)} options={categories.map(cat => ({ label: cat.name, value: String(cat.id) }))} placeholder="請選擇分類" searchThreshold={10} // 超過 10 個選項才顯示搜尋框 /> ``` --- ## 11.4 對話框 (Dialog) 滾動與佈局 當對話框內容可能超出螢幕高度時(如長表單或詳細資料),**請勿使用 `ScrollArea`**,應直接在 `DialogContent` 使用原生的 `overflow-y-auto`。 **原因**:`ScrollArea` 在 Flex 佈局計算高度時容易失效或導致雙重滾動條。以及與原生捲動行為不一致。 ```tsx // ❌ 錯誤:使用 ScrollArea 或固定高度計算 {/* 內容 */} // ✅ 正確:直接使用 overflow-y-auto 與 max-h ...
{/* 內容會自動滾動 */}
...
``` --- ## 11.5 輸入框尺寸 (Input Sizes) 為確保介面整齊與統一,所有表單輸入元件標準高度應為 **`h-9`** (36px),與標準按鈕尺寸對齊。 - **Input**: 預設即為 `h-9` (由 `py-1` 與 `text-sm` 組合而成) - **Select / SearchableSelect**: 必須確保 Trigger 按鈕高度為 `h-9` - **禁止使用**: 除非有特殊設計需求,否則避免使用 `h-10` (40px) 或其他非標準高度。 ## 11.6 日期輸入框樣式 (Date Input Style) 日期輸入框應採用「**左側裝飾圖示 + 右側原生操作**」的配置,以保持視覺一致性並保留瀏覽器原生便利性。 **樣式規格**: 1. **容器**: 使用 `relative` 定位。 2. **圖標**: 使用 `Calendar` 圖標,放置於絕對位置 `absolute left-2.5 top-2.5`,顏色 `text-gray-400`,並設定 `pointer-events-none` 避免干擾點擊。 3. **輸入框**: 設定 `pl-9` (左內距) 以避開圖示,並使用原生 `type="date"` 或 `type="datetime-local"`。 ```tsx import { Calendar } from "lucide-react"; import { Input } from "@/Components/ui/input";
setDate(e.target.value)} />
``` ## 11.7 搜尋選單樣式 (SearchableSelect Style) `SearchableSelect` 元件在表單或篩選列中使用時,高度必須設定為 `h-9` 以與輸入框對齊。 ```tsx ``` ## 11.8 篩選列規範 (Filter Bar Norms) 列表頁面的篩選區域(Filter Bar)應遵循以下規範以節省空間並保持層級清晰: 1. **標籤文字 (Labels)**: 使用 **`text-xs`** (`12px`) 大小,顏色建議使用 `text-gray-500` 或 `text-grey-2`。這與一般表單 (`text-sm`) 不同,目的是降低篩選列的視覺權重。 2. **輸入元件高度**: 統一使用 **`h-9`** (`36px`)。 3. **佈局**: - **容器內距**: 統一使用 **`p-5`** (`20px`)。 - **Grid 間距**: 建議使用 **`gap-4`** (`16px`) 或 `gap-6` (`24px`),但同一專案內需統一。本專案推薦 **`gap-4`**。 - **垂直間距**: Label 與 Input 之間使用 **`space-y-1`** (`4px`)。 - **排版**: 建議使用 Grid 系統 (`grid-cols-12`) 進行排版。 ```tsx
``` 4. **操作按鈕區 (Action Bar)**: - **位置**: 位於篩選列最下方。 - **樣式**: 統一使用 `flex items-center justify-end border-t border-grey-4 pt-5 gap-3`。 - **說明**: `border-grey-4` 為標準通用邊框色,`pt-5` 與容器 padding (`p-5`) 呼應,維持視覺平衡。 5. **收合模式 (Collapsible Mode)**: - **目的**: 節省垂直空間,預設隱藏較佔空間與低頻使用的篩選器(如日期區間)。 - **實作**: - 預設狀態:若無相關篩選值,則預設為 **收合 (Collapsed)**。 - 切換按鈕:位於 Action Bar 左側 (`mr-auto`)。 - 樣式:Ghost Button + `ChevronDown`/`ChevronUp` Icon + 提示圓點 (Indicator)。 - **邏輯**: 若載入頁面時已有被隱藏的篩選值 (e.g. `date_start`),則強制 **展開 (Expanded)** 或顯示提示。 --- ## 12. 檢查清單 在開發或審查頁面時,請確認以下項目: ### ✅ 按鈕 - [ ] 使用 `button-filled-*` 或 `button-outlined-*` 類別 - [ ] 主要操作使用 `button-filled-primary` - [ ] 編輯操作使用 `button-outlined-primary` - [ ] 刪除操作使用 `button-outlined-error` - [ ] 按鈕尺寸正確(sm/default/lg) - [ ] 包含適當的圖標 ### ✅ 圖標 - [ ] 全部使用 `lucide-react` - [ ] 尺寸正確(h-3/h-4/h-5/h-6) - [ ] 顏色與上下文一致 ### ✅ 表格 - [ ] 使用 `@/Components/ui/table` 元件 - [ ] 有 `bg-white rounded-xl border` 容器 - [ ] 標題列有 `bg-gray-50` 背景 - [ ] 序號欄固定寬度並置中 - [ ] 操作欄使用 `flex justify-center gap-2` - [ ] 空狀態訊息置中顯示 ### ✅ 分頁 - [ ] 使用 `@/Components/shared/Pagination` - [ ] 有每頁筆數選擇器(10/20/50/100) ### ✅ 權限 - [ ] 所有操作按鈕都用 `` 包裹 - [ ] 權限命名符合 `resource.action` 格式 ### ✅ 通知 - [ ] 使用 `toast` 提供操作反饋 - [ ] 成功/錯誤訊息明確 ### ✅ 整體 - [ ] 頁面有標準頭部(標題 + 圖標 + 說明 + 新增按鈕) - [ ] 容器寬度使用 `max-w-7xl` - [ ] 使用正確的佈局(`AuthenticatedLayout`) --- ## 13. 常見錯誤與修正 ### ❌ 錯誤:自定義按鈕樣式 ```tsx // ❌ 錯誤 // ✅ 正確 ``` ### ❌ 錯誤:混用圖標庫 ```tsx // ❌ 錯誤 import { FaEdit } from 'react-icons/fa'; // ✅ 正確 import { Pencil } from 'lucide-react'; ``` ### ❌ 錯誤:操作欄未置中 ```tsx // ❌ 錯誤 // ✅ 正確
``` ### ❌ 錯誤:缺少權限控制 ```tsx // ❌ 錯誤 // ✅ 正確 ``` --- ## 14. 參考範例 以下頁面展示了完整的 UI 統一性實踐: - **使用者管理**:`resources/js/Pages/Admin/User/Index.tsx` - **角色管理**:`resources/js/Pages/Admin/Role/Index.tsx` - **產品管理**:`resources/js/Pages/Product/Index.tsx` - **倉庫管理**:`resources/js/Pages/Warehouse/Index.tsx` --- ## 總結 遵循本規範可確保: 1. ✅ **視覺一致性**:所有頁面看起來像同一個系統 2. ✅ **維護效率**:使用統一組件,修改一處即可影響全局 3. ✅ **開發速度**:有明確的模式可循,減少決策時間 4. ✅ **使用者體驗**:一致的互動模式降低學習成本 5. ✅ **安全性**:統一的權限控制確保資料安全 當你在開發或審查 Star ERP 客戶端後台的 UI 時,請務必參考此規範!