8000 feat(BFormTags): added feedbackAriaLive prop by hnben · Pull Request #2696 · bootstrap-vue-next/bootstrap-vue-next · GitHub
[go: up one dir, main page]
Skip to content

feat(BFormTags): added feedbackAriaLive prop #2696

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 8 commits into from
May 24, 2025
Merged

feat(BFormTags): added feedbackAriaLive prop #2696

merged 8 commits into from
May 24, 2025

Conversation

hnben
Copy link
Contributor
@hnben hnben commented May 15, 2025 •
edited by coderabbitai bot
Loading

Describe the PR

Created feedbackAriaLive prop for BFormTags to configure aria-live attribute on feedback text and added unit tests. Fixes #2674.

Contributor: Noah Lanctot - https://github.com/InfiniteGmng

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 option to customize the ARIA live region politeness for feedback messages in the tag input component, improving accessibility for screen reader users.

  • Tests

    • Introduced new test cases to verify the correct behavior of the ARIA live region setting in the tag input component.

@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 15, 2025 •
edited
Loading

"""

Walkthrough

The changes introduce a new prop, feedbackAriaLive, to the BFormTags component, allowing customization of the aria-live attribute for feedback messages. The default is set to "assertive". Corresponding TypeScript typings and tests are updated to support and verify this new prop and its behavior.

Changes

File(s) Change Summary
packages/bootstrap-vue-next/src/components/BFormTags/BFormTags.vue Added feedbackAriaLive prop (default: "assertive"); bound it to feedback <div>'s aria-live.
packages/bootstrap-vue-next/src/types/ComponentProps.ts Added feedbackAriaLive property to BFormTagsProps interface, typed as AriaAttributes['aria-live'].
packages/bootstrap-vue-next/src/components/BFormTags/form-tags.spec.ts Added tests to verify the aria-live attribute reflects the feedbackAriaLive prop values.
apps/docs/src/data/components/formTags.data.ts Added feedbackAriaLive prop metadata with default and description for documentation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BFormTags
    participant FeedbackDiv

    User->>BFormTags: Set feedbackAriaLive prop (optional)
    BFormTags->>FeedbackDiv: Render feedback <div> with aria-live = feedbackAriaLive
    User-->>FeedbackDiv: Receives feedback message with correct aria-live attribute
Loading

Assessment against linked issues

Objective Addressed Explanation
Implement feedback-aria-live prop on BFormTags (#2674) ✅

Poem

The tags now whisper, shout, or stay still,
With aria-live set by your will.
Assertive or polite, you choose the way—
Feedback adapts to what you say.
A hop and a skip, the tests all pass,
This bunny’s work is done at last! 🐇✨
"""

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.

📜 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 2f4fb69 and c12b51c.

📒 Files selected for processing (1)
  • apps/docs/src/data/components/formTags.data.ts (1 hunks)
🔇 Additional comments (1)
apps/docs/src/data/components/formTags.data.ts (1)

93-97: Excellent accessibility improvement!

The addition of the feedbackAriaLive prop is well-documented and follows the correct format. This enhancement allows developers to customize how screen readers announce feedback messages, which is crucial for accessibility. The default value of 'assertive' is appropriate for feedback text as it ensures important messages are announced immediately to screen reader users.

The documentation is properly formatted, alphabetically positioned, and provides a clear description of the prop's purpose.

✨ Finishing Touches
  • 📝 Generate Docstrings

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 pkg.pr.new
Copy link
pkg-pr-new bot commented May 23, 2025

bsvn-vite-ts

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

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

commit: c12b51c

dwgray
dwgray approved these changes May 24, 2025
View reviewed changes
Copy link
Member
@dwgray dwgray left a comment

Choose a reason for hiding this comment

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

This looks good to me.

@dwgray dwgray merged commit b65c1e4 into bootstrap-vue-next:main May 24, 2025
5 checks passed
@github-actions github-actions bot mentioned this pull request May 24, 2025
Merged
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

@dwgray dwgray dwgray approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

feedback-aria-live is not implemented on BFormTags
3 participants
@hnben @dwgray @InfiniteGmng
0