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

feat(Table): render tooltip support LookupService GetItemByKeyAsync #4926

Merged
merged 7 commits into from
Dec 23, 2024

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Dec 23, 2024

render tooltip support LookupService GetItemByKeyAsync

Summary of the changes (Less than 80 chars)

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

Description

fixes #4925

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

New Features:

  • Display tooltips for table cells using asynchronous lookup service.

ArgoZhang and others added 5 commits December 23, 2024 11:57
Co-Authored-By: ZhYan <19183404+Axxbis@users.noreply.github.com>
Co-Authored-By: ZhYan <19183404+Axxbis@users.noreply.github.com>
Co-Authored-By: ZhYan <19183404+Axxbis@users.noreply.github.com>
@bb-auto bb-auto bot added the enhancement New feature or request label Dec 23, 2024
Copy link

sourcery-ai bot commented Dec 23, 2024

Reviewer's Guide by Sourcery

This pull request implements tooltip support for the LookupService GetItemByKeyAsync method in the Table component. It introduces a new MockLookupServiceAsync class for testing and updates the Table component to use the LookupService to retrieve tooltip text asynchronously. It also modifies the ITableColumn interface to include a LookupService property and updates the TableFilter component to use the IsLookup method.

Sequence diagram for Table tooltip rendering with LookupService

sequenceDiagram
    participant Table
    participant TableColumn
    participant LookupService
    participant Tooltip

    Table->>TableColumn: RenderValue(item, lookupService)
    alt IsLookup() && value != null
        TableColumn->>TableColumn: RenderTooltip(value, item, lookupService)
        alt Has GetTitleCallback
            TableColumn->>LookupService: GetItemsAsync(key, data)
            LookupService-->>TableColumn: lookup items
            TableColumn->>TableColumn: Find matching lookup value
            TableColumn->>Tooltip: Set GetTitleCallback
        end
    end
Loading

Class diagram for Table and LookupService integration

classDiagram
    class ITableColumn {
        +Lookup: IEnumerable~LookupItem~
        +LookupService: ILookupService
        +LookupServiceKey: string
        +LookupServiceData: object
        +LookupStringComparison: StringComparison
        +IsLookup() bool
        +RenderValue(item, lookupService) RenderFragment
        +RenderTooltip(text, item, lookupService) RenderFragment
    }

    class ILookupService {
        +GetItemsAsync(key, data) Task~IEnumerable~LookupItem~~
    }

    class Table {
        +LookupService: ILookupService
        +GetValue(col, item) RenderFragment
    }

    Table --> ITableColumn
    Table --> ILookupService
    ITableColumn --> ILookupService
Loading

File-Level Changes

Change Details Files
Added support for asynchronous tooltip retrieval in the Table component using LookupService.
  • Added new tests for LookupServiceKey in TableTest.cs
  • Modified RenderValue and RenderTooltip methods in ITableColumnExtensions.cs to use LookupService
  • Updated GetValue method in Table.razor.cs to use LookupService
test/UnitTest/Components/TableTest.cs
src/BootstrapBlazor/Extensions/ITableColumnExtensions.cs
src/BootstrapBlazor/Components/Table/Table.razor.cs
Updated TableFilter component to use the IsLookup method.
  • Modified TableFilter.razor to use Column.IsLookup() method
  • Removed IsLookup property from TableFilter.razor.cs
  • Updated IsLookup method in IEditorItemExtensions.cs
src/BootstrapBlazor/Components/Filters/TableFilter.razor
src/BootstrapBlazor/Components/Filters/TableFilter.razor.cs
src/BootstrapBlazor/Extensions/IEditorItemExtensions.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4925 Add support for rendering tooltips using LookupService GetItemByKeyAsync

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 this to the v9.0.0 milestone Dec 23, 2024
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Dec 23, 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: 3 issues found
  • 🟢 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 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8de9a2e) to head (192b488).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4926   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          628       628           
  Lines        28082     28078    -4     
  Branches      4042      4041    -1     
=========================================
- Hits         28082     28078    -4     

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

@ArgoZhang ArgoZhang enabled auto-merge (squash) December 23, 2024 05:47
@ArgoZhang ArgoZhang disabled auto-merge December 23, 2024 06:08
@ArgoZhang ArgoZhang merged commit 29bb8a0 into main Dec 23, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-table branch December 23, 2024 06:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat(Table): render tooltip support LookupService GetItemByKeyAsync
1 participant