Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(ITableColumn): add GetTooltipText method #4889

Merged
merged 9 commits into from
Dec 19, 2024
Merged

fix(ITableColumn): add GetTooltipText method #4889

merged 9 commits into from
Dec 19, 2024

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Dec 19, 2024

add GetTooltipText method

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #4888

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

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

Introduce a new synchronous method GetTooltipText to replace the obsolete asynchronous GetTooltipTextCallback method for tooltip text retrieval in table columns. Update relevant components and tests to use the new method.

Bug Fixes:

  • Replace the asynchronous GetTooltipTextCallback method with a synchronous GetTooltipText method to fix tooltip text retrieval issues.

Enhancements:

  • Mark the GetTooltipTextCallback method as obsolete and recommend using the new synchronous GetTooltipText method.

Tests:

  • Update unit tests to reflect the change from GetTooltipTextCallback to GetTooltipText, ensuring proper testing of the new synchronous method.

Copy link

sourcery-ai bot commented Dec 19, 2024

Reviewer's Guide by Sourcery

This PR replaces the asynchronous GetTooltipTextCallback method with a synchronous GetTooltipText method in the table column components. The change simplifies tooltip text generation by removing unnecessary async/await operations.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Introduced a new synchronous tooltip text callback method and deprecated the async version
  • Added new synchronous GetTooltipText property of type Func<object?, string?>
  • Marked GetTooltipTextCallback as Obsolete with migration guidance
  • Updated tooltip rendering logic to use synchronous method
  • Added XML documentation for the new property
src/BootstrapBlazor/Components/Table/ITableColumn.cs
src/BootstrapBlazor/Components/Table/InternalTableColumn.cs
src/BootstrapBlazor/Components/Table/TableColumn.cs
Updated implementation code to use the new synchronous method
  • Modified RenderTooltip method to be synchronous
  • Updated CopyValue method to use GetTooltipText instead of GetTooltipTextCallback
  • Changed sample code to use synchronous tooltip generation
src/BootstrapBlazor/Extensions/ITableColumnExtensions.cs
src/BootstrapBlazor.Server/Components/Samples/Table/TablesWrap.razor
src/BootstrapBlazor.Server/Components/Samples/Table/TablesWrap.razor.cs
Updated test cases to reflect the new synchronous approach
  • Renamed test method to match new property name
  • Updated test implementations to use synchronous tooltip generation
  • Modified assertion tests to verify new property behavior
test/UnitTest/Components/TableTest.cs
test/UnitTest/Attributes/AutoGenerateClassTest.cs
test/UnitTest/Extensions/ITableColumnExtensionsTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4888 Add GetTooltipText method to ITableColumn interface and implementations
#4888 Deprecate GetTooltipTextCallback method

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 the bug Something isn't working label Dec 19, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 19, 2024
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Dec 19, 2024
Copy link

@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 @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

Copy link

codecov bot commented Dec 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@578c404). Learn more about missing BASE report.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff            @@
##             main     #4889   +/-   ##
========================================
  Coverage        ?   100.00%           
========================================
  Files           ?       623           
  Lines           ?     27834           
  Branches        ?      3990           
========================================
  Hits            ?     27834           
  Misses          ?         0           
  Partials        ?         0           

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

@ArgoZhang ArgoZhang changed the title bug(ITableColumn): add GetTooltipText method refactor(ITableColumn): add GetTooltipText method Dec 19, 2024
@ArgoZhang ArgoZhang changed the title refactor(ITableColumn): add GetTooltipText method fix(ITableColumn): add GetTooltipText method Dec 19, 2024
@ArgoZhang ArgoZhang merged commit 06ed5f0 into main Dec 19, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the fix-tooltip branch December 19, 2024 01:41
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(ITableColumn): add GetTooltipText method
1 participant