angular/components

Document creating a custom sort-header control

Closed

#13,177 opened on Sep 18, 2018

View on GitHubContributor guide
 (1 comment) (2 reactions) (0 assignees)TypeScript (6,650 forks)batch import
P4area: material/sortdocshelp wanted

Repository metrics

Stars
 (24,044 stars)
PR merge metrics
 (Avg merge 3d 12h) (98 merged PRs in 30d)

Description

Bug, feature request, or proposal:

Proposal

What is the expected behavior?

Be able to add custom controls to headers along with matSort

image

What is the current behavior?

It is possible to add custom controls e.g.

<ng-container matColumnDef="to">
    <mat-header-cell *matHeaderCellDef>
      <div class="vbox">
        To
        <input [(ngModel)]="filter.to">
      </div>
    </mat-header-cell>
    <mat-cell *matCellDef="let element">{{element.to}}</mat-cell>
  </ng-container>

However this does not work with matSort

What are the steps to reproduce?

Providing a StackBlitz reproduction is the best way to share your issue. StackBlitz starter: https://goo.gl/wwnhMV

What is the use-case or motivation for changing an existing behavior?

I need individual filter controls for each column in the table, all the examples use a single filter field.

Which versions of Angular, Material, OS, TypeScript, browsers are affected?

Is there anything else we should know?

Contributor guide

Research direction
Review the Angular Material table sorting API (matSort) and existing custom sort header examples. The goal is to produce documentation that guides users on integrating custom controls like input fields into sortable headers. Look at the current table documentation and the source code for mat sort header to understand the interaction. No linked PRs or comments provide additional direction.
Tech stack
typescript
Domain
frontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Angular basicsAngular Material TablematSort usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40