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

doc(Drawer): add ZIndex parameter documentation #5398

Merged
merged 4 commits into from
Feb 19, 2025
Merged

doc(Drawer): add ZIndex parameter documentation #5398

merged 4 commits into from
Feb 19, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Feb 19, 2025

add ZIndex parameter documentation

Summary of the changes (Less than 80 chars)

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

Description

fixes #5397

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

This pull request adds documentation for the ZIndex parameter of the Drawer component and clarifies how to close the Drawer component from code.

Documentation:

  • Added documentation for the ZIndex parameter of the Drawer component, explaining how to adjust the z-index to prevent it from being obscured by other popups.
  • Updated the documentation to clarify how to close the Drawer component from code, detailing the usage of DialogCloseButton and the OnCloseAsync callback method.
  • Updated the list of components that use z-index.

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Feb 19, 2025
Copy link

sourcery-ai bot commented Feb 19, 2025

Reviewer's Guide by Sourcery

This pull request adds documentation for the ZIndex parameter of the Drawer component, explaining how to use it to control the stacking order of drawers relative to other components.

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

File-Level Changes

Change Details Files
Added documentation for the ZIndex parameter in the Drawer component.
  • Added a ZIndex attribute item to the GetAttributes method in Drawers.razor.cs.
  • Added a section in DrawerServices.razor explaining how to set the ZIndex to adjust the drawer's stacking order.
  • Updated the Layout.razor file to include Drawer in the list of components that use z-index.
src/BootstrapBlazor.Server/Components/Samples/DrawerServices.razor
src/BootstrapBlazor.Server/Components/Samples/Drawers.razor.cs
src/BootstrapBlazor.Server/Components/Pages/Layout.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5397 Add documentation for the ZIndex parameter of the Drawer 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. 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 this to the v9.3.0 milestone Feb 19, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) February 19, 2025 10:01
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 - here's some feedback:

Overall Comments:

  • Please ensure the new documentation is clear and concise for users to understand the purpose and usage of the ZIndex parameter.
  • Verify that the added documentation aligns with the actual behavior and implementation of the ZIndex parameter in the Drawer component.
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.

Copy link

codecov bot commented Feb 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2a050a1) to head (093dbb8).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5398   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          645       645           
  Lines        29276     29276           
  Branches      4135      4135           
=========================================
  Hits         29276     29276           

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

@ArgoZhang ArgoZhang merged commit ce828de into main Feb 19, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the doc-zIndex branch February 19, 2025 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc(Drawer): add ZIndex parameter documentation
1 participant