TreeTable: sortFunction is not called when custom sort is used

[BAISTM]

Describe the bug

The column's custom sort function is not called when sorting a column.

Reproducer

https://stackblitz.com/edit/vqw5gi-jmmcd5?file=src%2FApp.jsx

PrimeReact version

10.3.1

React version

17.x

Language

TypeScript

Build / Runtime

Create React App (CRA)

Browser(s)

No response

Steps to reproduce the behavior

No response

Expected behavior

The multi sort mode should allow users to customize the sort of a column.

[melloware]

Duplicate of: #6083 but leaving this one open and closing that one because yours contains a reproducer and the other ticket does not.

[MBelniak]

You need to pass 'custom' as a sortable prop to make it work:
sortable={'custom'}
It's working nice on my side. The only problem I had was missing typings, which I created an issue for: #5591

BUT
I have a problem, that the custom sort function is not called for the default sorted column. You can use 'sortField' and 'sortOrder' props on DataTable or TreeTable to set the default sorting on column, but the data is sorted using some default algorithm instead of sortFunction. @melloware Maybe it's something that doesn't take much to fix?

[MBelniak]

Oh, I see there's been a change recently here https://github.com/primefaces/primereact/blob/master/components/lib/treetable/TreeTable.js#L227 so sortable={'custom'} is no longer needed, just sortable is enough.

[melloware]

@MBelniak so its all working?

[melloware]

@MBelniak it looks like @BAISTM Stackblitz above is still not working and he is using sortable can you take a look?

[MBelniak]

I believe the problem with custom sort function not being called for column with default sorting is still there. I'm checking right now. It might be it's a one liner change with setting a default value for columnField ref

[MBelniak]

@melloware I can confirm that custom sortFunction is not called when sortMode is 'multiple'. The function sortMultipleNodes is called in such case and it does not care about custom sortFunction

[MBelniak]

Okay, the fix for default sorting with custom sortFunction will not be so simple. The TreeTableHeader needs to pass info about sortFunction and sortable props of Column to state of TreeTable in order to reference them in onSort. I will investigate further later.

[MBelniak]

Turned out to be not so difficult, PR: #6436