Angular Material 徽章的 API 参考。

import {MatBadgeModule} from '@angular/material/badge';

用于显示文字徽章的指令。

选择器: [matBadge]

属性
名称 描述
@Input('matBadgeColor')

color: ThemePalette

徽章的颜色。可以是 primaryaccentwarn

@Input('matBadge')

content: string | number | undefined | null

徽章的内容

@Input('matBadgeDescription')

description: string

用于描述被 aria-describedby 装饰的元素的信息

@Input({ alias: 'matBadgeDisabled', transform: booleanAttribute })

disabled: boolean

徽章是否被禁用。

@Input({ alias: 'matBadgeHidden', transform: booleanAttribute })

hidden: boolean

徽章是否隐藏了。

@Input({ alias: 'matBadgeOverlap', transform: booleanAttribute })

overlap: boolean

徽章是否应与其内容重叠

@Input('matBadgePosition')

position: MatBadgePosition

徽章应该放在哪里。接受 'above'|'below' 和 'before'|'after' 的任意组合

@Input('matBadgeSize')

size: MatBadgeSize

徽章的大小。可以是 'small'、'medium' 或 'large'。

方法
getBadgeElement

获取要在其中渲染徽章内容的元素。如果该元素尚未创建(例如,如果徽章没有内容),则为 undefined。

返回值
HTMLElement | undefined

isAbove

徽章是否在宿主元素上方

返回值
boolean

isAfter

徽章是否在宿主元素下方

返回值
boolean

matBadgePosition 可接受的位置选项

type MatBadgePosition = 'above after' | 'above before' | 'below before' | 'below after' | 'before' | 'after' | 'above' | 'below';

matBadgeSize 可接受的大小选项

type MatBadgeSize = 'small' | 'medium' | 'large';