8000 fix(BModal): ensure clicking inside and releasing outside does not close modal (#2703) by n-rowe · Pull Request #2704 · bootstrap-vue-next/bootstrap-vue-next · GitHub
[go: up one dir, main page]
Skip to content

fix(BModal): ensure clicking inside and releasing outside does not close modal (#2703) #2704

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 22, 2025
Merged

fix(BModal): ensure clicking inside and releasing outside does not close modal (#2703) #2704

merged 2 commits into from
May 22, 2025

Conversation

n-rowe
Copy link
Contributor
@n-rowe n-rowe commented May 19, 2025 •
edited by coderabbitai bot
Loading

Describe the PR

Closes #2703

Uses the VueUse onClickOutside function similar to BDropdown and BPopover so that when a user begins clicking inside the modal and releases outside, it does not close the modal.
This behaviour matches the Bootstrap V5 modal behaviour.

Small replication

As described in the issue, the behaviour now falls in-line with Bootstrap V5.
With the following App.vue:

<template>
  <BContainer>
    <BModal v-model="isModalVisible" title="My Modal">Hello world</BModal>
    <BButton @click="isModalVisible = true">Show Modal</BButton>
  </BContainer>
</template>

<script setup lang="ts">
// You can use this file as a development spot to test your changes
// Please do not commit this file
import {BButton, BContainer, BModal} from './components'
import {ref} from 'vue'
const isModalVisible = ref(false)
</script>

Behaviour before changes
2025-05-19-170116-firefox

Behaviour after changes
2025-05-19-170032-firefox

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

  • Bug Fixes
    • Improved modal behavior by updating how backdrop interactions are detected, ensuring the modal closes more reliably when clicking outside the modal content.

@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

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

@coderabbitai coderabbitai
Copy link
coderabbitai bot commented May 19, 2025 •
edited
Loading

Walkthrough

The event handler for detecting backdrop clicks in the modal component was changed from listening to the click.self event to listening to the mousedown.self event on the root modal container. No other changes to the modal's logic, event handling, or public API were made.

Changes

File(s) Change Summary
packages/bootstrap-vue-next/src/components/BModal/BModal.vue Changed backdrop event listener from click.self to mousedown.self to detect backdrop interaction earlier.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ModalContainer

    User->>ModalContainer: Mousedown on backdrop
    ModalContainer-->>User: Modal closes
Loading

Assessment against linked issues

Objective Addressed Explanation
Prevent modal from closing when releasing mouse input outside the modal (#2703) ✅ Changing from click.self to mousedown.self prevents closing on mouse release outside modal.

Poem

A tap, a press, a gentle squeeze,
The modal listens with greater ease.
No sudden close when fingers roam,
The backdrop waits till mouse is home.
Rabbit hops with joy anew,
Modal’s dance is smooth and true!
🐰🎉

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

📜 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 88bd6c0 and 5206ac5.

📒 Files selected for processing (1)
  • packages/bootstrap-vue-next/src/components/BModal/BModal.vue (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/bootstrap-vue-next/src/components/BModal/BModal.vue

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.

@VividLemon
Copy link
Member

@xvaara wasnt there a reason why onclickoutside was removed

@xvaara
Copy link
Contributor
xvaara commented May 22, 2025

@xvaara wasnt there a reason why onclickoutside was removed

Yes there was, I don't really remember what it was anymore.

But it seems this is fixable by changing the @click to @mousedown on the modal element.

@xvaara xvaara merged commit 85e987c into bootstrap-vue-next:main May 22, 2025
1 check passed
@github-actions github-actions bot mentioned this pull request May 22, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request May 22, 2025
Merged
6 tasks
@n-rowe
Copy link
Contributor Author
n-rowe commented May 23, 2025

@xvaara wasnt there a reason why onclickoutside was removed

Yes there was, I don't really remember what it was anymore.

But it seems this is fixable by changing the @click to @mousedown on the modal element.

Whilst this does fix my initial issue, it does differ from the Bootstrap V5 modal behaviour.

If a user intends to drag select some text within a modal and starts on the backdrop it will immediately close instead of only closing on mouseup.

I think it would be ideal to learn why onClickOutside is unsuitable and what issues it caused because it provides the most accurate behaviour to BV5. I couldn't find usage of onClickOutside in the BModal.vue commit history. It seems the only place it's used is BDropdown and BPopover.

Command I used to find references of 'onClickOutside' in git history

> git log -G"onClickOutside" -p | Select-String "diff"
diff --git a/packages/bootstrap-vue-next/src/components/BPopover/BPopover.vue
b/packages/bootstrap-vue-next/src/components/BPopover/BPopover.vue
diff --git a/packages/bootstrap-vue-next/src/components/BDropdown/BDropdown.vue
b/packages/bootstrap-vue-next/src/components/BDropdown/BDropdown.vue
diff --git a/packages/bootstrap-vue-next/src/components/BPopover.vue
b/packages/bootstrap-vue-next/src/components/BPopover.vue
diff --git a/packages/bootstrap-vue-next/src/components/BDropdown/BDropdown.vue
b/packages/bootstrap-vue-next/src/components/BDropdown/BDropdown.vue
diff --git a/packages/bootstrap-vue-next/src/components/BPopover.vue
b/packages/bootstrap-vue-next/src/components/BPopover.vue
diff --git a/packages/bootstrap-vue-next/src/components/BDropdown/BDropdown.vue
b/packages/bootstrap-vue-next/src/components/BDropdown/BDropdown.vue
diff --git a/packages/bootstrap-vue-next/src/components/BDropdown/BDropdown.vue
b/packages/bootstrap-vue-next/src/components/BDropdown/BDropdown.vue
diff --git a/packages/bootstrap-vue-next/src/components/BDropdown/BDropdown.vue
b/packages/bootstrap-vue-next/src/components/BDropdown/BDropdown.vue

xvaara added a commit to xvaara/bootstrap-vue-next that referenced this pull request May 26, 2025
@xvaara
Merge remote-tracking branch 'upstream/main'
5571606 
* 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
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Releasing input outside of the modal causes it to close
3 participants
@n-rowe @VividLemon @xvaara
0