feat(input fields): expose method onBlur to be able to manually stop debouncing (draft) #2758

tbl0605 · 2025-06-23T13:40:49Z

Now that issue #2721 has been merged, I've been thinking about situations where it would be useful to be able to manually stop debouncing (while editing a field's contents).
Let's say we're using a b-form-input field with a high debounce value (e.g. 2 seconds, to make it easier to observe the issue) and we want to be able to submit a form by pressing Enter in that active field.
In this case, the value sent by the form might be incomplete due to the debounce delay on the field's model value.

Small replication

You can observe the problem in this demo.

The simplest fix is to expose the "onBlur" method (calling it "flushDebounce" for example) and add the following code to the b-form-input field:

<form ref="myForm" @submit.stop.prevent="...">
    <b-form-input ref="myInput" :debounce="2000" v-model="inputValue"
      @keydown.enter.prevent="
          $refs.myInput.flushDebounce($event);
          $refs.myForm.dispatchEvent(new Event('submit', { cancelable: true }));
      "
     />
</form>

You can try the fix in this demo (using a patched version of bootstrap-vue-next).

I'm leaving this issue as a draft for now, as I'm not sure if my patch is the ideal solution to this type of problem. Any suggestions are welcome.

PR checklist

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

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
- Exposed a new property for advanced input handling on both input and textarea components, allowing users to trigger certain actions when the input loses focus.

bolt-new-by-stackblitz · 2025-06-23T13:40:52Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-06-23T13:40:59Z

Walkthrough

This change updates the BFormInput and BFormTextarea components by adding a flushDebounce property to their exposed interfaces, assigning it to the existing onBlur method. No internal logic or control flow is modified.

Changes

File(s)	Change Summary
packages/bootstrap-vue-next/src/components/BFormInput/BFormInput.vue	Exposed new `flushDebounce` property referencing `onBlur`.
packages/bootstrap-vue-next/src/components/BFormTextarea/BFormTextarea.vue	Exposed new `flushDebounce` property referencing `onBlur`.

Possibly related PRs

bootstrap-vue-next/bootstrap-vue-next#2721: Adds a flushDebounce property exposing the existing onBlur method in form input and textarea components, directly related to this PR’s changes.

Suggested reviewers

VividLemon

Poem

A hop, a skip, a debounce flush,
Exposed on blur, no need to rush.
Input and textarea, now in sync,
With tidy code, quicker than you think!
🐇✨

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.

pkg-pr-new · 2025-06-23T13:43:29Z

bsvn-vite-ts

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

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

commit: 92f1b91

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/bootstrap-vue-next/src/components/BFormInput/BFormInput.vue (1)
104-104: Implementation looks correct but consider potential side effects.

The approach of exposing onBlur as flushDebounce aligns well with the PR objective of manually flushing debounced input values. Blur events typically handle flushing pending debounced operations, which should resolve the form submission issue described in the PR.

However, consider that calling flushDebounce() will execute the full blur handler, which may have side effects beyond just flushing the debounce (such as emitting blur events, validation updates, or focus state changes). This might be acceptable for the intended use case, but users should be aware of this behavior.

Consider adding a JSDoc comment to document this exposed method:
 defineExpose({
   blur,
   element: input,
+  /** Manually flush any pending debounced input by triggering blur logic */
   flushDebounce: onBlur,
   focus,
 })

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4aaddbe and 92f1b91.

📒 Files selected for processing (2)

packages/bootstrap-vue-next/src/components/BFormInput/BFormInput.vue (1 hunks)
packages/bootstrap-vue-next/src/components/BFormTextarea/BFormTextarea.vue (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: build

🔇 Additional comments (1)

packages/bootstrap-vue-next/src/components/BFormTextarea/BFormTextarea.vue (1)

117-117: Consistent implementation with BFormInput - looks good.

The implementation mirrors the approach used in BFormInput, maintaining consistency across form input components. This ensures developers have a unified API for flushing debounced values across different input types.

expose the "onBlur" method as the "flushDebounce" method

92f1b91

coderabbitai bot reviewed Jun 23, 2025

View reviewed changes

VividLemon marked this pull request as draft June 23, 2025 15:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(input fields): expose method onBlur to be able to manually stop debouncing (draft) #2758

feat(input fields): expose method onBlur to be able to manually stop debouncing (draft) #2758

tbl0605 commented Jun 23, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

bolt-new-by-stackblitz bot commented Jun 23, 2025

Uh oh!

coderabbitai bot commented Jun 23, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jun 23, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

feat(input fields): expose method onBlur to be able to manually stop debouncing (draft) #2758

Are you sure you want to change the base?

feat(input fields): expose method onBlur to be able to manually stop debouncing (draft) #2758

Conversation

tbl0605 commented Jun 23, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Small replication

PR checklist

Summary by CodeRabbit

Uh oh!

bolt-new-by-stackblitz bot commented Jun 23, 2025

Uh oh!

coderabbitai bot commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jun 23, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tbl0605 commented Jun 23, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 23, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)