feat(table): support custom sort icon

[wingkwong]

Closes #5223

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

• New Features
  • Added support for custom sort icons in the Table component, allowing users to override the default sort icon in sortable columns.
  • Introduced a new prop to specify a custom sort icon in both the Table and TableColumn components.
  • Added a new SortIcon to the shared icon library.
• Documentation
  • Updated documentation to describe the new sortIcon prop and its usage in the Table component.
• Tests
  • Added a new story demonstrating the use of a custom sort icon in the Table component.

[linear]

ENG-2436 [BUG] - Custom sort icon of table header for table

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
heroui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 3, 2025 2:26pm
heroui-sb	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 3, 2025 2:26pm

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (5)

• main
• canary
• fix/.*
• chore/.*
• feat/.*

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This change adds support for customizing the sort icon in the Table component. It introduces a new sortIcon prop to the Table and TableColumnHeader components, updates documentation and stories to demonstrate this feature, and provides a new SortIcon component in the shared icons package.

Changes

File(s)	Change Summary
.changeset/heavy-otters-knock.md	Documents the addition of custom sort icon support and references related packages and issues.
apps/docs/content/docs/components/table.mdx	Updates API documentation to describe the new sortIcon prop for TableColumn.
packages/components/table/src/table-column-header.tsx	Adds sortIcon prop support, logic for rendering custom or default sort icons, and new SortIconProps type.
packages/components/table/src/table.tsx packages/components/table/src/use-table.ts	Adds sortIcon prop to Table and useTable, passes it to column headers.
packages/components/table/stories/table.stories.tsx	Adds a story demonstrating the Table with a custom sort icon using the new SortIcon.
packages/utilities/shared-icons/src/sort.tsx packages/utilities/shared-icons/src/index.ts	Adds and exports a new SortIcon React component for use as a custom sort icon.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Table
    participant TableColumnHeader
    participant SortIcon

    User->>Table: Passes sortIcon prop (optional)
    Table->>TableColumnHeader: Forwards sortIcon prop
    TableColumnHeader->>SortIcon: Renders custom sort icon if provided
    TableColumnHeader->>TableColumnHeader: Renders default icon if sortIcon not provided

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Allow replacing the default sort icon in the Table component with a custom SVG icon (#5223)	✅

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[pkg-pr-new]

Open in StackBlitz

@heroui/accordion

npm i https://pkg.pr.new/@heroui/accordion@5243

@heroui/alert

npm i https://pkg.pr.new/@heroui/alert@5243

@heroui/autocomplete

npm i https://pkg.pr.new/@heroui/autocomplete@5243

@heroui/avatar

npm i https://pkg.pr.new/@heroui/avatar@5243

@heroui/badge

npm i https://pkg.pr.new/@heroui/badge@5243

@heroui/breadcrumbs

npm i https://pkg.pr.new/@heroui/breadcrumbs@5243

@heroui/button

npm i https://pkg.pr.new/@heroui/button@5243

@heroui/calendar

npm i https://pkg.pr.new/@heroui/calendar@5243

@heroui/card

npm i https://pkg.pr.new/@heroui/card@5243

@heroui/checkbox

npm i https://pkg.pr.new/@heroui/checkbox@5243

@heroui/chip

npm i https://pkg.pr.new/@heroui/chip@5243

@heroui/code

npm i https://pkg.pr.new/@heroui/code@5243

@heroui/date-input

npm i https://pkg.pr.new/@heroui/date-input@5243

@heroui/date-picker

npm i https://pkg.pr.new/@heroui/date-picker@5243

@heroui/divider

npm i https://pkg.pr.new/@heroui/divider@5243

@heroui/drawer

npm i https://pkg.pr.new/@heroui/drawer@5243

@heroui/dropdown

npm i https://pkg.pr.new/@heroui/dropdown@5243

@heroui/form

npm i https://pkg.pr.new/@heroui/form@5243

@heroui/image

npm i https://pkg.pr.new/@heroui/image@5243

@heroui/input

npm i https://pkg.pr.new/@heroui/input@5243

@heroui/input-otp

npm i https://pkg.pr.new/@heroui/input-otp@5243

@heroui/kbd

npm i https://pkg.pr.new/@heroui/kbd@5243

@heroui/link

npm i https://pkg.pr.new/@heroui/link@5243

@heroui/listbox

npm i https://pkg.pr.new/@heroui/listbox@5243

@heroui/menu

npm i https://pkg.pr.new/@heroui/menu@5243

@heroui/modal

npm i https://pkg.pr.new/@heroui/modal@5243

@heroui/navbar

npm i https://pkg.pr.new/@heroui/navbar@5243

@heroui/number-input

npm i https://pkg.pr.new/@heroui/number-input@5243

@heroui/pagination

npm i https://pkg.pr.new/@heroui/pagination@5243

@heroui/popover

npm i https://pkg.pr.new/@heroui/popover@5243

@heroui/progress

npm i https://pkg.pr.new/@heroui/progress@5243

@heroui/radio

npm i https://pkg.pr.new/@heroui/radio@5243

@heroui/ripple

npm i https://pkg.pr.new/@heroui/ripple@5243

@heroui/scroll-shadow

npm i https://pkg.pr.new/@heroui/scroll-shadow@5243

@heroui/select

npm i https://pkg.pr.new/@heroui/select@5243

@heroui/skeleton

npm i https://pkg.pr.new/@heroui/skeleton@5243

@heroui/slider

npm i https://pkg.pr.new/@heroui/slider@5243

@heroui/snippet

npm i https://pkg.pr.new/@heroui/snippet@5243

@heroui/spacer

npm i https://pkg.pr.new/@heroui/spacer@5243

@heroui/spinner

npm i https://pkg.pr.new/@heroui/spinner@5243

@heroui/switch

npm i https://pkg.pr.new/@heroui/switch@5243

@heroui/table

npm i https://pkg.pr.new/@heroui/table@5243

@heroui/tabs

npm i https://pkg.pr.new/@heroui/tabs@5243

@heroui/toast

npm i https://pkg.pr.new/@heroui/toast@5243

@heroui/tooltip

npm i https://pkg.pr.new/@heroui/tooltip@5243

@heroui/user

npm i https://pkg.pr.new/@heroui/user@5243

@heroui/react

npm i https://pkg.pr.new/@heroui/react@5243

@heroui/system

npm i https://pkg.pr.new/@heroui/system@5243

@heroui/system-rsc

npm i https://pkg.pr.new/@heroui/system-rsc@5243

@heroui/theme

npm i https://pkg.pr.new/@heroui/theme@5243

@heroui/use-aria-accordion

npm i https://pkg.pr.new/@heroui/use-aria-accordion@5243

@heroui/use-aria-accordion-item

npm i https://pkg.pr.new/@heroui/use-aria-accordion-item@5243

@heroui/use-aria-button

npm i https://pkg.pr.new/@heroui/use-aria-button@5243

@heroui/use-aria-link

npm i https://pkg.pr.new/@heroui/use-aria-link@5243

@heroui/use-aria-modal-overlay

npm i https://pkg.pr.new/@heroui/use-aria-modal-overlay@5243

@heroui/use-aria-multiselect

npm i https://pkg.pr.new/@heroui/use-aria-multiselect@5243

@heroui/use-aria-overlay

npm i https://pkg.pr.new/@heroui/use-aria-overlay@5243

@heroui/use-callback-ref

npm i https://pkg.pr.new/@heroui/use-callback-ref@5243

@heroui/use-clipboard

npm i https://pkg.pr.new/@heroui/use-clipboard@5243

@heroui/use-data-scroll-overflow

npm i https://pkg.pr.new/@heroui/use-data-scroll-overflow@5243

@heroui/use-disclosure

npm i https://pkg.pr.new/@heroui/use-disclosure@5243

@heroui/use-draggable

npm i https://pkg.pr.new/@heroui/use-draggable@5243

@heroui/use-form-reset

npm i https://pkg.pr.new/@heroui/use-form-reset@5243

@heroui/use-image

npm i https://pkg.pr.new/@heroui/use-image@5243

@heroui/use-infinite-scroll

npm i https://pkg.pr.new/@heroui/use-infinite-scroll@5243

@heroui/use-intersection-observer

npm i https://pkg.pr.new/@heroui/use-intersection-observer@5243

@heroui/use-is-mobile

npm i https://pkg.pr.new/@heroui/use-is-mobile@5243

@heroui/use-is-mounted

npm i https://pkg.pr.new/@heroui/use-is-mounted@5243

@heroui/use-measure

npm i https://pkg.pr.new/@heroui/use-measure@5243

@heroui/use-pagination

npm i https://pkg.pr.new/@heroui/use-pagination@5243

@heroui/use-real-shape

npm i https://pkg.pr.new/@heroui/use-real-shape@5243

@heroui/use-ref-state

npm i https://pkg.pr.new/@heroui/use-ref-state@5243

@heroui/use-resize

npm i https://pkg.pr.new/@heroui/use-resize@5243

@heroui/use-safe-layout-effect

npm i https://pkg.pr.new/@heroui/use-safe-layout-effect@5243

@heroui/use-scroll-position

npm i https://pkg.pr.new/@heroui/use-scroll-position@5243

@heroui/use-ssr

npm i https://pkg.pr.new/@heroui/use-ssr@5243

@heroui/use-theme

npm i https://pkg.pr.new/@heroui/use-theme@5243

@heroui/use-update-effect

npm i https://pkg.pr.new/@heroui/use-update-effect@5243

@heroui/use-viewport-size

npm i https://pkg.pr.new/@heroui/use-viewport-size@5243

@heroui/aria-utils

npm i https://pkg.pr.new/@heroui/aria-utils@5243

@heroui/dom-animation

npm i https://pkg.pr.new/@heroui/dom-animation@5243

@heroui/framer-utils

npm i https://pkg.pr.new/@heroui/framer-utils@5243

@heroui/react-rsc-utils

npm i https://pkg.pr.new/@heroui/react-rsc-utils@5243

@heroui/react-utils

npm i https://pkg.pr.new/@heroui/react-utils@5243

@heroui/shared-icons

npm i https://pkg.pr.new/@heroui/shared-icons@5243

@heroui/shared-utils

npm i https://pkg.pr.new/@heroui/shared-utils@5243

@heroui/stories-utils

npm i https://pkg.pr.new/@heroui/stories-utils@5243

@heroui/test-utils

npm i https://pkg.pr.new/@heroui/test-utils@5243

commit: 343ebe0

[changeset-bot]

🦋 Changeset detected

Latest commit: 343ebe0

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

This PR includes changesets to release 19 packages

Name	Type
@heroui/shared-icons	Patch
@heroui/table	Patch
@heroui/accordion	Patch
@heroui/alert	Patch
@heroui/autocomplete	Patch
@heroui/breadcrumbs	Patch
@heroui/calendar	Patch
@heroui/chip	Patch
@heroui/date-picker	Patch
@heroui/drawer	Patch
@heroui/input	Patch
@heroui/link	Patch
@heroui/modal	Patch
@heroui/number-input	Patch
@heroui/pagination	Patch
@heroui/select	Patch
@heroui/snippet	Patch
@heroui/toast	Patch
@heroui/react	Patch

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

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

packages/utilities/shared-icons/src/sort.tsx (1)

1-37: Consider making the icon color configurable.

The SortIcon component implementation looks good, but the fill color is hardcoded to #71717A for all paths. Consider making this configurable to better support theming.

You could modify the component to accept a color prop that would override the default fill:

- export const SortIcon = (props: IconSvgProps) => (
+ export const SortIcon = ({ color = "#71717A", ...props }: IconSvgProps & { color?: string }) => (
  <svg
    fill="none"
    height="15"
    viewBox="0 0 16 15"
    width="16"
    xmlns="http://www.w3.org/2000/svg"
    {...props}
  >
    <path
      clipRule="evenodd"
      d="M7.89789 10.0175C8.19079 9.72463 8.66566 9.72463 8.95855 10.0175L11.4282 12.4872L13.8979 10.0175C14.1908 9.72463 14.6657 9.72463 14.9586 10.0175C15.2514 10.3104 15.2514 10.7853 14.9586 11.0782L11.9586 14.0782C11.6657 14.3711 11.1908 14.3711 10.8979 14.0782L7.89789 11.0782C7.605 10.7853 7.605 10.3104 7.89789 10.0175Z"
-      fill="#71717A"
+      fill={color}
      fillRule="evenodd"
    />
    <path
      clipRule="evenodd"
      d="M11.4282 0.797852C11.8424 0.797852 12.1782 1.13364 12.1782 1.54785V13.5479C12.1782 13.9621 11.8424 14.2979 11.4282 14.2979C11.014 14.2979 10.6782 13.9621 10.6782 13.5479V1.54785C10.6782 1.13364 11.014 0.797852 11.4282 0.797852Z"
-      fill="#71717A"
+      fill={color}
      fillRule="evenodd"
    />
    <path
      clipRule="evenodd"
      d="M3.39789 1.01752C3.69079 0.724628 4.16566 0.724628 4.45855 1.01752L7.45855 4.01752C7.75145 4.31041 7.75145 4.78529 7.45855 5.07818C7.16566 5.37107 6.69079 5.37107 6.39789 5.07818L3.92822 2.60851L1.45855 5.07818C1.16566 5.37107 0.690786 5.37107 0.397893 5.07818C0.104999 4.78529 0.104999 4.31041 0.397893 4.01752L3.39789 1.01752Z"
-      fill="#71717A"
+      fill={color}
      fillRule="evenodd"
    />
    <path
      clipRule="evenodd"
      d="M3.92822 0.797852C4.34244 0.797852 4.67822 1.13364 4.67822 1.54785V13.5479C4.67822 13.9621 4.34244 14.2979 3.92822 14.2979C3.51401 14.2979 3.17822 13.9621 3.17822 13.5479V1.54785C3.17822 1.13364 3.51401 0.797852 3.92822 0.797852Z"
-      fill="#71717A"
+      fill={color}
      fillRule="evenodd"
    />
  </svg>
);

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2cbc689 and 7093d64.

📒 Files selected for processing (8)

• .changeset/heavy-otters-knock.md (1 hunks)
• apps/docs/content/docs/components/table.mdx (1 hunks)
• packages/components/table/src/table-column-header.tsx (4 hunks)
• packages/components/table/src/table.tsx (2 hunks)
• packages/components/table/src/use-table.ts (3 hunks)
• packages/components/table/stories/table.stories.tsx (2 hunks)
• packages/utilities/shared-icons/src/index.ts (1 hunks)
• packages/utilities/shared-icons/src/sort.tsx (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

packages/components/table/stories/table.stories.tsx (1)

packages/utilities/shared-icons/src/sort.tsx (1)

• SortIcon (3-37)

🔇 Additional comments (15)

packages/utilities/shared-icons/src/index.ts (1)

16-16: Properly exports the new SortIcon component

The addition of this export makes the new SortIcon component available to consumers of the shared-icons package, which is required to support the custom sort icon feature in the Table component.

packages/components/table/src/table.tsx (2)

31-31: Correctly adds sortIcon to the destructured props

The sortIcon prop is properly added to the list of destructured props from the useTable hook.

---

105-105: Appropriately passes the sortIcon prop to TableColumnHeader

The sortIcon prop is correctly forwarded to each TableColumnHeader component within the table header rows, implementing the support for custom sort icons.

apps/docs/content/docs/components/table.mdx (1)

739-744: Well-documented sortIcon prop in the API reference

The documentation for the new sortIcon prop is clear and well-placed in the TableColumn API section. It correctly specifies the prop type as ReactNode and explains its purpose for overriding the default sort icon when allowsSorting is true.

.changeset/heavy-otters-knock.md (1)

1-7: Appropriate changeset for the feature addition

The changeset correctly identifies this as a patch update for both "@heroui/shared-icons" and "@heroui/table" packages, with a clear description referencing issue #5223.

packages/components/table/stories/table.stories.tsx (2)

10-10: Added import for SortIcon to support new feature.

The SortIcon component is now correctly imported from the shared icons package to be used in the new CustomSortIcon story.

---

1068-1075: Custom sort icon story demonstrates the new feature.

This new story showcases how to use the custom sort icon feature by passing the SortIcon component to the Table's sortIcon prop.

packages/components/table/src/use-table.ts (2)

171-171: Prop destructuring looks good.

The sortIcon prop is correctly destructured from the props object.

---

300-300: Consistent return of sortIcon.

The sortIcon prop is correctly included in the return object of the useTable hook, making it available to child components.

packages/components/table/src/table-column-header.tsx (6)

2-2: Import statements updated appropriately.

The necessary React types and functions have been imported to support the new custom sort icon functionality.

Also applies to: 4-4

---

18-23: Well-defined SortIconProps type.

The exported SortIconProps type clearly defines the props that will be passed to the custom sort icon.

---

29-32: Proper documentation for sortIcon prop.

The JSDoc comment clearly explains the purpose of the sortIcon prop in the TableColumnHeaderProps interface.

---

40-40: Props destructuring updated correctly.

The sortIcon prop is properly included in the destructuring pattern.

---

57-62: Structured sortIconProps object.

The sortIconProps object is well-structured with all the necessary properties for rendering the sort icon.

---

88-88: Clean implementation of conditional rendering.

The implementation correctly renders the custom sort icon if provided, otherwise falls back to the default ChevronDownIcon.