Skip to content

docs(bmodal): mark header-tag and footer-tag as deprecated #2881

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
VividLemon merged 2 commits into from
Oct 22, 2025
Merged

docs(bmodal): mark header-tag and footer-tag as deprecated #2881

VividLemon merged 2 commits into from
Oct 22, 2025

Conversation

@dwgray
Copy link
Member

@dwgray dwgray commented Oct 21, 2025 •
edited
Loading

Describe the PR

resolves #2867

  • Add note and workaround to the migration guide
  • Update parity spreadsheet

Small replication

N/A

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

  • Documentation
    • Updated the migration guide for BModal: clarified that footer-tag and header-tag are deprecated and recommends using the footer and title slots for custom rendering.
    • Fixed and updated the slot reference link/anchor in the Modal Slot changes section to point to the correct slot-based rendering documentation.

Copilot AI review requested due to automatic review settings October 21, 2025 17:32
@bolt-new-by-stackblitz
Copy link

bolt-new-by-stackblitz bot commented Oct 21, 2025

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

Copilot AI reviewed Oct 21, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the documentation to mark the header-tag and footer-tag props in BModal as deprecated. The change removes the "Not Yet Implemented" notice and provides guidance on using the footer and title slots as alternatives.

Key Changes

  • Replaced NotYetImplemented component with deprecation notice
  • Added migration guidance directing users to the modal documentation for slot-based alternatives

@dwgray dwgray requested a review from xvaara October 21, 2025 17:32
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 21, 2025 •
edited
Loading

Walkthrough

Replaced a NotYetImplemented placeholder in the BModal migration guide with a deprecation note: footer-tag and header-tag are deprecated and users should use the footer and title slots; updated the slot-reference URL to point to the modal custom rendering-with-slots docs.

Changes

Cohort / File(s) Summary
BModal migration documentation
apps/docs/src/docs/migration-guide.md		 Replaced <NotYetImplemented/> placeholder with a deprecation note for footer-tag and header-tag, instructing use of footer and title slots and updating the BootstrapVueNext slot-reference URL to the modal custom rendering-with-slots documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

Suggested reviewers

  • VividLemon

Poem

🐰
A tiny note once hid away,
The modal's tags had lost their way.
Now slots lead travelers through the night,
Footer and title shine so bright.
Hop on—migration's in plain sight!

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Linked Issues Check ⚠️ Warning Issue #2867 explicitly requests the implementation of footer-tag and header-tag properties in BModal to match bootstrap-vue behavior, stated as "Add support for footer-tag and header-tag to BModal to match bootstrap-vue behavior (implement these props)." However, the PR does not implement these properties; instead, it marks them as deprecated in the migration guide documentation and suggests using footer and title slots as alternatives. The PR addresses the issue by documenting a deprecation path rather than fulfilling the primary objective of implementing the requested properties. The code changes should implement the footer-tag and header-tag properties as requested in issue #2867, rather than only documenting them as deprecated. If the team has decided to deprecate these properties in favor of using slots instead, this decision should be explicitly documented and discussed in the issue or PR before merging, as it represents a deviation from the stated objective to add these properties for completeness and parity with bootstrap-vue.
✅ Passed checks (4 passed)
Check name Status Explanation
Title Check ✅ Passed The PR title "docs(bmodal): mark header-tag and footer-tag as deprecated" is clear, concise, and directly describes the main change documented in the raw summary. It follows Conventional Commits format with the "docs" prefix and accurately reflects what the changeset does: updating documentation to mark these tags as deprecated and suggesting slots as alternatives. The title gives a teammate scanning the history a clear understanding of the primary change.
Out of Scope Changes Check ✅ Passed All changes in this PR are directly related to issue #2867 and its stated objective of addressing the missing footer-tag and header-tag properties. The modifications to the migration guide adding deprecation notes and updating documentation links are intentionally tied to this issue. There are no extraneous changes introduced that fall outside the scope of addressing the linked issue.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Description Check ✅ Passed The pull request description follows the required template structure and includes all mandatory sections. The "Describe the PR" section clearly identifies the resolved issue (#2867) and lists the key changes made (adding a note and workaround to the migration guide, updating the parity spreadsheet). The "Small replication" section is appropriately marked as N/A since the change is documentation-only. The PR checklist is properly completed with the "Documentation update" change type selected and the Conventional Commits requirement marked as fulfilled. The PR title from the objectives ("docs(bmodal): mark header-tag and footer-tag as deprecated") follows the Conventional Commits convention with the proper format.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@pkg-pr-new
Copy link

pkg-pr-new bot commented Oct 21, 2025

bsvn-vite-ts

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

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

commit: 23c688a

@VividLemon VividLemon merged commit 3ef04e3 into bootstrap-vue-next:main Oct 22, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@VividLemon VividLemon VividLemon approved these changes

@xvaara xvaara Awaiting requested review from xvaara

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

BModal doesn’t implement footer-tag or header-tag

2 participants

@dwgray @VividLemon