Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 25, 2025

add IsKeyboard parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5206

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 support for closing the Drawer component with the ESC key when the IsKeyboard parameter is set to true.

New Features:

  • Added IsKeyboard parameter to the Drawer component to control whether it can be closed with the ESC key.

Tests:

  • Added unit tests for the IsKeyboard parameter.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 25, 2025

Reviewer's Guide by Sourcery

This pull request adds a new IsKeyboard parameter to the Drawer component, allowing users to close the drawer using the ESC key. It also includes corresponding updates to the demo page and unit tests.

Sequence diagram for Drawer ESC key handling

sequenceDiagram
    actor User
    participant Drawer
    participant EventHandler
    participant JSInterop

    User->>Drawer: Press ESC key
    activate Drawer
    Drawer->>EventHandler: Handle keyup event
    EventHandler->>Drawer: Check if data-bb-keyboard='true'
    alt IsKeyboard enabled
        Drawer->>JSInterop: InvokeMethodAsync('Close')
        JSInterop->>Drawer: Close drawer
        Drawer-->>User: Drawer closes
    else IsKeyboard disabled
        Drawer-->>User: No action
    end
    deactivate Drawer
Loading

File-Level Changes

Change Details Files
Added IsKeyboard parameter to Drawer component
  • Added IsKeyboard property to Drawer component to control ESC key closing behavior.
  • Added IsKeyboard property to DrawerOption to configure the ESC key closing behavior.
  • Added data-bb-keyboard attribute to the Drawer's root div to indicate if ESC key closing is enabled.
  • Modified DrawerContainer to pass the IsKeyboard parameter to the Drawer component.
src/BootstrapBlazor/Components/Drawer/Drawer.razor.cs
src/BootstrapBlazor/Components/Drawer/DrawerOption.cs
src/BootstrapBlazor/Components/Drawer/Drawer.razor
src/BootstrapBlazor/Components/Drawer/DrawerContainer.cs
Implemented ESC key functionality in javascript
  • Added an event listener for the keyup event to detect the ESC key press.
  • Added logic to check if the data-bb-keyboard attribute is set to true before closing the drawer.
  • Added a call to the off method of the EventHandler to remove the event listener when the component is disposed.
src/BootstrapBlazor/Components/Drawer/Drawer.razor.js
Updated demo page to showcase the new IsKeyboard parameter
  • Added a new demo section to showcase the IsKeyboard parameter.
  • Added a new property IsKeyboardOpen to control the state of the new demo.
  • Added a new method OpenKeyboardDrawer to open the new demo.
src/BootstrapBlazor.Server/Components/Samples/Drawers.razor
src/BootstrapBlazor.Server/Components/Samples/Drawers.razor.cs
Added unit tests for the IsKeyboard parameter
  • Added a new unit test to verify the IsKeyboard parameter functionality.
  • Added a check to verify the IsKeyboard parameter is passed to the component when using the DrawerService.
test/UnitTest/Components/DrawerTest.cs
test/UnitTest/Services/DrawerServiceTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5206 Support 'esc' key to close Drawer
#5206 Add support for keyboard interaction in DrawerService

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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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 25, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 25, 2025
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: 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.

@codecov
Copy link

codecov bot commented Jan 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (c4f78b4) to head (24109e4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5207   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28189     28194    +5     
  Branches      4056      4057    +1     
=========================================
+ Hits         28189     28194    +5     

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

@ArgoZhang ArgoZhang merged commit 692d46c into main Jan 25, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the feat-drawer branch January 25, 2025 12:53
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(Drawer): support esc key to close Drawer

2 participants