Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 14, 2025

use IsClearable instead of Clearable

Summary of the changes (Less than 80 chars)

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

Description

fixes #5107

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

Replace the 'Clearable' parameter with 'IsClearable' in input components, marking the former as obsolete while maintaining backward compatibility.

New Features:

  • Introduce the 'IsClearable' parameter to replace the deprecated 'Clearable' parameter for input components.

Enhancements:

  • Mark the 'Clearable' and 'ClearableIcon' parameters as obsolete and provide backward compatibility by mapping them to 'IsClearable' and 'ClearIcon' respectively.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 14, 2025

Reviewer's Guide by Sourcery

This pull request deprecates the 'Clearable' and 'ClearableIcon' properties in favor of 'IsClearable' and 'ClearIcon'. The changes include updating the component logic, samples, and unit tests to use the new properties, ensuring backward compatibility by marking the old properties as obsolete.

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

File-Level Changes

Change Details Files
Deprecation of 'Clearable' and 'ClearableIcon' properties in favor of 'IsClearable' and 'ClearIcon'.
  • Marked 'Clearable' as obsolete and introduced 'IsClearable'.
  • Marked 'ClearableIcon' as obsolete and introduced 'ClearIcon'.
  • Updated internal logic to use 'IsClearable' and 'ClearIcon'.
src/BootstrapBlazor/Components/Input/BootstrapInput.razor.cs
Updated usage of 'Clearable' to 'IsClearable' in component samples.
  • Replaced 'Clearable' with 'IsClearable' in sample component usage.
src/BootstrapBlazor.Server/Components/Samples/Inputs.razor
Modified unit tests to use 'IsClearable' instead of 'Clearable'.
  • Updated test cases to use 'IsClearable' property.
  • Ensured tests validate the new 'IsClearable' functionality.
test/UnitTest/Components/InputTest.cs
Updated Razor component logic to use 'IsClearable'.
  • Replaced 'Clearable' with 'IsClearable' in Razor component logic.
src/BootstrapBlazor/Components/Input/BootstrapInput.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5107 Replace 'Clearable' parameter with 'IsClearable' parameter in the Input component
#5107 Maintain backwards compatibility by marking old parameter as obsolete
#5107 Update all references to the 'Clearable' parameter to use 'IsClearable'

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 enhancement New feature or request label Jan 14, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 14, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) January 14, 2025 02:13
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 Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6a85589) to head (4897227).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5108   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28159     28159           
  Branches      4039      4039           
=========================================
  Hits         28159     28159           

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

@ArgoZhang ArgoZhang merged commit 85b22b1 into main Jan 14, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-input branch January 14, 2025 02:15
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(Input): use IsClearable instead of Clearable

2 participants