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(Input): add Clearable parameter #4991

Merged
merged 5 commits into from
Dec 29, 2024
Merged

feat(Input): add Clearable parameter #4991

merged 5 commits into from
Dec 29, 2024

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Dec 29, 2024

add Clearable parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #4990

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

Add a "Clearable" parameter to the Input component to display a clear button.

New Features:

  • Added a "Clearable" parameter to the Input component. When set to true, a clear button is displayed in the input field, allowing users to clear the input value.

Tests:

  • Added unit tests for the "Clearable" parameter.

Copy link

sourcery-ai bot commented Dec 29, 2024

Reviewer's Guide by Sourcery

This PR adds a new Clearable parameter to the BootstrapInput component. When set to true, a clear button is displayed in the input field, allowing users to clear the input value. This feature also includes a callback function OnClear which is invoked when the clear button is clicked.

Sequence diagram for input clearing process

sequenceDiagram
    actor User
    participant Input as BootstrapInput
    participant Callback as OnClear Callback

    User->>Input: Click clear icon
    activate Input
    alt OnClear callback exists
        Input->>Callback: Invoke OnClear(Value)
        Callback-->>Input: Task completed
    end
    Input->>Input: Set CurrentValueAsString = ""
    deactivate Input
    Input-->>User: Show empty input
Loading

File-Level Changes

Change Details Files
Added Clearable parameter and related features.
  • Added Clearable parameter to BootstrapInput component.
  • Added OnClear callback function.
  • Added ClearableIcon parameter.
  • Added clear button UI elements.
  • Added OnClickClear method to handle clear button clicks.
  • Added ClearableIconString property.
  • Added unit tests for the new functionality.
  • Added new icon for the clear button.
  • Added SCSS styling for the clear button.
  • Updated project file to include new SCSS file.
  • Added keyup handler for Enter and NumpadEnter keys.
  • Added logic to hide clear button when input is readonly or disabled.
src/BootstrapBlazor/Components/Input/BootstrapInput.razor
src/BootstrapBlazor/Components/Input/BootstrapInput.razor.cs
test/UnitTest/Components/InputTest.cs
src/BootstrapBlazor/Enums/ComponentIcons.cs
src/BootstrapBlazor/Components/Input/BootstrapInput.razor.js
src/BootstrapBlazor/Options/IconThemeOptions.cs
src/BootstrapBlazor/wwwroot/scss/components.scss
src/BootstrapBlazor/BootstrapBlazor.csproj
src/BootstrapBlazor/Components/Input/BootstrapInput.razor.scss

Assessment against linked issues

Issue Objective Addressed Explanation
#4990 Provide a clear function to users without them having to implement it themselves
#4990 Implement a clearable input feature similar to Element Plus input component

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 Dec 29, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 29, 2024
@ArgoZhang ArgoZhang enabled auto-merge (squash) December 29, 2024 12:37
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: 1 issue found
  • 🟢 Security: all looks good
  • 🟡 Testing: 2 issues found
  • 🟢 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 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (70ebace) to head (0f3a34a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4991   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          630       630           
  Lines        28077     28105   +28     
  Branches      4026      4030    +4     
=========================================
+ Hits         28077     28105   +28     

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

@ArgoZhang ArgoZhang merged commit f83730d into main Dec 29, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-input branch December 29, 2024 12:39
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): add Clearable parameter(Now it is IsClearable for consistance)
1 participant