Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 25, 2025

auto focus when drawer shown

Summary of the changes (Less than 80 chars)

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

Description

fixes #5208

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

Bug Fixes:

  • Fix: Drawer does not focus when opened.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 25, 2025

Reviewer's Guide by Sourcery

This pull request implements auto focus when the drawer is shown. It also refactors the drawer open/close logic to be more concise.

Sequence diagram for drawer show/hide behavior

sequenceDiagram
    participant U as User
    participant D as Drawer
    participant A as Animation Frame

    U->>D: Open drawer
    D->>D: Add overflow-hidden to body
    D->>A: Request animation frame
    A-->>D: Animation frame callback
    D->>D: Add show class
    D->>D: Set focus

    U->>D: Close drawer
    D->>D: Remove show class
    D->>A: Request animation frame
    A-->>D: Animation frame callback
    D->>D: Remove overflow-hidden from body
Loading

State diagram for drawer component

stateDiagram-v2
    [*] --> Closed
    Closed --> Opening: User opens drawer
    Opening --> Open: Animation complete
    Open --> Closing: User closes drawer
    Closing --> Closed: Animation complete

    state Open {
        [*] --> Focused: Auto focus
    }
Loading

File-Level Changes

Change Details Files
Added auto focus to the drawer when it is shown.
  • Added el.focus() to the show function to focus on the drawer when it is opened.
src/BootstrapBlazor/Components/Drawer/Drawer.razor.js
Refactored the drawer open/close logic.
  • Removed the conditional check for el.classList.contains('show') when closing the drawer.
  • Simplified the logic for hiding the drawer.
src/BootstrapBlazor/Components/Drawer/Drawer.razor.js

Assessment against linked issues

Issue Objective Addressed Explanation
#5208 Support auto focus when IsKeyboard is set to true

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 - here's some feedback:

Overall Comments:

  • Please complete the PR template in English and check the appropriate boxes for verification, risk assessment, and other checks. This helps maintainers better understand and review the changes.
  • Consider documenting the accessibility implications of auto-focusing the drawer when shown, and whether this behavior should be configurable.
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.

@ArgoZhang ArgoZhang merged commit 01b3e1d into main Jan 25, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the refactor-drawer branch January 25, 2025 16:45
@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 (692d46c) to head (0ec37e7).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5211   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28194     28198    +4     
  Branches      4057      4058    +1     
=========================================
+ Hits         28194     28198    +4     

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

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 auto focus when set IsKeyboard to true

2 participants