-
-
Notifications
You must be signed in to change notification settings - Fork 174
docs(BApp): add some additional details around legacy plugin use #2820
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
Conversation
|
|
WalkthroughDocumentation updates: replaced HighlightCard elements with warning admonitions, adjusted headings, added cross-references to backward-compatibility docs, and explicitly deprecated modalControllerPlugin, toastControllerPlugin, and popoverControllerPlugin in favor of orchestratorPlugin. No code or public API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10–15 minutes Possibly related PRs
Suggested reviewers
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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 (2)
apps/docs/src/docs.md (1)
133-138: Good addition: prominent pointer for legacy plugin users; consider clarifying what “individual plugins” refers to and pre-empting deprecation.The admonition helps reduce upgrade confusion. To make it fully self‑contained for readers who won’t click through, briefly name the deprecated “controller” plugins and the replacement, and use the phrase “legacy (individual) plugins” for consistency with the other page.
Proposed tweak within this block:
::: warning -If you are using individual plugins, please see the [`BApp` documentation](/docs/components/app#backward-compatibility) for additional details. +If you are using legacy (individual) plugins, please see the [`BApp` documentation](/docs/components/app#backward-compatibility) for additional details. +The individual controller plugins `modalControllerPlugin`, `toastControllerPlugin`, and `popoverControllerPlugin` are deprecated — use `orchestratorPlugin` instead. :::Please verify in a local docs preview that the anchor /docs/components/app#backward-compatibility resolves correctly from this page and that the site’s build (sidebar/TOC generation) still behaves as expected after introducing the admonition.
apps/docs/src/docs/components/app.md (1)
354-361: Strengthen the migration note with a concrete mapping and scannable formatting; optionally include timing/version.Great to explicitly call out deprecated controller plugins and the replacement. Two small improvements:
- Make the list a bullet list for scanability.
- Provide a one‑line code sample that demonstrates replacing an existing controller plugin registration with
orchestratorPlugin.- If you have a target removal version or timeframe, add it to set expectations.
Suggested content tweak inside the admonition:
-::: warning Migration Note -The plugins will show deprecation warnings but continue to work until removed in a future version. - -However, the individual plugins `modalControllerPlugin`, `toastControllerPlugin`, and `popoverControllerPlugin` -are deprecated. Please replace references to these with a reference to `orchestratorPlugin`. -::: +::: warning Migration Note +The legacy plugins will show deprecation warnings but continue to work until removal in a future version. + +Deprecated individual controller plugins: + +- `modalControllerPlugin` +- `toastControllerPlugin` +- `popoverControllerPlugin` + +Use `orchestratorPlugin` instead. Example: + +```ts +// Before +// app.use(modalControllerPlugin) + +// After +// app.use(orchestratorPlugin) +``` + +For reference on prior plugin APIs, see the BootstrapVue v4 docs (historical): https://bootstrap-vue.github.io/bootstrap-vue/ +:::If you know the planned removal version/date, append a final line like “Removal planned for vX.Y (Month YYYY)” to reduce user uncertainty.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
apps/docs/src/docs.md(1 hunks)apps/docs/src/docs/components/app.md(2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: xvaara
PR: bootstrap-vue-next/bootstrap-vue-next#2701
File: apps/docs/src/docs/migration-guide.md:622-626
Timestamp: 2025-06-05T11:43:10.793Z
Learning: In migration guides, links to the old/previous version's documentation (like bootstrap-vue.org) are appropriate and helpful when explaining deprecated features, as they provide users with reference points for what they're migrating from.
🔇 Additional comments (1)
apps/docs/src/docs/components/app.md (1)
15-15: LGTM: cross‑reference improves discoverability.The inline link to the Backward Compatibility section makes the “plugin compatibility” claim actionable.
commit: |
There was a problem hiding this 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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/docs/src/docs.md (1)
195-207: Incorrect import for unplugin-vue-components (Vite).The example imports a named export from the package root, which will break. For Vite, import the default from 'unplugin-vue-components/vite' (as shown earlier in this page).
-```ts -import {Components} from 'unplugin-vue-components' +```ts +import Components from 'unplugin-vue-components/vite' import {BootstrapVueNextResolver} from 'bootstrap-vue-next/resolvers' Components({ resolvers: [ BootstrapVueNextResolver({ aliases: { BInput: 'BFormInput', }, }), ], })</blockquote></details> </blockquote></details>♻️ Duplicate comments (1)
apps/docs/src/docs/components/app.md (1)
354-366: Confirm removals and tighten the migration wording; add an explicit “how to replace” note.Two asks:
- Please verify the exact removal version and plugin list (modalControllerPlugin, toastControllerPlugin, popoverControllerPlugin) and that orchestratorPlugin is the intended replacement in all cases.
- Minor grammar/flow tweak and an explicit action sentence will reduce confusion.
Apply this doc-only diff to streamline the admonition and clarify the action:
-::: warning Migration Note - -Plugins will show deprecation warnings but continue to work until removed in a future version, with -the following exceptions: - -- `modalControllerPlugin` -- `toastControllerPlugin` -- `popoverControllerPlugin` - -These plugins have been removed as of **version 0.40.0**. -Please replace references to these with a reference to `orchestratorPlugin`. - -::: +::: warning Migration note +The following controller plugins were removed in **v0.40.0**: + +- `modalControllerPlugin` +- `toastControllerPlugin` +- `popoverControllerPlugin` + +Replace any usage with `orchestratorPlugin`. + +All other legacy plugins will continue to emit deprecation warnings until they are removed in a future version. +:::Optionally, add a one-line pointer after the admonition to the legacy-plugin example in this page or to the migration guide.
I can scan the codebase and surface any remaining references to the removed plugins (docs and code) and propose a follow-up PR that replaces or removes them.
🧹 Nitpick comments (3)
apps/docs/src/docs.md (3)
133-139: Good call-out for legacy controller plugins; consider titling the admonition.Adding a short title improves scan-ability.
-::: warning +::: warning Legacy controller plugins @@ :::
140-140: Grammar: “Automatic Registration of Components”Use the noun “Registration” instead of the gerund “Registering”.
-### Automatic Registering of Components +### Automatic Registration of Components
360-368: Solid guidance; consider softening the footprint number or linking to measurement.“~20kb gzipped” can drift over time. Either say “roughly 20kb gzipped (subject to change)” or link to a perf/bundle report page in the docs.
If you’d like, I can add a tiny script that generates a fresh bundle size snapshot using vite-bundle-visualizer and a minimal sample app to keep this number honest in future releases.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
apps/docs/src/docs.md(2 hunks)apps/docs/src/docs/components/app.md(2 hunks)🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: xvaara PR: bootstrap-vue-next/bootstrap-vue-next#2701 File: apps/docs/src/docs/migration-guide.md:622-626 Timestamp: 2025-06-05T11:43:10.793Z Learning: In migration guides, links to the old/previous version's documentation (like bootstrap-vue.org) are appropriate and helpful when explaining deprecated features, as they provide users with reference points for what they're migrating from.📚 Learning: 2025-08-19T14:23:46.746Z
Learnt from: xvaara PR: bootstrap-vue-next/bootstrap-vue-next#2732 File: packages/bootstrap-vue-next/CHANGELOG.md:35-41 Timestamp: 2025-08-19T14:23:46.746Z Learning: In the bootstrap-vue-next repository, CHANGELOG.md files (e.g., packages/bootstrap-vue-next/CHANGELOG.md) are autogenerated and should be ignored in reviews; do not propose edits for them.Applied to files:
apps/docs/src/docs.md🪛 LanguageTool
apps/docs/src/docs.md
[grammar] ~135-~135: There might be a mistake here.
Context: ...llerPlugin,toastControllerPlugin, orpopoverControllerPlugin`, please see th...(QB_NEW_EN)
apps/docs/src/docs/components/app.md
[grammar] ~356-~356: There might be a mistake here.
Context: ... until removed in a future version, with the following exceptions: - `modalContr...(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (2)
apps/docs/src/docs/components/app.md (2)
15-15: Nice: clear cross-reference to migration details.Pointing readers to the Backward Compatibility section from the feature bullets improves discoverability.
354-366: Deprecation removals and replacement usage verified; no action requiredThe verification script confirms that:
modalControllerPlugin,toastControllerPlugin, andpopoverControllerPluginonly appear in the documentation (apps/docs/src/docs…) and are not exported or used in the codebase.orchestratorPluginis defined and exported inpackages/bootstrap-vue-next/src/plugins/orchestrator/index.tsand correctly consumed (e.g., increateBootstrap/index.ts).No further changes are needed.
* upstream/main: (32 commits) chore: release main (bootstrap-vue-next#2838) feat(BButtonToolbar): Add keyboard navigation support (bootstrap-vue-next#2837) fix(BFormSelect): modelValue not being applied during SSR (bootstrap-vue-next#2835) feat(BTable): Implement keyboard navigation (bootstrap-vue-next#2834) fix: BOffcanvas responsive SSR compatibility - defer breakpoint evaluation to client-side (bootstrap-vue-next#2833) chore: release main (bootstrap-vue-next#2831) fix(BDropdown): transition broken by inline display styles (bootstrap-vue-next#2832) feat: change useColorMode selector from 'body' to 'html' (bootstrap-vue-next#2830) chore: release main (bootstrap-vue-next#2817) feat: Add headerAttrs prop to BOffcanvas and BModal components docs: Add useScrollspy documentation fix: Remove lazy-modifier warning on FormInput docs (bootstrap-vue-next#2825) feat(BSort)!: Implement initial-sort-direction and move compare from sort-by to fields (bootstrap-vue-next#2777) docs(table): fix incorrect list item (bootstrap-vue-next#2823) docs: Fix grammar in documentation data files (bootstrap-vue-next#2816) doc(BTooltip): Parity pass (bootstrap-vue-next#2762) docs(BOverlay): Parity pass (bootstrap-vue-next#2767) feat: implement BFormRating disabled state (bootstrap-vue-next#2753) (bootstrap-vue-next#2793) docs: fix otp for index and reference pages (bootstrap-vue-next#2819) docs(BApp): add some additional details around legacy plugin use (bootstrap-vue-next#2820) ...
Describe the PR
I think it's worthwhile to be explicit about deprecations - I don't use individual plugins myself generally, but I think this would trip someone up who is upgrading - hopefully this clarifies.
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)
fix(...)feat(...)fix(...)docs(...)The PR fulfills these requirements:
CHANGELOGis 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 deniedSummary by CodeRabbit