Files
mouse-clock/README.md
T

164 lines
8.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 滑鼠立體時鐘 Mouse Clock
一個會跟著滑鼠跑的類比時鐘:鐘面數字、時針、分針、秒針一個字一個字拖著跑,外圈還有一圈旋轉的日期。這是 1990 年代末很多個人網頁都會放的經典效果,原作是 Kurt Grigg 的 **Silly Clock 3**,台灣的「網頁建置百寶箱」收錄過中文化版本。
這個版本由[唐宋打油](https://tsdylab.com/)改寫,用在〈[平淡文章的華麗產地:敲敲打打的工坊✨BBP 11](https://tsdylab.com/savepoint/tinkering-workshop/)〉。和原版相比:
- 一個檔案、一行就能放進網頁,不用改任何程式。
- 手機也能用:手指在畫面上滑動,時鐘會出現在手指上方(不會被手掌擋住)。
- 顏色、大小、位置、速度、日期語言(中文/英文)都可以設定。
- 分頁在背景時不計算;系統開啟「減少動態」的使用者預設不顯示。
- 可以用程式開關(`MouseClock.start()`、`MouseClock.stop()`)。
**線上編輯器:<https://toys.tsdylab.com/mouse-clock/>**——在網頁上調整顏色、大小、位置、速度,即時預覽,再一鍵複製或下載已經含設定的程式碼。不想手動改設定的話,從這裡開始最快。
## 檔案
| 檔案 | 用途 |
| --- | --- |
| `mouse-clock.js` | 時鐘本體,只需要這個檔案 |
| `index.html` | 線上編輯器(調整設定、預覽、複製程式碼)。要用網站伺服器打開,「完整內嵌」與下載才讀得到 `mouse-clock.js` |
---
## 放置教學
### 方法一:上傳檔案再引用(推薦)
1. 下載 `mouse-clock.js`(在檔案頁按「原始檔」或「下載」)。
2. 上傳到你的網站,例如放在網站根目錄的 `js/` 資料夾。
3. 在網頁的 `</body>` 前面加一行:
```html
<script src="/js/mouse-clock.js"></script>
```
完成。重新整理網頁,移動滑鼠就會看到時鐘。
> 請不要直接引用本站(code.tsdylab.com)的檔案網址當作 `src`:程式碼平台送出的檔案類型是純文字,瀏覽器會拒絕執行;而且這個網址之後可能變動。請下載後放在自己的網站。
### 方法二:直接貼進網頁(沒辦法上傳檔案時)
打開 `mouse-clock.js`,全選複製,貼在網頁 `</body>` 前面,並用 `<script>` 包起來:
```html
<script>
/* 這裡貼上 mouse-clock.js 的全部內容 */
</script>
```
### 各平台放法
**WordPress**
- 只想在某一篇文章出現:編輯文章 → 新增「自訂 HTML」區塊 → 用方法二貼上。
- 想全站都有:用「WPCode」這類可以在頁尾插入程式碼的外掛,把方法一的 `<script>` 那一行(或方法二整段)放進「頁尾(Footer)」。檔案可以先從「媒體 → 新增」上傳;WordPress 預設不允許上傳 `.js`,這時改用方法二。
**Typecho**
- 只想在某一篇文章出現:在文章最後用方法二貼上。Typecho 預設會把文章裡的 HTML 原樣輸出;如果被當成文字顯示,在那段程式碼的開頭與結尾各加一行 `!!!`。
- 想全站都有:把 `mouse-clock.js` 上傳到佈景主題資料夾,在主題的 `footer.php` 的 `</body>` 前加上:
```php
<script src="<?php $this->options->themeUrl('mouse-clock.js'); ?>"></script>
```
**Blogger**
版面配置 → 新增小工具 → 「HTML/JavaScript」→ 用方法二貼上 → 儲存。
**Hugo/Hexo/Jekyll 等靜態網站**
把 `mouse-clock.js` 放進靜態檔案資料夾(Hugo 是 `static/js/`、Hexo 是 `source/js/`、Jekyll 是 `assets/js/`),再在佈景主題的頁尾樣板加上方法一的那一行。
**不能用的地方**
Medium、方格子、Notion、Facebook 這類平台不允許文章放自己的 JavaScript,沒辦法使用。
---
## 設定
在 `<script>` 標籤加上 `data-` 屬性就能調整,例如換成柔和的顏色、日期改英文:
```html
<script src="/js/mouse-clock.js"
data-hour-color="#b5532f"
data-minute-color="#33568b"
data-second-color="#3f8f57"
data-face-color="#555555"
data-date-color="#999999"
data-lang="en"></script>
```
| 屬性 | 預設 | 說明 |
| --- | --- | --- |
| `data-date-color` | `#000000` | 外圈日期的顏色 |
| `data-face-color` | `#0000ff` | 鐘面數字 1~12 的顏色 |
| `data-hour-color` | `#ff0000` | 時針顏色 |
| `data-minute-color` | `#0000ff` | 分針顏色 |
| `data-second-color` | `#00ff00` | 秒針顏色 |
| `data-size` | `40` | 鐘面半徑(px),日期環是它的 1.5 倍 |
| `data-offset-x` | `80` | 電腦:時鐘中心在游標右邊幾 px(負數=左邊) |
| `data-offset-y` | `80` | 電腦:時鐘中心在游標下面幾 px(負數=上面) |
| `data-touch-offset-x` | `0` | 手機:時鐘中心相對手指的水平位置 |
| `data-touch-offset-y` | `-110` | 手機:時鐘中心相對手指的垂直位置(預設在手指上方) |
| `data-speed` | `0.3` | 跟隨速度 0~1,越小拖得越長(原版是 0.6) |
| `data-date-speed` | `0.015` | 日期環旋轉速度(原版是 0.06) |
| `data-lang` | `zh-TW` | 日期語言:`zh-TW`(2026年 十一月 20日 星期五)或 `en`(FRIDAY 20 NOVEMBER 2026) |
| `data-font-size` | `10` | 1.3.0 起。鐘面數字與日期的字大小(px) |
| `data-hand-size` | `16` | 1.3.0 起。指針(點)的字大小(px) |
| `data-glow-color` | (無) | 1.3.0 起。字的外光暈顏色,例如 `#00e5ff`;不填就不加光暈 |
| `data-glow-size` | `0` | 1.3.0 起。外光暈範圍(px),`0` 就不加;要和 `data-glow-color` 一起設定 |
| `data-z-index` | `9999` | 疊放順序;時鐘被網站的選單蓋住時調大 |
| `data-reduced-motion` | `hide` | 使用者在系統開啟「減少動態」時:`hide` 不顯示,`show` 照常顯示 |
| `data-container` | (無) | 1.2.0 起。填 CSS 選擇器(例如 `#clock-box`)時,時鐘只在那個區塊裡顯示、不會跑出區塊,滑鼠或手指在區塊裡才會跟著動,離開後停在原地。不填就是跟著整個頁面(一般用法)。線上編輯器的試玩區就是用這個 |
### 用 `window.MouseClockOptions` 設定(1.1.0 起)
不方便加 `data-` 屬性時(例如用「完整內嵌」貼進文章),可以在載入 `mouse-clock.js` 之前先寫好設定,名稱用駝峰寫法(見下一節)。同時有 `data-` 屬性的話以 `data-` 屬性為準。線上編輯器產生的「完整內嵌」程式碼就是這種寫法。
```html
<script>
window.MouseClockOptions = { hourColor: '#b5532f', lang: 'en' };
</script>
<script src="/js/mouse-clock.js"></script>
```
### 用程式控制
在 `<script>` 加上 `data-manual`,時鐘就不會自動出現,改由你決定什麼時候啟動:
```html
<script src="/js/mouse-clock.js" data-manual></script>
<button onclick="MouseClock.start({ hourColor: '#c00', lang: 'en' })">開啟時鐘</button>
<button onclick="MouseClock.stop()">關閉時鐘</button>
```
`MouseClock.start(設定)` 的設定名稱和上表相同,只是改成駝峰寫法(`data-hour-color` → `hourColor`)。重複呼叫 `start()` 會先關掉舊的再開新的。`container` 除了選擇器,也可以直接給元素,例如 `MouseClock.start({ container: document.getElementById('clock-box') })`;區塊需要有高度。
---
## 常見問題
**時鐘沒有出現?**
- 確認 `src` 的路徑對:直接在瀏覽器打開那個網址,應該要看到程式碼。
- 手機要先用手指在畫面上點一下或滑動,時鐘才會跑到手指附近;一開始會在畫面正中央。
- 系統有開「減少動態」的話預設不顯示,可以加 `data-reduced-motion="show"`。
**時鐘被網站的選單或標題列蓋住?**
加大 `data-z-index`,例如 `99999`。
**會影響網頁的點擊嗎?**
不會。時鐘的每個字都設定成滑鼠點不到(`pointer-events: none`),也不會被螢幕閱讀器念出來。
---
## 授權與致謝
- 原作:**Silly Clock 3**,Kurt Grigg。2002 年發佈,原作者網站已關閉,可以看 [Internet Archive 封存的原始頁面](https://web.archive.org/web/20020310015558/http://www.btinternet.com:80/~kurt.grigg/javascript/sillyclock3.html)。
- 中文化:網頁建置百寶箱 JavaScript 收集區(已停站)。原始碼參考自[國立臺灣海洋大學教學頁](http://squall.cs.ntou.edu.tw/Dreamweaver5/2-09MouseClockJavaScript.htm)。
- 改寫:唐宋打油([tsdylab.com](https://tsdylab.com/)),2026。
這是 Kurt Grigg 腳本的改寫版,所以依照[原作者公布的使用條款](https://web.archive.org/web/20060101022347/http://www.btinternet.com:80/~kurt.grigg/javascript/):
1. 任何人都可以免費使用、修改、分享。
2. 請保留 `mouse-clock.js` 開頭的署名註解(編輯器輸出的完整內嵌版開頭也有一份),讓原作者的名字繼續被看見。
3. 不能以任何方式用這個腳本營利。
唐宋打油改寫的部分也採用同樣的條款。詳見 [LICENSE](LICENSE)。