電子書工具列
用法
章節連結:用法電子書工具列放在電子書閱讀畫面的最上方:左邊是返回鍵,中間是書名,右邊是閱讀時用的工具,例如搜尋、書籤、語音朗讀。整列是一個圓角的長條。畫面寬度小於 768px 時,書名從置中改成靠左、貼著返回鍵;右邊的工具按鈕不會收起來。它只用在電子書的閱讀畫面,一般網頁的最上方請用「導覽列」。元件另有一個品牌底色(brand)變體,但目前在網站上看起來和預設一樣(待工程修正),請先用預設。
組成
章節連結:組成| 部位 | 說明 |
|---|---|
| 容器 | 圓角長條,有淡淡的底色和外框。底色和文字色跟著主題和色彩模式變。 |
| 返回鍵 | 內建在最左邊的箭頭按鈕,讓讀者離開閱讀畫面。螢幕閱讀器預設唸作「返回」,可以改成更清楚的說法。 |
| 書名 | 可省略。寬畫面置中,窄畫面靠左。只排一行,太長時從後面截斷,顯示「…」(上方第二個預覽)。 |
| 工具列 | 右邊的一排工具按鈕,通常用「圖示按鈕」,由網站決定放哪幾個。 |
| 焦點框 | 用鍵盤選到返回鍵或工具按鈕時出現的外框,讓不用滑鼠的人知道目前在哪裡。顏色跟著主題。 |
該做與不該做
章節連結:該做與不該做| 類型 | 說明 |
|---|---|
| 建議 | 右邊只放閱讀時最常用的幾個工具。窄畫面上工具按鈕不會收起來,放太多會把書名擠到只剩「…」。 |
| 建議 | 每個工具按鈕都寫好名稱,例如「搜尋」「書籤」,螢幕閱讀器才唸得出來;圖示也要和名稱相符。 |
| 建議 | 返回鍵的名稱寫出會回到哪裡,例如「返回書櫃」,比只寫「返回」清楚。 |
| 避免 | 不要依賴書名列讓讀者看到完整的書名;書名太長會被截斷,完整書名請放在書的介紹頁。 |
| 避免 | 不要把它當成一般網頁的頁首;網站的頁首請用「導覽列」。 |
在目前主題下的樣子
章節連結:在目前主題下的樣子目前顯示:DefaultGreen Natural(示意)。在頁首的「主題」可以切換。 查看所有主題
- 預設變體: 用元件本身的預設變體。
- 和預設主題不同的地方: 沒有。這就是預設主題,其他主題沒有特別指定的地方都沿用它。
- 預設變體: 主題不決定預設變體:用元件本身的預設變體(各網站自己的預設變體要等網站設定檔,還沒有實作)。
- 和預設主題不同的地方: (以下都是示意值)只有這個元件用到的顏色:主色、主色(滑鼠移上時;連結文字也用它)、品牌底色(襯在內容後的品牌色塊)、主色上的文字、焦點框(用鍵盤選到時的外框)。其餘和預設主題一樣。 看完整的顏色對照
上方的大預覽會跟著頁首的「主題」和「色彩模式」一起變。
給工程師
章節連結:給工程師以下是給工程師的安裝與 API 說明,美編(設計)、網站的編輯和致遠(廠商)可以略過。
Storybook(給工程師逐一檢查元件狀態的工具網站,在本機用 pnpm run heroui:storybook 開啟)目前只收錄 HeroUI 的元件,還沒有 <tc-ebook-toolbar> 的頁面;這一段的範例和 API 表就是它的說明。
<tc-ebook-toolbar> 是電子書閱讀器的上排功能列(慈濟書庫)。版面為三段式:內建返回鍵(inline-start)、書籍名稱(桌機置中)、以及尾端工具列(inline-end,由使用者以預設插槽放入 <tc-icon-button>,例如搜尋/語音/筆記/個人)。於平板斷點(--tc-breakpoint-tablet = 768px)以下,書名會由置中改為靠左貼近返回鍵。點擊返回鍵會發出 tc-back 事件。下方為可互動的真實元件:
變體(variant)
章節連結:變體(variant)brand 變體以品牌深藍底搭配 on-brand 文字/圖示;light(預設)為淺底(surface.subtle)搭配品牌色文字。
書名(book-title 與 title 插槽)
章節連結:書名(book-title 與 title 插槽)以 book-title 屬性設定置中書名;若需自訂排版,可改用 title 插槽覆寫(插槽優先)。過長的書名會以省略號截斷,避免擠壓工具列。
純 HTML
章節連結:純 HTML<link rel="stylesheet" href="@tzuchi/tokens/tokens.css" /><script type="module" src="@tzuchi/components/cdn"></script>
<tc-ebook-toolbar book-title="書籍名稱" back-label="返回"> <tc-icon-button label="搜尋"><tc-icon name="search"></tc-icon></tc-icon-button> <tc-icon-button label="選單"><tc-icon name="menu"></tc-icon></tc-icon-button></tc-ebook-toolbar>React
章節連結:Reactimport { TcEbookToolbar, TcIconButton, TcIcon } from '@tzuchi/react';
<TcEbookToolbar bookTitle="書籍名稱" onTcBack={() => history.back()}> <TcIconButton label="搜尋"> <TcIcon name="search" /> </TcIconButton></TcEbookToolbar>;API
章節連結:API下表自 Custom Elements Manifest 自動產生:
| Attribute | Type | Default | Description |
|---|---|---|---|
variant | 'brand' | 'light' | 'light' | 視覺變體:`light`(淺底、品牌色文字)或 `brand`(品牌深藍底、on-brand 文字)。 |
book-title | string | '' | 置中顯示的書籍名稱。亦可改用 `title` 插槽覆寫。 |
back-label | string | '返回' | 返回鍵的無障礙標籤(aria-label)。 |
無障礙(Accessibility)
章節連結:無障礙(Accessibility)- host 取得
role="toolbar"與aria-label(電子書工具列)。 - 返回鍵為原生
<button>,其aria-label由back-label控制(預設返回),點擊發出tc-back(composed、bubbles)。 - 尾端工具控制項由使用者提供,建議使用
<tc-icon-button>並各自設定label。 :focus-visible焦點環使用--tc-focus-ring-*token。