Angular Material 列表的 API 参考

import {MatListModule} from '@angular/material/list';

指令

`MatListOption`

选择器： mat-list-option

Exported as: matListOption

属性

名称	描述
@Input() `color: ThemePalette`	此列表选项的主题颜色。这设置了复选框/单选框的颜色。
@Input() `disableRipple: boolean`	列表条目是否禁用波纹效果。
@Input() `disabled: boolean`	列表条目是否已禁用。
@Input() `lines: string \| number`	此列表条目应为其保留空间的行数。如果未指定，则根据投影内容推断行数。如果你想获得额外的空间并启用文本换行，明确指定行数会很有用。列表条目的未限定范围文本内容将始终能够占用条目的剩余空间，除非它代表标题。根据 Material Design 规范，最多支持三行。
@Input() `selected: boolean`	该选项是否被选定。
@Input() `togglePosition: MatListOptionTogglePosition`	标签应该出现在复选框/单选框之前还是之后。默认为“之后（after）”
@Input() `value: any`	选项的值
@Input() Deprecated `checkboxPosition: MatListOptionTogglePosition`	标签应该出现在复选框/单选框之前还是之后。默认为“之后（after）”

方法

focus
可以通过编程让该选项获得焦点。

getLabel
获取此列表选项的文本标签。用于列表中的预先输入功能。

toggle
切换该选项的选定状态。

`MatActionList`

选择器： mat-action-list

Exported as: matActionList

属性

名称	描述
@Input() `disableRipple: boolean`	是否禁用所有列表条目的涟漪。
@Input() `disabled: boolean`	是否禁用整个列表。禁用时，列表本身及其每个列表条目都被禁用。

`MatList`

选择器： mat-list

Exported as: matList

属性

名称	描述
@Input() `disableRipple: boolean`	是否禁用所有列表条目的涟漪。
@Input() `disabled: boolean`	是否禁用整个列表。禁用时，列表本身及其每个列表条目都被禁用。

`MatListItem`

选择器： mat-list-item a[mat-list-item] button[mat-list-item]

Exported as: matListItem

属性

名称	描述
@Input() `activated:`	指示 `<mat-nav-list>` 中的条目是否是当前活动页面。
@Input() `disableRipple: boolean`	列表条目是否禁用波纹效果。
@Input() `disabled: boolean`	列表条目是否已禁用。
@Input() `lines: string \| number`	此列表条目应为其保留空间的行数。如果未指定，则根据投影内容推断行数。如果你想获得额外的空间并启用文本换行，明确指定行数会很有用。列表条目的未限定范围文本内容将始终能够占用条目的剩余空间，除非它代表标题。根据 Material Design 规范，最多支持三行。

`MatNavList`

选择器： mat-nav-list

Exported as: matNavList

属性

名称	描述
@Input() `disableRipple: boolean`	是否禁用所有列表条目的涟漪。
@Input() `disabled: boolean`	是否禁用整个列表。禁用时，列表本身及其每个列表条目都被禁用。

`MatSelectionList`

选择器： mat-selection-list

Exported as: matSelectionList

属性

名称	描述
@Input() `color: ThemePalette`	选择列表的主题颜色。这会为所有列表中的选项设置复选框颜色。
@Input() `compareWith: (o1: any, o2: any) => boolean`	函数用于在确定哪些选项应该显示为选定状态时，比较一个选项和选定的值。第一个参数就是选项的值。第二个参数是选定值的值。必须返回一个布尔值。
@Input() `disableRipple: boolean`	是否禁用所有列表条目的涟漪。
@Input() `disabled: boolean`	是否禁用整个选择列表。当为 true 时，每个列表项都会被禁用并且每个列表项都从 Tab 顺序中删除（有 tabindex="-1"）。
@Input() `hideSingleSelectionIndicator: boolean`	所有列表条目是否隐藏单选按钮指示器。
@Input() `multiple: boolean`	选择是否限制到一个或多个条目（默认的多个）。
@Output() `selectionChange: EventEmitter<MatSelectionListChange>`	每当选项的选定状态发生变化时，就会发出一个 change 事件。
`options: QueryList<MatListOption>`	这个选择列表中包含的选项组件。
`selectedOptions: SelectionModel<MatListOption>`	当前选定的选项。

方法

deselectAll
取消选定所有选项。返回变化过的选项。
返回值
`MatListOption[]`

focus
让此选择列表获得焦点。
参数
选项 ? `FocusOptions`

selectAll
选择所有选项。返回变化过的选项。
返回值
`MatListOption[]`

`MatListItemTitle`

指令捕获列表条目的标题。列表条目通常由标题和可选的第二行或第三行组成。

标题的文本内容从不换行。每个列表条目只能有一个标题。

选择器： [matListItemTitle]

`MatListItemLine`

此指令捕获列表条目中的一行。列表条目通常由标题和可选的第二行或第三行组成。

一行内的文本内容从不换行。每个列表条目最多可以有两行。

选择器： [matListItemLine]

`MatListItemMeta`

此指令匹配列表条目的可选元区段。

列表条目可以在条目的末尾预留空间以显示控件、按钮或附加文本内容。

选择器： [matListItemMeta]

`MatListItemAvatar`

与列表条目中的可选头像匹配的指令。

列表条目可以在条目的开头预留空间来显示头像。

选择器： [matListItemAvatar]

`MatListItemIcon`

与列表条目中的可选图标匹配的指令。

列表条目可以在条目的开头预留空间来显示图标。

选择器： [matListItemIcon]

类

`MatSelectionListChange`

当选项的某个选定状态发生变化时，就会触发这个事件。

属性

名称	描述
`options: MatListOption[]`	对已更改的选项的引用。
`source: MatSelectionList`	到发出此事件的选择列表的引用。

接口

`MatListConfig`

可用于配置列表模块默认选项的对象。

属性

名称	描述
`hideSingleSelectionIndicator: boolean`	是否应隐藏单选的图标指示器。

类型别名

`MatListOptionTogglePosition`

此类型描述列表中的复选框相对于列表条目文本的的可能位置。

type MatListOptionTogglePosition = 'before' | 'after';

常量

`MAT_LIST`

这个注入令牌可以用来注入 MatList 实例。它可以作为实际 MatList 类的备用令牌，如果使用真实类可能导致此类及其组件元数据无法优化掉。

const MAT_LIST: InjectionToken<MatList>;

`MAT_NAV_LIST`

这个注入令牌可以用来注入一些 MatNavList 实例。它可以作为实际 MatNavList 类的备用令牌，如果使用真实类可能导致此类及其组件元数据无法优化掉。

const MAT_NAV_LIST: InjectionToken<MatNavList>;

`MAT_SELECTION_LIST_VALUE_ACCESSOR`

const MAT_SELECTION_LIST_VALUE_ACCESSOR: any;

`MAT_LIST_CONFIG`

可用于为列表模块提供默认选项的注入令牌。

const MAT_LIST_CONFIG: InjectionToken<MatListConfig>;