8000 chore: remove blur from boverlay in cases where its not allowed by br… by VividLemon · Pull Request #2712 · bootstrap-vue-next/bootstrap-vue-next · GitHub
[go: up one dir, main page]

Skip to content

chore: remove blur from boverlay in cases where its not allowed by br… #2712

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

Merged
merged 2 commits into from
May 26, 2025

Conversation

VividLemon
Copy link
Member
@VividLemon VividLemon commented May 26, 2025

…owser

Describe the PR

A clear and concise description of what the pull request does.

Small replication

A small replication or video walkthrough can help demonstrate the changes made. This is optional, but can help observe the intended changes. A mentioned issue that contains a replication also works.

PR checklist

What kind of change does this PR introduce? (check at least one)

  • Bugfix 🐛 - fix(...)
  • Feature - feat(...)
  • ARIA accessibility - fix(...)
  • Documentation update - docs(...)
  • Other (please describe)

The PR fulfills these requirements:

  • Pull request title and all commits follow the Conventional Commits convention or has an override in this pull request body This is very important, as the CHANGELOG is generated from these messages, and determines the next version type. Pull requests that do not follow conventional commits or do not have an override will be denied

Summary by CodeRabbit

  • New Features
    • Added a new section for the BOverlay component in the migration guide, including details about blur limitations.
  • Documentation
    • Clarified in the documentation that the blur effect for overlays only works when the variant is 'transparent' or 'white' and no background color is set.
  • Bug Fixes
      8000
    • Updated overlay behavior so the blur effect is only applied when compatible with the selected variant and background color.

Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link
coderabbitai bot commented May 26, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The changes update the BOverlay component's documentation, migration guide, and implementation. Documentation clarifies that the blur effect requires the variant to be 'white' or 'transparent' and no bgColor set. TypeScript typing for the variant variable is improved. The component logic now restricts blur styling to these documented conditions.

Changes

File(s) Change Summary
apps/docs/src/docs/components/overlay.md Updated overlay backdrop blur label with usage note; improved TypeScript typing for variant.
apps/docs/src/docs/migration-guide.md Added BOverlay migration section; documented blur prop limitations and browser-related note.
packages/bootstrap-vue-next/src/components/BOverlay/BOverlay.vue Restricted blurStyles logic: blur effect only applies if variant is 'white'/'transparent' and no bgColor.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BOverlay
    participant Browser

    User->>BOverlay: Set blur, variant, bgColor props
    BOverlay->>BOverlay: Compute blurStyles
    alt variant is 'white' or 'transparent' and no bgColor
        BOverlay->>Browser: Apply CSS backdropFilter: blur(...)
    else
        BOverlay->>Browser: Do not apply blur
    end
Loading

Possibly related PRs

Poem

A hop and a skip, a blur on the scene,
But only when white or transparent is seen.
With docs now precise and the typing just right,
The overlay shines, clear and bright.
No background color? The blur can appear—
Otherwise, the backdrop stays crystal clear!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 939ab6f and f3a1c6a.

📒 Files selected for processing (1)
  • apps/docs/src/docs/migration-guide.md (1 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
pkg-pr-new bot commented May 26, 2025

bsvn-vite-ts

npm i https://pkg.pr.new/bootstrap-vue-next/bootstrap-vue-next@2712
npm i https://pkg.pr.new/bootstrap-vue-next/bootstrap-vue-next/@bootstrap-vue-next/nuxt@2712

commit: f3a1c6a

Copy link
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
apps/docs/src/docs/migration-guide.md (1)

590-594: Fix grammar and approve documentation addition.

The new BOverlay section effectively documents the blur limitation. However, there's a minor grammatical issue that should be addressed.

Apply this diff to fix the grammar:

-prop `blur` does not work when prop `bgColor` is defined. It also will not work if prop `variant` is anything other than `white` or `transparent`. This overcomes a browser change.
+prop `blur` does not work when the prop `bgColor` is defined. It also will not work if the prop `variant` is anything other than `white` or `transparent`. This overcomes a browser change.

The documentation content is accurate and helpful for migration purposes.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~594-~594: You might be missing the article “the” here.
Context: ...ris defined. It also will not work if propvariantis anything other thanwhite...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 16ebcce and 939ab6f.

📒 Files selected for processing (3)
  • apps/docs/src/docs/components/overlay.md (4 hunks)
  • apps/docs/src/docs/migration-guide.md (1 hunks)
  • packages/bootstrap-vue-next/src/components/BOverlay/BOverlay.vue (1 hunks)
🧰 Additional context used
🪛 LanguageTool
apps/docs/src/docs/migration-guide.md

[uncategorized] ~594-~594: You might be missing the article “the” here.
Context: ...ris defined. It also will not work if propvariantis anything other thanwhite...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
🔇 Additional comments (3)
packages/bootstrap-vue-next/src/components/BOverlay/BOverlay.vue (1)

128-131: LGTM! Well-implemented conditional blur logic.

The conditional logic correctly restricts the backdrop filter blur effect to cases where it's supported by browsers. The condition properly checks for the presence of blur, absence of bgColor, and restricts variants to 'white' or 'transparent'. This aligns perfectly with the PR objective to remove blur where it's not allowed by browsers.

apps/docs/src/docs/components/overlay.md (2)

98-98: Excellent documentation clarity improvement.

The updated label text clearly explains the blur limitations, helping users understand when the blur effect will and won't work. This aligns perfectly with the component implementation and provides valuable guidance to developers.

Also applies to: 147-150


189-189: Great TypeScript improvements for better type safety.

The changes enhance type safety and developer experience:

  1. Making the variants array as const provides better type inference and prevents accidental modifications
  2. Properly typing the variant ref with (typeof variants)[number] ensures only valid variant values can be assigned

These improvements make the code more robust and provide better IDE support.

Also applies to: 192-192, 953-954

@VividLemon VividLemon merged commit 790679d into bootstrap-vue-next:main May 26, 2025
3 of 4 checks passed
xvaara added a commit to xvaara/bootstrap-vue-next that referenced this pull request May 26, 2025
* upstream/main:
  chore: remove blur from boverlay in cases where its not allowed by br… (bootstrap-vue-next#2712)
  feat(BTableLite): add `table-colgroup` slot (bootstrap-vue-next#2680)
  perf: use getter functions over computed in some cases
  feat(BModal): use css var for zindex, add helper vars and ontop class (bootstrap-vue-next#2556)
  feat(BFormTags): added feedbackAriaLive prop  (bootstrap-vue-next#2696)
  fix(scss) moved all scss styles out of components (bootstrap-vue-next#2671)
  fix(BModal): ensure clicking inside and releasing outside does not close modal (bootstrap-vue-next#2703) (bootstrap-vue-next#2704)
  fix(BToast): race condition if using setInterval to update countdown
  doc data
  feat(BPopover): add titleClass and bodyClass, remove unneeded customClass prop since class is inherited to the same place
  feat(BToast): add noProgress prop, make progress show as default if modelValue is number. fix(useToastController): if using the deprecated show method the countdown didn't start.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant
0