Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Dec 19, 2024

GetTooltipTextCallback not work

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

Fix the tooltip text callback functionality by replacing the synchronous GetTooltipText method with the asynchronous GetTooltipTextCallback method across the codebase. Update related unit tests to ensure the new callback method is properly tested.

Bug Fixes:

  • Fix the issue where GetTooltipTextCallback was not functioning correctly by replacing GetTooltipText with GetTooltipTextCallback in the tooltip rendering logic.

Enhancements:

  • Deprecate the synchronous GetTooltipText method in favor of the asynchronous GetTooltipTextCallback method for better performance and flexibility.

Tests:

  • Update unit tests to reflect the change from GetTooltipText to GetTooltipTextCallback, ensuring the new callback method is tested.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 19, 2024

Reviewer's Guide by Sourcery

This PR fixes an issue with tooltip functionality in the Table component by replacing the synchronous GetTooltipText with an asynchronous GetTooltipTextCallback implementation. The changes include updating the Tooltip component to handle async callbacks and removing deprecated code.

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

File-Level Changes

Change Details Files
Implemented asynchronous tooltip text loading in the Tooltip component
  • Added new GetTitleCallback parameter for async tooltip content
  • Implemented OnParametersSetAsync to handle async title loading
  • Updated parameter initialization logic to support async callbacks
src/BootstrapBlazor/Components/Tooltip/Tooltip.razor.cs
Removed deprecated synchronous GetTooltipText in favor of async GetTooltipTextCallback
  • Removed GetTooltipText property and related code
  • Updated CopyValue method to use GetTooltipTextCallback
  • Modified RenderTooltip method to handle async tooltip text
src/BootstrapBlazor/Components/Table/ITableColumn.cs
src/BootstrapBlazor/Components/Table/InternalTableColumn.cs
src/BootstrapBlazor/Components/Table/TableColumn.cs
src/BootstrapBlazor/Extensions/ITableColumnExtensions.cs
Updated tests and sample code to use async tooltip implementation
  • Renamed and updated tooltip-related test cases
  • Modified sample code to use GetTooltipTextCallback
  • Updated test assertions for async tooltip functionality
test/UnitTest/Components/TableTest.cs
test/UnitTest/Components/TableColumnTest.cs
src/BootstrapBlazor.Server/Components/Samples/Table/TablesWrap.razor
src/BootstrapBlazor.Server/Components/Samples/Table/TablesWrap.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4889 Replace GetTooltipText method with GetTooltipTextCallback The PR does the opposite - it removes GetTooltipText and keeps GetTooltipTextCallback, while the issue requested adding GetTooltipText to replace the callback version.
#4889 Update components and tests to use the new synchronous method The PR updates components and tests but to use the asynchronous GetTooltipTextCallback method instead of implementing the requested synchronous GetTooltipText 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
Copy link
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 @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.

@codecov
Copy link

codecov bot commented Dec 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e3a1545) to head (94261e8).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4893   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          623       623           
  Lines        27834     27846   +12     
  Branches      3990      3993    +3     
=========================================
+ Hits         27834     27846   +12     

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

@ArgoZhang ArgoZhang merged commit 7de5f7e into main Dec 19, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-tooltip branch December 19, 2024 07:15
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

2 participants