跳到內容
開始使用

徽章

內容 Badge

一般兒少已上線待審核已截止新活動
淡底實底外框99+12小尺寸

徽章是貼在旁邊的小標記,用來標示分類、狀態或數量,例如「兒少」「已上線」「12」。它只給人看,不能點。要讓讀者點選、篩選或移除的小標籤,請改用「膠囊標籤」;要讓讀者按下去做一件事,用「按鈕」。徽章有六種色調:一般(neutral)和品牌(brand)用在分類,成功(success)、錯誤(error)、警告(warning)、資訊(info)用在狀態;外觀有淡底(soft)、實底(filled)、外框(outline)三種,另有小尺寸(sm)給平板直式和手機用。

部位說明
底色與外框依外觀而定:淡底配色調文字、實底配反白文字,或透明底配色調外框。顏色跟著主題。
文字必填。分類、狀態或數字,排成一行,不會換行。
狀態圓點可省略。文字前面的小圓點,只是裝飾,螢幕閱讀器不會唸。
形狀預設是小圓角;也可以改成兩端全圓的膠囊形,適合放數字。
給螢幕閱讀器的字只有狀態色調才有:看不見的「成功:」「錯誤:」「警告:」「資訊:」,螢幕閱讀器會先唸這幾個字,再唸徽章文字。
類型 說明
建議 文字越短越好,一兩個詞或一個數字。徽章不會換行,字太多會撐得很寬。
建議 色調要和意思一致:完成、上線用成功(success),失敗、截止用錯誤(error),需要注意用警告(warning),一般提示用資訊(info);單純分類用一般(neutral)或品牌(brand)。
建議 意思要寫在文字裡,不能只靠顏色或圓點表達;分不出顏色的讀者也要看得懂。目前警告(warning)、資訊(info)和品牌(brand)都是藍色系,只看顏色分不出來。
避免 不要用徽章當按鈕或連結。它不能點,也不能用鍵盤選到;要讓讀者點選或篩選,請用「膠囊標籤」。
避免 狀態色調的文字不要只寫色調本身的名稱。例如錯誤色調只寫「錯誤」,螢幕閱讀器會唸成「錯誤:錯誤」;改寫成發生了什麼,例如「已截止」「上傳失敗」。

目前顯示:DefaultGreen Natural(示意)。在頁首的「主題」可以切換。 查看所有主題

  • 預設變體: 用元件本身的預設變體。
  • 和預設主題不同的地方: 沒有。這就是預設主題,其他主題沒有特別指定的地方都沿用它。
  • 預設變體: 主題不決定預設變體:用元件本身的預設變體(各網站自己的預設變體要等網站設定檔,還沒有實作)。
  • 和預設主題不同的地方: (以下都是示意值)只有這個元件用到的顏色:主色、品牌底色(襯在內容後的品牌色塊)、主色上的文字。其餘和預設主題一樣。 看完整的顏色對照

徽章還沒有各主題的對照範例;上方的大預覽會跟著頁首的「主題」和「色彩模式」一起變。

以下是給工程師的安裝與 API 說明,美編(設計)、網站的編輯和致遠(廠商)可以略過。

Storybook(給工程師逐一檢查元件狀態的工具網站,在本機用 pnpm run heroui:storybook 開啟)目前只收錄 HeroUI 的元件,還沒有 <tc-badge> 的頁面;這一段的範例和 API 表就是它的說明。

<tc-badge> 是小型、非互動的徽章,用於標示標籤、狀態或數量。比 tc-chip 更小且不可點擊。支援六種色調(neutral、brand、success、error、warning、info)、三種變體(soft、filled、outline)、兩種尺寸(md / sm),並可加上前置狀態圓點與膠囊形外觀。下方為真實元件:

標籤兒少上線錯誤
<link rel="stylesheet" href="@tzuchi/tokens/tokens.css" />
<script type="module" src="@tzuchi/components/cdn"></script>
<tc-badge tone="brand">兒少</tc-badge>
<tc-badge tone="success" dot>上線</tc-badge>
import { TcBadge } from '@tzuchi/react';
<TcBadge tone="error" variant="filled" pill>
12
</TcBadge>;

色調對應語意色彩。neutral 與 brand 視為一般標籤;success、error、warning、info 視為狀態,會附帶一段視覺隱藏文字供螢幕報讀器辨識。

neutralbrandsuccesserrorwarninginfo

soft(預設)為淡底配色調文字;filled 為實底配反白文字;outline 為透明底配色調邊框與文字。

softfilledoutline

md(預設)適用桌機與平板橫式;sm 適用平板直式與手機。

MediumSmall

dot 會在前端顯示狀態圓點;pill 會將徽章改為完整膠囊形(適合數量計數)。

上線離線99+12

下表自 Custom Elements Manifest 自動產生:

Attribute Type Default Description
tone | 'neutral' | 'brand' | 'success' | 'error' | 'warning' | 'info' 'neutral' 色調:對應語意色彩。`neutral`(預設)、`brand`、`success`、`error`、`warning`、`info`。
variant 'filled' | 'soft' | 'outline' 'soft' 變體:`soft`(預設,淡底 + 色調文字)、`filled`(實底 + 反白文字)、`outline`(透明底 + 色調邊框與文字)。
size 'sm' | 'md' 'md' 尺寸:`md`(預設,桌機 / 平板橫式)或 `sm`(平板直式 / 手機)。
dot boolean false 前置狀態圓點。
pill boolean false 完整膠囊形圓角;未設定時為小圓角。
  • 徽章預設為 role="presentation"(純裝飾)。若徽章承載狀態語意,作者可自行加上 role="status"。
  • 狀態色調(success / error / warning / info)會附帶視覺隱藏文字,向螢幕報讀器說明狀態。
  • 狀態圓點為純裝飾(aria-hidden),不依賴顏色傳達意義——色調搭配文字與隱藏標籤共同表意。
  • 徽章為非互動元件,不接收焦點、不發出事件。