From cc1d23d3d11c4b586ac941770671f328622f8485 Mon Sep 17 00:00:00 2001
From: jason810496 <810496@email.wlsh.tyc.edu.tw>
Date: Sat, 13 Jan 2024 18:42:26 +0800
Subject: [PATCH] infor : about `DropDown` and `NavBar` component add
 information about `DropDown` and `NavBar` component

---
 README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 60 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 851568b..ea4f7a4 100644
--- a/README.md
+++ b/README.md
@@ -22,10 +22,69 @@ git checkout -b <branch-name> # 這邊 <branch-name> 就直接用自己的名字
 ```
 > 目前有設好 Github Action，會自動部署 `main` 的內容到 `gh-pages` 分支
 
-## 合併流程
+### 合併流程
 - 在自己的 branch 開發完 push 回 origin
 - 開一個 Pull Request，如果只是一些小小的改動可以自己直接 merge 到 main。如果是較大的改動要給其他成員 code review 的話就在 discord 通知一聲，沒問題的話就再 merge。
 
+## Components
+
+### Router 
+可以先參考 `/src/data/navBar.json` 這邊的定義
+> spec 沒有特別定 <br>
+> 所以我這邊就先照著翻譯（？）<br>
+
+### Navbar
+從 `/src/data/navBar.json` 讀取資料 <br>
+如果要新增新的 navbar item 就直接在`/src/data/navBar.json` 加就好 <br>
+props :
+- `theme` : `light` or `dark` (default: `light`)
+
+`navBar.json` schema : 
+> 如果 `linkList` 只有 1 個的話，就不會顯示 dropdown
+```json
+[
+    {
+        "title": "關於單車節",
+        "linkList" : [
+            {
+                "name": "關於單車節",
+                "link": "/about"
+            }
+        ]
+    },
+    {
+        "title": "參加資訊",
+        "linkList" : [
+            {
+                "name": "交通資訊",
+                "link": "/information/traffic"
+            },
+            {
+                "name": "攤位地圖",
+                "link": "/information/map"
+            },
+            {
+                "name": "行程表",
+                "link": "/information/schedule"
+            },
+            {
+                "name": "我的行程",
+                "link": "/information/mySchedule"
+            }
+        ]
+    },
+    // ...
+]
+```
+
+
+### DropDown
+props : 
+- `title` : dropdown 顯示的名字
+- `linkList` : hover 會顯示的 `<a>` 列表
+    - `name` : `<a>` 顯示的名字
+    - `link` : `<a>` 的連結
+
 
 ## Reference