膠囊標籤
精選
用法
章節連結:用法膠囊標籤是一顆顆圓角的小標籤,讓讀者點選來篩選內容,例如只看「慈善」類的文章;點一下選取,再點一下取消,好幾顆可以同時選取。加上尾端的 × 時,也可以用來列出讀者已經選好、可以一個個拿掉的條件。如果只是標示分類或狀態、讀者不需要點,請改用「徽章」;一次只能選一個時,請改用「單選鈕」;送出、報名這類動作請用「按鈕」。
組成
章節連結:組成| 部位 | 說明 |
|---|---|
| 容器 | 膠囊形,用淡淡的品牌底色。選取時底色加深,並多一圈主色外框。 |
| 文字 | 必填。短短幾個字,例如「慈善」。標籤不會換行,字越多標籤就越長。 |
| 前置圖示 | 可省略。放在文字前面的小圖示,用來補充文字。 |
| 移除鈕 | 可省略。尾端的 ×,按下去表示要拿掉這個標籤;螢幕閱讀器會唸「移除」。 |
| 焦點框 | 用鍵盤選到標籤時出現的外框,讓不用滑鼠的人知道目前在哪裡。 |
| 停用狀態 | 整顆變淡,不能點、不能選取,也不能移除。 |
該做與不該做
章節連結:該做與不該做| 類型 | 說明 |
|---|---|
| 建議 | 標籤文字保持兩、三個字,例如「慈善」「醫療」。標籤不會換行,字太多會變得很長,一排放不下幾顆。 |
| 建議 | 同一組篩選標籤排在一起,並在前面寫出這組在篩選什麼,例如「分類:」。 |
| 建議 | 有 × 的標籤用在讀者自己加上的條件,例如搜尋結果上方列出的篩選條件。按下 × 之後要由網站把它拿掉,請和工程確認。 |
| 避免 | 不要把只用來看、不能點的分類標示做成膠囊標籤;請用「徽章」。膠囊標籤看起來可以點,讀者會去點它。 |
| 避免 | 不要用膠囊標籤做送出、前往下一步這類動作;請用「按鈕」。 |
在目前主題下的樣子
章節連結:在目前主題下的樣子目前顯示:DefaultGreen Natural(示意)。在頁首的「主題」可以切換。 查看所有主題
- 預設變體: 用元件本身的預設變體。
- 和預設主題不同的地方: 沒有。這就是預設主題,其他主題沒有特別指定的地方都沿用它。
- 預設變體: 主題不決定預設變體:用元件本身的預設變體(各網站自己的預設變體要等網站設定檔,還沒有實作)。
- 和預設主題不同的地方: (以下都是示意值)只有這個元件用到的顏色:主色、品牌底色(襯在內容後的品牌色塊)、品牌底色(滑鼠移上時)、焦點框(用鍵盤選到時的外框)。其餘和預設主題一樣。 看完整的顏色對照
上方的大預覽會跟著頁首的「主題」和「色彩模式」一起變;這個元件還沒有淺色、深色並排的範例。
給工程師
章節連結:給工程師以下是給工程師的安裝與 API 說明,美編(設計)、網站的編輯和致遠(廠商)可以略過。
Storybook(給工程師逐一檢查元件狀態的工具網站,在本機用 pnpm run heroui:storybook 開啟)目前只收錄 HeroUI 的元件,還沒有 <tc-chip> 的頁面;這一段的範例和 API 表就是它的說明。
<tc-chip> 是膠囊形的 tonal 標籤,採用品牌淺底(brand surface)配品牌主色文字(brand primary)。可作為動作型(assist)或篩選型(filter)標籤,支援前置圖示、可切換選取與可移除。下方為可互動的真實元件:
純 HTML
章節連結:純 HTML<link rel="stylesheet" href="@tzuchi/tokens/tokens.css" /><script type="module" src="@tzuchi/components/cdn"></script>
<tc-chip>連結</tc-chip><tc-chip removable>增加</tc-chip>React
章節連結:Reactimport { TcChip } from '@tzuchi/react';
<TcChip removable onTcRemove={() => removeTag(id)}> 增加</TcChip>;前置圖示
章節連結:前置圖示透過 slot="leading" 放入前置圖示:
連結
可移除
章節連結:可移除removable 會在尾端顯示關閉鈕。點擊關閉鈕或於膠囊標籤上按 Delete / Backspace 會發出 tc-remove,且不會切換選取狀態:
API
章節連結:API下表自 Custom Elements Manifest 自動產生:
| Attribute | Type | Default | Description |
|---|---|---|---|
variant | 'assist' | 'filter' | 'assist' | 變體:`assist`(預設動作型)或 `filter`(篩選型)。視覺皆為單一 tonal 樣式。 |
disabled | boolean | false | 停用:以 `aria-disabled` 表示,不可點擊、切換或移除。 |
selected | boolean | false | 選取狀態(可切換)。Enter / Space 或點擊會切換。 |
removable | boolean | false | 可移除:顯示後置關閉鈕,點擊或按 Delete / Backspace 會派發 `tc-remove`。 |
無障礙(Accessibility)
章節連結:無障礙(Accessibility)- 膠囊標籤本體為
role="button",可切換selected時以aria-pressed反映狀態。 - 鍵盤:
Enter/Space切換選取;removable時Delete/Backspace發出tc-remove。 :focus-visible焦點環使用--tc-focus-ring-*token。disabled以aria-disabled標示並移出 Tab 順序(非pointer-events:none)。