跳到主要內容
+

徽章

Badge 元件會產生一個附加在其子元素上的小標籤。

useBadge API

Import

import { useBadge } from '@mui/base/useBadge';
// or
import { useBadge } from '@mui/base';

請閱讀這份關於最小化套件大小的指南,以了解差異。

參數

名稱類型預設值描述
badgeContentReact.ReactNode-

在徽章內呈現的內容。

invisiblebooleanfalse

如果為 true,則徽章為不可見。

maxnumber99

顯示的最大計數。

showZerobooleanfalse

控制當 badgeContent 為零時,是否隱藏徽章。

回傳值

名稱類型描述
badgeContentReact.ReactNode

定義顯示在徽章內的內容。

displayValueReact.ReactNode

要在徽章中顯示的值。如果 badgeContent 大於 max,它將回傳 max+

invisibleboolean

如果為 true,元件將不可見。

maxnumber

要在徽章中顯示的最大數字。