Angular Material badge API 参考文档
import {MatBadgeModule} from '@angular/material/badge';
指令
MatBadge
用于显示文字徽章的指令。
Directive to display a text badge.
属性
名称 | 描述 |
---|---|
@Input('matBadgeColor')
|
徽章的颜色。可以是 The color of the badge. Can be |
@Input('matBadge')
|
徽章的内容 The content for the badge |
@Input('matBadgeDescription')
|
用于描述被 aria-describedby 装饰的元素的信息 Message used to describe the decorated element via aria-describedby |
@Input( matBadgeDisabled)
|
Whether the component is disabled. |
@Input('matBadgeHidden')
|
徽章是否隐藏了。 Whether the badge is hidden. |
@Input('matBadgeOverlap')
|
徽章是否应与其内容重叠 Whether the badge should overlap its contents or not |
@Input('matBadgePosition')
|
徽章应该放在哪里。接受 'above'|'below' 和 'before'|'after' 的任意组合 Position the badge should reside. Accepts any combination of 'above'|'below' and 'before'|'after' |
@Input('matBadgeSize')
|
徽章的大小。可以是 'small'、'medium' 或 'large'。 Size of the badge. Can be 'small', 'medium', or 'large'. |
方法
getBadgeElement | |
---|---|
获取要用来渲染徽章内容的元素。如果尚未创建该元素,则返回 undefined(例如,如果该徽章没有内容)。 Gets the element into which the badge's content is being rendered. Undefined if the element hasn't been created (e.g. if the badge doesn't have content). |
|
返回值 Returns |
|
HTMLElement | undefined
|
|
isAbove | |
---|---|
徽章是否在宿主元素上方 Whether the badge is above the host or not |
|
返回值 Returns |
|
boolean
|
|
isAfter | |
---|---|
徽章是否在宿主元素下方 Whether the badge is after the host or not |
|
返回值 Returns |
|
boolean
|
|
类型别名
MatBadgePosition
matBadgePosition 可接受的位置选项
Allowed position options for matBadgePosition
type MatBadgePosition = 'above after' | 'above before' | 'below before' | 'below after' | 'before' | 'after' | 'above' | 'below';
MatBadgeSize
matBadgeSize 可接受的大小选项
Allowed size options for matBadgeSize
type MatBadgeSize = 'small' | 'medium' | 'large';
Angular Material badge-testing API 参考文档
import {MatBadgeHarness} from '@angular/material/badge/testing';
类
MatBadgeHarness
extends
ComponentHarness
在测试中与标准 Material 徽章进行交互的测试工具。
Harness for interacting with a standard Material badge in tests.
方法
异步
getPosition
|
|
---|---|
获取徽章的位置。 Gets the position of the badge. |
|
返回值 Returns |
|
Promise<MatBadgePosition>
|
|
异步
getSize
|
|
---|---|
获取徽章的大小。 Gets the size of the badge. |
|
返回值 Returns |
|
Promise<MatBadgeSize>
|
|
异步
getText
|
|
---|---|
获取徽章文本的 Promise。 Gets a promise for the badge text. |
|
返回值 Returns |
|
Promise<string>
|
|
异步
host
|
|
---|---|
获取一个代表该组件宿主元素的 Gets a |
|
返回值 Returns |
|
Promise<TestElement>
|
|
异步
isDisabled
|
|
---|---|
获取该徽章是否禁用。 Gets whether the badge is disabled. |
|
返回值 Returns |
|
Promise<boolean>
|
|
异步
isHidden
|
|
---|---|
获取该徽章是否隐藏。 Gets whether the badge is hidden. |
|
返回值 Returns |
|
Promise<boolean>
|
|
异步
isOverlapping
|
|
---|---|
获取徽章是否与内容重叠。 Gets whether the badge is overlapping the content. |
|
返回值 Returns |
|
Promise<boolean>
|
|
接口
BadgeHarnessFilters
属性
名称 | 描述 |
---|---|
|