Skip to content

fix(table): sticky header & content placement in virtualized table#5184

Merged
jrgarciadev merged 3 commits into
heroui-inc:canaryfrom
Hova25:fix/table-header-sticky
Apr 19, 2025
Merged

fix(table): sticky header & content placement in virtualized table#5184
jrgarciadev merged 3 commits into
heroui-inc:canaryfrom
Hova25:fix/table-header-sticky

Conversation

@Hova25
Copy link
Copy Markdown
Contributor

@Hova25 Hova25 commented Apr 11, 2025

Closes #5149

📝 Description

Fix header sticky in virtualized table
I have fixed also topContent outside placement and bottomContent outside placement in virtualized table

⛳️ Current behavior (updates)

Header not sticky Top and bottom outside placement error

🚀 New behavior

Header sticky and good top, bottom outside placement
  • Fixed header sticky when table is virtualised
  • Adjusting the table height to take up the full available size
  • Fix bottom content and top content outside / inside placement to have a behavior similar to not virtualized table
  • Clean useless div in table component

💣 Is this a breaking change (Yes/No)

No

Summary by CodeRabbit

  • New Features

    • Added an option for a sticky header in virtualized tables, enabling the header to remain visible during scrolling.
  • Bug Fixes

    • Resolved header stickiness issues and improved the placement of top and bottom table content for a more consistent display.
  • Style

    • Updated table layout styling for enhanced rendering and responsiveness.

@Hova25 Hova25 requested a review from jrgarciadev as a code owner April 11, 2025 17:43
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 11, 2025

🦋 Changeset detected

Latest commit: ed4a5fc

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

This PR includes changesets to release 2 packages
Name Type
@heroui/table 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

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 11, 2025

@Hova25 is attempting to deploy a commit to the HeroUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 11, 2025

"""

Walkthrough

The pull request adds a new changelog entry for the “@heroui/table” package and implements several adjustments in the virtualized table component. The changes include restructuring property handling, conditional content rendering modifications, and simplified prop passing. A new story export is introduced to enable a sticky header configuration, and a theme update adjusts the table’s body styling. These modifications collectively address the header stickiness issue reported in the linked bug.

Changes

File(s) Change Summary
.changeset/violet-years-rhyme.md Added a changelog entry for package "@heroui/table" documenting a patch update that fixes header stickiness and adjusts top/bottom content placement.
packages/components/table/src/virtualized-table.tsx Restructured the VirtualizedTable component: introduced a tableProps variable from getTableProps(), modified conditional rendering for topContent/bottomContent, removed an extra wrapper, and streamlined prop passing for header row and body.
packages/components/table/stories/table.stories.tsx Added new export VirtualizedWithHeaderSticky based on Virtualized, extending its arguments with isHeaderSticky: true for sticky header behavior.
packages/core/theme/src/components/table.ts Updated the table theme by changing the tbody slot from an empty string to "after:block", altering the layout rendering.

Sequence Diagram(s)

sequenceDiagram
    participant S as Storybook
    participant VT as VirtualizedTable
    participant CP as TableProp Generator
    participant RV as RowVirtualizer

    S->>VT: Render VirtualizedWithHeaderSticky
    VT->>CP: getTableProps()
    CP-->>VT: Return tableProps
    VT->>RV: getTotalSize()
    RV-->>VT: Return totalSize
    VT->>VT: Calculate dynamic height style using totalSize & headerHeight
    alt Check topContentPlacement
        VT->>S: Render topContent (outside Wrapper)
    else Alternative placement
        VT->>VT: Render topContent inside main structure
    end
    VT->>S: Render table header with sticky behavior if isHeaderSticky is true
    VT->>S: Render table rows via VirtualizedTableBody
Loading

Assessment against linked issues

Objective Addressed Explanation
Fix table header stickiness in virtualized table (#5149)
"""

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a8b7960 and ed4a5fc.

📒 Files selected for processing (1)
  • .changeset/violet-years-rhyme.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .changeset/violet-years-rhyme.md
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: TypeScript
  • GitHub Check: Tests
  • GitHub Check: Continuous Release
  • GitHub Check: Build
  • GitHub Check: Prettier
  • GitHub Check: ESLint

🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 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
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 11, 2025

Open in StackBlitz

@heroui/accordion

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

@heroui/autocomplete

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

@heroui/alert

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

@heroui/avatar

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

@heroui/badge

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

@heroui/breadcrumbs

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

@heroui/button

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

@heroui/calendar

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

@heroui/card

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

@heroui/checkbox

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

@heroui/chip

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

@heroui/code

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

@heroui/date-input

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

@heroui/date-picker

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

@heroui/divider

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

@heroui/drawer

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

@heroui/dropdown

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

@heroui/form

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

@heroui/image

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

@heroui/input

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

@heroui/input-otp

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

@heroui/kbd

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

@heroui/link

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

@heroui/listbox

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

@heroui/menu

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

@heroui/modal

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

@heroui/navbar

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

@heroui/number-input

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

@heroui/pagination

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

@heroui/popover

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

@heroui/progress

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

@heroui/radio

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

@heroui/ripple

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

@heroui/scroll-shadow

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

@heroui/select

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

@heroui/skeleton

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

@heroui/slider

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

@heroui/snippet

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

@heroui/spacer

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

@heroui/switch

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

@heroui/spinner

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

@heroui/table

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

@heroui/tabs

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

@heroui/toast

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

@heroui/tooltip

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

@heroui/user

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

@heroui/react

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

@heroui/system

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

@heroui/system-rsc

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

@heroui/theme

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

@heroui/use-aria-accordion

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

@heroui/use-aria-accordion-item

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

@heroui/use-aria-button

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

@heroui/use-aria-link

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

@heroui/use-aria-modal-overlay

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

@heroui/use-aria-multiselect

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

@heroui/use-callback-ref

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

@heroui/use-clipboard

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

@heroui/use-data-scroll-overflow

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

@heroui/use-disclosure

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

@heroui/use-draggable

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

@heroui/use-image

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

@heroui/use-infinite-scroll

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

@heroui/use-intersection-observer

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

@heroui/use-is-mobile

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

@heroui/use-is-mounted

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

@heroui/use-measure

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

@heroui/use-pagination

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

@heroui/use-real-shape

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

@heroui/use-ref-state

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

@heroui/use-resize

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

@heroui/use-safe-layout-effect

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

@heroui/use-scroll-position

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

@heroui/use-ssr

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

@heroui/use-theme

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

@heroui/use-update-effect

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

@heroui/aria-utils

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

@heroui/dom-animation

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

@heroui/framer-utils

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

@heroui/react-rsc-utils

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

@heroui/react-utils

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

@heroui/shared-icons

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

@heroui/shared-utils

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

@heroui/stories-utils

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

@heroui/test-utils

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

commit: ed4a5fc

Copy link
Copy Markdown
Member

@wingkwong wingkwong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please edit PR description to explain the changes.

Comment thread .changeset/violet-years-rhyme.md Outdated
Comment thread .changeset/violet-years-rhyme.md Outdated
Comment thread packages/components/table/src/virtualized-table-body.tsx Outdated
@Hova25
Copy link
Copy Markdown
Contributor Author

Hova25 commented Apr 13, 2025

Thanks for the PR review @wingkwong, I've applied the suggested changes.
Indeed i think is better to add after:block in tbody class rather than adding an empty <tr />

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 18, 2025

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 Apr 18, 2025 3:20am
heroui-sb ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 18, 2025 3:20am

@wingkwong wingkwong changed the title fix(table): header sticky in virtualized table + topContent and bottom content placement fix fix(table): sticky header & content placement in virtualized table Apr 18, 2025
@wingkwong wingkwong assigned jrgarciadev and unassigned wingkwong Apr 18, 2025
@jrgarciadev jrgarciadev merged commit 8bd8783 into heroui-inc:canary Apr 19, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] - HeroUI Table Header not sticky with Virtualization

3 participants