Web Components Tree Grid Sorting

    The Ignite UI for Web Components Data Sorting feature in Web Components Tree Grid is enabled on a per-column level, meaning that the IgcTreeGridComponent can have a mix of sortable and non-sortable columns. Performing Web Components sort actions enables you to change the display order of the records based on specified criteria.

    Web Components Tree Grid Sorting Overview Example

    EXAMPLE
    DATA
    TS
    HTML
    CSS
    Edit in:

    Like this sample? Get access to our complete Ignite UI for Web Components toolkit and start building your own apps in minutes. Download it for free.

    This is done via the sortable input. With the IgcTreeGridComponent sorting, you can also set the sortingIgnoreCase property to perform case sensitive sorting:

    <igc-column field="ProductName" header="Product Name" data-type="string" sortable="true"></igc-column>
html

    Sorting Indicators

    Having a certain amount of sorted columns could be really confusing if there is no indication of the sorted order.

    The IgcTreeGridComponent provides a solution for this problem by indicating the index of each sorted column.

    EXAMPLE
    DATA
    TS
    HTML
    CSS
    Edit in:

    Ignite UI for Web Components | CTA Banner

    Sorting through the API

    You can sort any column or a combination of columns through the IgcTreeGridComponent API using the IgcTreeGridComponent sort method:

    import { SortingDirection } from 'igniteui-webcomponents-grids';
typescript
    
// Perform a case insensitive ascending sort on the Category column.
this.treeGrid.sort([{ fieldName: 'Category', dir: SortingDirection.Asc, ignoreCase: true }]);

// Perform sorting on both the Category and Price columns.
this.treeGrid.sort([
    { fieldName: 'Category', dir: SortingDirection.Asc, ignoreCase: true },
    { fieldName: 'Price', dir: SortingDirection.Desc }
]);
typescript

    Sorting is performed using our DefaultSortingStrategy algorithm. Any IgcColumnComponent or ISortingExpression can use a custom implementation of the ISortingStrategy as a substitute algorithm. This is useful when custom sorting needs to be defined for complex template columns, or image columns, for example.

    As with the filtering behavior, you can clear the sorting state by using the clearSort method:

    // Removes the sorting state from the Category column
this.treeGrid.clearSort('Category');

// Removes the sorting state from every column in the Tree Grid
this.treeGrid.clearSort();
typescript

    The sortStrategy of the IgcTreeGridComponent is of different type compared to the sortStrategy of the IgcColumnComponent, since they work in different scopes and expose different parameters.

    The sorting operation DOES NOT change the underlying data source of the IgcTreeGridComponent.

    Initial Sorting State

    It is possible to set the initial sorting state of the IgcTreeGridComponent by passing an array of sorting expressions to the sortingExpressions property of the IgcTreeGridComponent.

    public connectedCallback() {
    this.treeGrid.sortingExpressions = [
        { fieldName: 'Category', dir: SortingDirection.Asc, ignoreCase: true },
        { fieldName: 'Price', dir: SortingDirection.Desc }
    ];
}
typescript

    If values of type string are used by a column of dataType Date, the IgcTreeGridComponent won't parse them to Date objects and using IgcTreeGridComponent Sorting won't work as expected. If you want to use string objects, additional logic should be implemented on an application level, in order to parse the values to Date objects.

    Sorting Indicators Templates

    The sorting indicator icon in the column header can be customized using a template. The following properties are available for templating the sorting indicator for any sorting state (ascending, descending, none):

    constructor() {
    var grid = this.grid = document.getElementById('grid') as IgcTreeGridComponent;
    grid.data = this.data;
    grid.sortHeaderIconTemplate = this.sortHeaderIconTemplate;
}

public sortHeaderIconTemplate = (ctx: IgcGridHeaderTemplateContext) => {
    return html`<igc-icon name="unfold_more"></igc-icon>`;
}
ts
    constructor() {
    var grid = this.grid = document.getElementById('grid') as IgcTreeGridComponent;
    grid.data = this.data;
    grid.sortAscendingHeaderIconTemplate = this.sortAscendingHeaderIconTemplate;
}

public sortAscendingHeaderIconTemplate = (ctx: IgcGridHeaderTemplateContext) => {
    return html`<igc-icon name="expand_less"></igc-icon>`;
}
ts
    constructor() {
    var grid = this.grid = document.getElementById('grid') as IgcTreeGridComponent;
    grid.data = this.data;
    grid.sortDescendingHeaderIconTemplate = this.sortDescendingHeaderIconTemplate;
}

public sortDescendingHeaderIconTemplate = (ctx: IgcGridHeaderTemplateContext) => {
    return html`<igc-icon name="expand_more"></igc-icon>`;
}
ts

    Styling

    In addition to the predefined themes, the grid could be further customized by setting some of the available CSS properties. In case you would like to change some of the colors, you need to set a class for the grid first:

    <igc-tree-grid class="grid">
</igc-tree-grid>
html

    Then set the related CSS properties to this class:

    .grid {
    --ig-grid-sorted-header-icon-color: #ffb06a;
    --ig-grid-sortable-header-icon-hover-color: black;
}
css

    Demo

    EXAMPLE
    DATA
    TS
    HTML
    CSS
    Edit in:

    API References

    Additional Resources

    Our community is active and always welcoming to new ideas.