aicde-ui 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +75 -52
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,8 +1,11 @@
1
- # aicde-ui(React)
1
+ <p align="center"><img src="https://zhijian090195.github.io/library/assets/aicde-mark.png" width="80" alt="AICDE"></p>
2
2
 
3
- AICDE 風格的 React 元件庫。樣式沿用網站的 `aicde-ui.css`,元件只負責結構、狀態與無障礙屬性。
3
+ # aicde-ui
4
4
 
5
- 元件文件與範例:https://zhijian090195.github.io/library/
5
+ 給 React 用的現成元件:按鈕、輸入框、表格、對話框、通知……裝好就能用,還能一鍵換成 15 種風格。
6
+
7
+ - **看所有元件和範例**:https://zhijian090195.github.io/library/
8
+ - **原始碼**:https://github.com/zhijian090195/library
6
9
 
7
10
  ## 安裝
8
11
 
@@ -10,79 +13,99 @@ AICDE 風格的 React 元件庫。樣式沿用網站的 `aicde-ui.css`,元件
10
13
  npm install aicde-ui
11
14
  ```
12
15
 
13
- 字型(建議,放在 `<head>` 或你的全域 CSS):
16
+ 需要 React 18 以上。
14
17
 
15
- ```html
16
- <link href="https://fonts.googleapis.com/css2?family=Poppins:wght@500;600;700&family=Noto+Sans+TC:wght@400;500;700&family=JetBrains+Mono:wght@500;700&family=Noto+Serif+TC:wght@700&display=swap" rel="stylesheet">
17
- ```
18
+ ## 三步開始用
19
+
20
+ **1. 在入口檔案引入樣式(只要一次)**
18
21
 
19
- ## 使用
22
+ 一般 React 專案放在 `main.jsx`;Next.js 放在 `app/layout.jsx`。
20
23
 
21
24
  ```tsx
22
- import { Button, Tabs, Toaster, toast } from 'aicde-ui';
23
25
  import 'aicde-ui/style.css';
26
+ ```
27
+
28
+ **2. 在要用的地方引入元件**
29
+
30
+ ```tsx
31
+ import { Button, Toaster, toast } from 'aicde-ui';
24
32
 
25
33
  export default function App() {
26
34
  return (
27
35
  <>
28
- <Button variant="primary" onClick={() => toast('已儲存', { type: 'success' })}>儲存</Button>
36
+ <Button variant="primary" onClick={() => toast('已儲存', { type: 'success' })}>
37
+ 儲存
38
+ </Button>
29
39
  <Toaster />
30
40
  </>
31
41
  );
32
42
  }
33
43
  ```
34
44
 
35
- 需要 React 18 以上。`toast()` 和 `notify()` 要在畫面上放一個 `<Toaster />` 才看得到。`Button` 不指定 `variant` 時是外框按鈕。所有元件都標了 `"use client"`,可以直接在 Next.js App Router 裡使用。
45
+ **3.(建議)加上字型**
36
46
 
37
- ## 主題
47
+ 放在網頁的 `<head>` 裡,字會比較好看:
38
48
 
39
- ```tsx
40
- <ThemeProvider theme="riso" mode="dark">…</ThemeProvider>
49
+ ```html
50
+ <link href="https://fonts.googleapis.com/css2?family=Poppins:wght@500;600;700&family=Noto+Sans+TC:wght@400;500;700&family=JetBrains+Mono:wght@500;700&family=Noto+Serif+TC:wght@700&display=swap" rel="stylesheet">
41
51
  ```
42
52
 
43
- `theme`:
53
+ **小提醒**
44
54
 
45
- | 值 | 風格 |
46
- |---|---|
47
- | `default`(預設) | 紙雕分層,AICDE 原色:有厚度的紙片、按下壓到底、卡片後疊兩張彩紙 |
48
- | `clean` | 無裝飾的簡潔版 |
49
- | `paper` | 暖米色紙雕 |
50
- | `ink` | 混合媒材手繪:墨線、不規則圓角、紙膠帶 |
51
- | `soft` | 柔光立體:膠囊、光澤、霧面玻璃 |
52
- | `riso` | 網點絲印:半色調、套色錯位 |
53
- | `brutal` | 新粗野:粗線、直角、等寬字 |
54
- | `stitch` | 手縫布藝:車縫虛線、鈕扣開關 |
55
- | `ticket` | 水彩票根:打孔缺口、撕線、水彩暈染 |
56
- | `block` | 啞光積木:倒角、厚底 |
57
- | `blueprint` | 藍圖線稿:方格、裁切角標、紅筆標註 |
58
- | `clinical` | 醫療:主要色用深藍、珊瑚只留給警示;44px 點擊範圍、清楚的 focus |
59
- | `cute` | 可愛:大圓角、粉嫩色、貼紙描邊、彈跳動畫 |
60
- | `finance` | 金融:高密度、4px 圓角、等寬數字、細線分隔 |
61
- | `editorial` | 編輯:襯線標題、髮絲線、小型大寫,雜誌感 |
62
-
63
- `mode`:`light`/`dark`/`system`。不用 React 時,在 `<html>` 加 `data-theme-style="ink"` 也一樣。
64
-
65
- ## 元件
66
-
67
- | 分類 | 元件 |
68
- |---|---|
69
- | 通用 | Button、Divider、FloatButton、BackTop、ThemeProvider |
70
- | 導覽 | Tabs、Pagination、Dropdown、Breadcrumb、Steps、Menu、CommandPalette、ContextMenu |
71
- | 回饋 | Modal、Drawer、toast()/notify()+`<Toaster/>`、Alert、Progress、Skeleton、Spinner、Popover、Result、Banner |
72
- | 輸入、資料展示 | 見 `src/groups/entry.ts`、`src/groups/display.ts` |
55
+ - 要跳通知(`toast`、`notify`),畫面上要放一個 `<Toaster />`。
56
+ - Next.js 可以直接用,不用另外設定。
57
+
58
+ ## 換風格
73
59
 
74
- 有狀態的元件都同時支援受控(`value`/`open`/`activeKey`)與非受控(`default*`)用法。
60
+ 用 `ThemeProvider` 包起來,`theme` 填風格名稱:
75
61
 
76
- ## 指令
62
+ ```tsx
63
+ import { ThemeProvider } from 'aicde-ui';
64
+
65
+ <ThemeProvider theme="cute" mode="dark">
66
+ <App />
67
+ </ThemeProvider>
68
+ ```
77
69
 
78
- | 指令 | 用途 |
70
+ `mode` 可以填 `light`(淺色)、`dark`(深色)或 `system`(跟著電腦設定)。
71
+
72
+ | theme | 風格 | 適合 |
73
+ |---|---|---|
74
+ | `default` | 紙雕(預設):像紙一層層疊起來 | 品牌官網、一般產品 |
75
+ | `clean` | 簡潔:細框、沒有陰影 | 後台、工具 |
76
+ | `paper` | 暖紙雕:米色紙張 | 餐飲、文創 |
77
+ | `ink` | 混合媒材:手繪墨線 | 創意工作室、教育 |
78
+ | `soft` | 柔光:圓圓的、柔和陰影 | 消費型 App、健康 |
79
+ | `riso` | 網點絲印:印刷網點 | 活動、出版 |
80
+ | `brutal` | 新粗野:粗黑框、直角 | 開發者工具、新創 |
81
+ | `stitch` | 手縫布藝:車縫虛線 | 手作、親子、寵物 |
82
+ | `ticket` | 水彩票根:打孔、水彩 | 旅遊、售票 |
83
+ | `block` | 積木:厚底、立體 | 遊戲、兒童 |
84
+ | `blueprint` | 藍圖:工程細線 | 工程、建築 |
85
+ | `clinical` | 醫療:海藍色、按鈕大好點 | 醫院、保險、政府 |
86
+ | `cute` | 可愛:大圓角、會彈跳 | 寵物、兒童、社群 |
87
+ | `finance` | 金融:資訊密集、數字對齊 | 交易平台、報表 |
88
+ | `editorial` | 編輯:雜誌感、襯線標題 | 媒體、部落格 |
89
+
90
+ ## 有哪些元件
91
+
92
+ | 類別 | 元件 |
79
93
  |---|---|
80
- | `npm run build` | tsup 輸出 ESM/CJS/型別,並複製 CSS 到 `dist/style.css` |
81
- | `npm run typecheck` | TypeScript 型別檢查 |
82
- | `npm run smoke` | 用 SSR 把每個元件 renderToString 一次,有 console.error 就失敗 |
94
+ | 通用 | `Button` 按鈕、`Divider` 分隔線、`FloatButton` 浮動按鈕、`BackTop` 回到頂部 |
95
+ | 導覽 | `Tabs` 分頁標籤、`Pagination` 頁碼、`Dropdown` 下拉選單、`Breadcrumb` 麵包屑、`Steps` 步驟、`Menu` 側邊選單、`CommandPalette` 指令面板、`ContextMenu` 右鍵選單 |
96
+ | 輸入 | `Input` 輸入框、`Textarea` 多行輸入、`Select` 下拉選擇、`Checkbox` 勾選、`Radio` 單選、`Switch` 開關、`Segmented` 分段切換、`Slider` 滑桿、`InputNumber` 數字、`OtpInput` 驗證碼、`Autocomplete` 自動完成、`Cascader` 多層選擇、`ColorPicker` 選色、`DatePicker` 日期、`RangePicker` 日期範圍、`Rating` 評分、`Upload` 上傳、`TagInput` 標籤輸入、`Transfer` 穿梭框、`Field` 欄位標題與錯誤訊息 |
97
+ | 展示 | `Card` 卡片、`Tag` 標籤、`Badge` 徽章、`Avatar` 頭像、`Table` 表格、`DataTable` 可排序表格、`List` 列表、`Descriptions` 資料欄位、`Statistic` 數字、`Timeline` 時間軸、`Collapse` 折疊、`Tooltip` 提示、`Calendar` 月曆、`Tree` 樹狀、`Carousel` 輪播、`ImagePreview` 看大圖、`Empty` 空狀態、`Kbd` 鍵盤按鍵 |
98
+ | 回饋 | `Modal` 對話框、`Drawer` 側邊抽屜、`toast()` / `notify()` 通知、`Alert` 提示、`Banner` 橫幅、`Progress` 進度條、`Spinner` 轉圈、`Skeleton` 載入佔位、`Popover` 彈出卡片、`Result` 結果頁 |
83
99
 
84
- ## 授權
100
+ 每個元件怎麼用、有哪些參數,網站上都有範例。
101
+
102
+ **兩種寫法都可以**:元件可以讓它自己記住狀態(例如 `defaultValue`),也可以由你控制(例如 `value` + `onChange`)。
103
+
104
+ ## 好操作
85
105
 
86
- MIT
106
+ 按鈕、輸入框、下拉選擇、對話框、表格這幾個最常用的元件,都測試過只用鍵盤也能操作,視障者用的讀屏軟體也念得出來。
107
+
108
+ ## 授權
87
109
 
88
- AICDE 名稱與 logo 不在 MIT 授權範圍內。
110
+ - 程式碼是 MIT 授權,可以免費使用、修改、商用。
111
+ - AICDE 名稱和 logo 不包含在內,做自己的產品時請換成你自己的。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "aicde-ui",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "AICDE 風格的 React 元件庫:59 個元件、15 種主題、支援深色模式與 TypeScript",
5
5
  "author": "Asher Tee (https://github.com/zhijian090195)",
6
6
  "keywords": [