Angular Material 排序的 API 参考

import {MatSortModule} from '@angular/material/sort';

要修改显示的标签和文本,就要创建一个 MatSortHeaderIntl 的新实例,并把它包含在自定义提供者中。

属性
名称 描述

changes: Subject<void>

只要这里的标签发生了变化就会发出流。如果标签在初始化后发生了变化,用它来通知组件。

对元素应用排序行为(点击以改变排序)和样式,包括一个显示当前排序方向的箭头。

必须提供一个 id 并将其包含在父 MatSort 指令中。

如果在 CdkTable 的头单元格中使用它,它会自动默认包含列的定义。

选择器: [mat-sort-header]

Exported as: matSortHeader
属性
名称 描述
@Input()

arrowPosition: SortHeaderArrowPosition

设置排序后显示的箭头位置。

@Input({ transform: booleanAttribute })

disableClear: boolean

为这个 MatSortable 改写包含其中的 MatSort 的 disableClear 值。

@Input({ transform: booleanAttribute })

disabled: boolean

排序标题是否被禁用。

@Input('mat-sort-header')

id: string

此排序头的 ID。如果在 CdkColumnDef 的上下文中使用,则默认为该列的名字。

@Input()

sortActionDescription: string

描述应用于 MatSortHeader 的按钮元素,带有 aria-describedby。此文本应描述用户单击排序标题时将发生的操作。

@Input()

start: SortDirection

改写这个 MatSortable 中包含 MatSort 的 sort 起始值。

MatSortable 的容器,可以管理排序状态并提供默认的排序参数。

选择器: [matSort]

Exported as: matSort
属性
名称 描述
@Input('matSortActive')

active: string

最近排序过的 MatSortable 的 id。

@Input('matSortDirection')

direction: SortDirection

当前活动的 MatSortable 的排序方向。

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

disableClear: boolean

是否通过完成排序方向的循环来禁止用户清除排序。可以通过 MatSortable 的输入属性 disableClear 来改写它。

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

disabled: boolean

排序是否被禁用。

@Input('matSortStart')

start: SortDirection

最初对 MatSortable 进行排序时要设置的方向。可以通过 MatSortable 的输入属性 start 来改写它。

@Output('matSortChange')

sortChange: EventEmitter<Sort>

当用户改变活动的排序或排序方向时发出的事件。

initialized: Observable<void>

分页器初始化时发出。

sortables: Map<string, MatSortable>

本指令管理的所有已注册可排序对象的集合。

方法
deregister

取消注册 MatSortable 的函数。这会从 MatSortable 集合中删除此 MatSortable。

参数

sortable

MatSortable

getNextSortDirection

返回活动可排序对象的下一个排序方向,检查潜在的改写。

参数

sortable

MatSortable

返回值
SortDirection

register

注册 MatSortable 的函数。这会把此 MatSortable 添加到 MatSortable 的集合中的。

参数

sortable

MatSortable

sort

设置当前排序的 id,并确定新的排序方向。

参数

sortable

MatSortable

指令的接口,用于保存供 MatSortHeader 使用的排序状态。

属性
名称 描述

disableClear: boolean

是否禁止清除排序状态。

id: string

要被排序的列的 id。

start: SortDirection

开始排序的方向。

当前的排序状态。

属性
名称 描述

active: string

要被排序的列的 id。

direction: SortDirection

排序的方向。

mat-sort 的默认选项。

属性
名称 描述

arrowPosition: SortHeaderArrowPosition

排序时显示的箭头的位置。

disableClear: boolean

是否禁止清除排序状态。

type SortDirection = 'asc' | 'desc' | '';

排序时显示的箭头的位置。

type SortHeaderArrowPosition = 'before' | 'after';

mat-sort 的默认选项的注入令牌。

const MAT_SORT_DEFAULT_OPTIONS: InjectionToken<MatSortDefaultOptions>;