feat: Add support for onToggleSort to DataTable

[veryfancy]

Add support for onToggleSort prop to DataTable.

Changelog

New

• Add support for onToggleSort prop to DataTable.

Changed

Removed

Rollout strategy

• Minor release

Testing & Reviewing

Merge checklist

• Added/updated tests
• Added/updated documentation
• Added/updated previews (Storybook)
• Changes are SSR compatible
• Tested in Chrome
• Tested in Firefox
• Tested in Safari
• Tested in Edge
• (GitHub staff only) Integration tests pass at github/github (Learn more about how to run integration tests)

[changeset-bot]

🦋 Changeset detected

Latest commit: 97d1050

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@primer/react	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

👋 Hi, this pull request contains changes to the source code that github/github depends on. If you are GitHub staff, we recommend testing these changes with github/github using the integration workflow. Thanks!

[Copilot]

Pull Request Overview

Adds a callback to notify consumers when a sortable column header is clicked.

• Introduces an optional onToggleSort prop in DataTableProps.
• Invokes onToggleSort with the column ID and new direction on header clicks.
• Covers the new behavior with a unit test and a Storybook story.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File	Description
packages/react/src/DataTable/DataTable.tsx	Added onToggleSort prop and callback invocation in header logic
packages/react/src/DataTable/tests/DataTable.test.tsx	New test verifying onToggleSort calls with correct parameters
packages/react/src/DataTable/DataTable.features.stories.tsx	Added WithSortEvents Storybook example using onToggleSort
.changeset/salty-bikes-learn.md	Changelog entry for the onToggleSort addition

Comments suppressed due to low confidence (2)

packages/react/src/DataTable/tests/DataTable.test.tsx:891

• [nitpick] The variable name handler is generic; consider renaming it to onToggleSortMock or onToggleSortHandler to clarify its purpose.

const handler = jest.fn()

packages/react/src/DataTable/tests/DataTable.test.tsx:921

• Consider adding an assertion to verify that clicking the same column header a second time toggles back to ASC, e.g., a third click on 'First' calls onToggleSort('first', 'ASC').

expect(handler).toHaveBeenCalledTimes(2)

[github-actions]

size-limit report 📦

Path	Size
packages/react/dist/browser.esm.js	99.04 KB (0%)
packages/react/dist/browser.umd.js	99.13 KB (0%)

[primer-integration]

👋 Hi from github/github! Your integration PR is ready: https://github.com/github/github/pull/375773

[primer-integration]

🟢 golden-jobs completed with status success.

[veryfancy]

Int tests were failing due to a date-related Flake, not this change. (Although the failing test used DataTable, which sparked extra investigation! 😅 )

[francinelucca]

Thanks so much for the contribution and for adding stories and tests! 🙏
Just oneeee tiny request

[francinelucca]

can we add this new prop to the docs file? 🙏 https://github.com/primer/react/blob/main/packages/react/src/DataTable/DataTable.docs.json

[veryfancy]

Done!

[veryfancy]

Had to resolve a merge conflict, too, and opted to force-push a single commit.

[github-actions]

👋 Hi, there are new commits since the last successful integration test. We recommend running the integration workflow once more, unless you are sure the new changes do not affect github/github. Thanks!

[github-actions]

👋 Hi, there are new commits since the last successful integration test. We recommend running the integration workflow once more, unless you are sure the new changes do not affect github/github. Thanks!

[francinelucca]

✨