Skip to content

fix(Table): column DefaultSortOrder only work on first render#8062

Merged
ArgoZhang merged 3 commits into
mainfrom
fix-table
May 28, 2026
Merged

fix(Table): column DefaultSortOrder only work on first render#8062
ArgoZhang merged 3 commits into
mainfrom
fix-table

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented May 28, 2026

Link issues

fixes #8053

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Bug Fixes:

  • Fix table columns so the DefaultSortOrder configuration consistently applies rather than only on the initial render.

Copilot AI review requested due to automatic review settings May 28, 2026 08:30
@bb-auto bb-auto Bot added the bug Something isn't working label May 28, 2026
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented May 28, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Refactors where the table’s default sort column and order are initialized so that the DefaultSortOrder is applied on every render cycle where columns are rebuilt, not only the first render.

Sequence diagram for updated table default sort initialization

sequenceDiagram
    participant Renderer
    participant Table

    Renderer->>Table: OnAfterRenderAsync(firstRender)
    activate Table
    Table->>Table: BuildTableColumnsAsync()
    Table->>Table: set SortName and SortOrder from DefaultSortOrder
    Table->>Table: QueryAsync(true, 1, false, true, IsAutoQueryFirstRender)
    deactivate Table
Loading

File-Level Changes

Change Details Files
Ensure default sortable column and its DefaultSortOrder are applied during initial render rather than only when rebuilding columns.
  • Move logic that finds the column marked as both sortable and default-sort from the column-building method into OnAfterRenderAsync’s first-render branch.
  • Set SortName and SortOrder based on the located default-sort column immediately after building table columns, before triggering the initial QueryAsync call.
  • Remove the now-duplicated default sort initialization from the BuildTableColumnsAsync method to avoid resetting sort state on subsequent column rebuilds.
src/BootstrapBlazor/Components/Table/Table.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#8053 Ensure that when a Table column has DefaultSort="true" and DefaultSortOrder set, the table’s sorting functionality continues to work correctly (i.e., default sort is applied without breaking or overriding user-driven sorting).

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto Bot added this to the v10.6.0 milestone May 28, 2026
Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • The DefaultSort/DefaultSortOrder initialization is now tied specifically to the OnAfterRenderAsync(firstRender: true) path; if BuildTableColumnsAsync is invoked in other scenarios (e.g., column rebuilds after initial render), the default sort will no longer be applied there, so consider extracting this logic into a reusable helper and calling it from all relevant code paths.
  • Given that the bug description mentions DefaultSortOrder only working on the first render, it would be good to double-check that moving this logic into the firstRender branch actually addresses that problem rather than further restricting when DefaultSortOrder is applied.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The `DefaultSort`/`DefaultSortOrder` initialization is now tied specifically to the `OnAfterRenderAsync(firstRender: true)` path; if `BuildTableColumnsAsync` is invoked in other scenarios (e.g., column rebuilds after initial render), the default sort will no longer be applied there, so consider extracting this logic into a reusable helper and calling it from all relevant code paths.
- Given that the bug description mentions `DefaultSortOrder` only working on the first render, it would be good to double-check that moving this logic into the `firstRender` branch actually addresses that problem rather than further restricting when `DefaultSortOrder` is applied.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (e74637c) to head (f674dd7).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #8062   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          766       766           
  Lines        34155     34155           
  Branches      4697      4697           
=========================================
  Hits         34155     34155           
Flag Coverage Δ
BB 100.00% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Fixes a bug where setting DefaultSort/DefaultSortOrder on a Table column caused sorting to be reset on every column rebuild, breaking user-initiated sorting after the first render. The default sort initialization is moved from BuildTableColumnsAsync (which runs on every render) to the first-render branch of OnAfterRenderAsync, so user sort selections persist on subsequent renders.

Changes:

  • Move default sort assignment (SortName/SortOrder from a column with Sortable=true, DefaultSort=true) out of BuildTableColumnsAsync.
  • Apply default sort once in OnAfterRenderAsync first-render branch, after building columns and before initial query.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ArgoZhang ArgoZhang merged commit b1988f8 into main May 28, 2026
3 checks passed
@ArgoZhang ArgoZhang deleted the fix-table branch May 28, 2026 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug(Table): 列设置了默认排序排序功能就会失效

2 participants