docs(BPlaceholder): Parity pass #2886

dwgray · 2025-10-23T00:42:21Z

Describe the PR

update migration guide
update documentation
update parity spreadsheet

Small replication

N/A

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

Documentation
- Clarified that placeholders can show loading states for multiple component types
- Added styling and customization guidance tied to Bootstrap theming
- Converted a note to an info block for placeholder animations
Migration
- Deprecated legacy placeholder items and recommended replacements; aligned animation values with current Bootstrap conventions
Chores
- Adjusted placeholder prop typing (no default or runtime behavior changes)

bolt-new-by-stackblitz · 2025-10-23T00:42:24Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-10-23T00:42:30Z

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

The PR updates the placeholder prop type and documentation: variant in placeholder data changed from ColorVariant | null to BgColorVariant | null; docs for the Placeholder component and the migration guide were revised (animation values, deprecations, and styling/customization details).

Changes

Cohort / File(s)	Summary
Placeholder component type definition `apps/docs/src/data/components/placeholder.data.ts`	Changed `variant` prop type from `ColorVariant \| null` to `BgColorVariant \| null`; removed inline TODO comments
Placeholder component documentation `apps/docs/src/docs/components/placeholder.md`	Clarified placeholder scope (multiple component types); converted animation note to an info block; added "Styling and customization" explaining alignment with Bootstrap SCSS variables and theming
Migration guide updates `apps/docs/src/docs/migration-guide.md`	Documented deprecations (BSkeletonImg → BPlaceholderWrapper), updated animation values (Wave/Fade/Throb/None → wave/glow/undefined), and noted replacements for deprecated types (BPlaceholderButton, Avatar/Input guidance)

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

VividLemon
xvaara

Poem

🐰 I hopped through code and found a type,
Switched Color to BgColor — snug and right,
Docs now whisper how placeholders glow,
Migration maps help the changes flow,
A tiny carrot for a tidy site 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The description follows the required template structure and includes a properly completed PR checklist indicating this is a documentation update that follows Conventional Commits. However, the main "Describe the PR" section is severely lacking in detail. It consists of only three sparse bullet points without explaining what specific changes were made to each file, why these changes were necessary, or what parity improvements were achieved. The description fails to provide a clear and concise explanation of what the pull request actually does, leaving a reviewer without adequate context about the scope and impact of the changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "docs(BPlaceholder): Parity pass" follows the Conventional Commits format and clearly indicates this is a documentation-focused update for achieving parity with the BPlaceholder component. It is concise, professional, and provides a teammate scanning the history with enough context to understand the main objective. The title accurately reflects the core purpose of the changes shown in the summary, which involves updates to documentation, migration guides, and a property type adjustment aligned with achieving component parity.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 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 9be61a6 and 2b2c5e7.

📒 Files selected for processing (2)

apps/docs/src/docs/components/placeholder.md (3 hunks)
apps/docs/src/docs/migration-guide.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

apps/docs/src/docs/migration-guide.md

🔇 Additional comments (2)

apps/docs/src/docs/components/placeholder.md (2)

5-6: ✅ Clear description improvement.

The updated description now explicitly mentions "several component types" instead of vague loading state language, making the component's purpose clearer to readers.

26-28: ✅ Better note formatting.

The structured info block format (::: info NOTE :::) is more semantically correct and cleaner than an inline note, improving documentation consistency and readability.

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.}

Copilot

Pull Request Overview

This PR brings the BPlaceholder component documentation up to parity with Bootstrap 5, updating migration guidance, component documentation, and API reference documentation.

Key Changes:

Updated migration guide to document deprecated features and animation value changes
Enhanced component documentation with improved descriptions and styling information
Cleaned up .data.ts file by removing TODO comments for default values

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File	Description
apps/docs/src/docs/migration-guide.md	Added migration notes for deprecated BSkeletonImg, animation value changes, and deprecated type prop
apps/docs/src/docs/components/placeholder.md	Improved component description, converted NOTE to info block, and added styling/customization section
apps/docs/src/data/components/placeholder.data.ts	Removed TODO comments and corrected variant type from ColorVariant to BgColorVariant

apps/docs/src/docs/migration-guide.md

apps/docs/src/docs/components/placeholder.md

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bdf6fee and 9be61a6.

📒 Files selected for processing (3)

apps/docs/src/data/components/placeholder.data.ts (9 hunks)
apps/docs/src/docs/components/placeholder.md (3 hunks)
apps/docs/src/docs/migration-guide.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

apps/docs/src/data/components/*.data.ts

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

apps/docs/src/data/components/*.data.ts: When adding or modifying component props, events, or slots, ALWAYS update the corresponding .data.ts file in apps/docs/src/data/components/
Documentation format in .data.ts files must match TypeScript interfaces exactly (props, emits, slots definitions)

Files:

apps/docs/src/data/components/placeholder.data.ts

🧠 Learnings (1)

📚 Learning: 2025-10-21T19:31:54.084Z

Learnt from: dwgray
PR: bootstrap-vue-next/bootstrap-vue-next#2882
File: apps/docs/src/docs/components/demo/PlaceholderWidth.vue:1-22
Timestamp: 2025-10-21T19:31:54.084Z
Learning: In bootstrap-vue-next, props like `cols` are "numberish" types that automatically convert number-shaped strings to numbers, so both `cols="12"` and `:cols="12"` are valid and type-safe.

Applied to files:

apps/docs/src/data/components/placeholder.data.ts

🔇 Additional comments (4)

apps/docs/src/data/components/placeholder.data.ts (2)

35-36: LGTM! Improved type specificity.

The type change from ColorVariant | null to BgColorVariant | null better reflects that placeholders primarily use background color variants, improving type safety and developer experience.

24-239: LGTM! Consistent formatting improvements.

The formatting cleanup across default values improves code consistency without affecting functionality.

apps/docs/src/docs/components/placeholder.md (2)

5-6: LGTM! Improved documentation clarity.

The rewording to "several component types" more accurately describes the breadth of placeholder functionality.

26-28: LGTM! Better information highlighting.

Converting the inline note to a formatted info block improves visibility and follows markdown documentation best practices.

apps/docs/src/docs/components/placeholder.md

apps/docs/src/docs/migration-guide.md

pkg-pr-new · 2025-10-23T00:45:15Z

bsvn-vite-ts

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

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

commit: 2b2c5e7

* upstream/main: (28 commits) fix(BToggle)! Remove redundant attribute cleanup & update docs for accessibility attributes on show/hide components (bootstrap-vue-next#2918) chore: release main (bootstrap-vue-next#2912) fix: allow custom component props in orchestrator create methods with type safety (bootstrap-vue-next#2922) fix(BModal): prevent focus trap error when no tabbable elements exist (bootstrap-vue-next#2864) Update package description for clarity (bootstrap-vue-next#2917) Update project description for clarity and detail test: add event emission tests for BTable and BTableLite (bootstrap-vue-next#2915) fix(BTableLite): Use primary key to persist row-details state when items change (bootstrap-vue-next#2871) chore: release main (bootstrap-vue-next#2896) feat(BTable): add configurable debouncing ci: Add publint to the build process (bootstrap-vue-next#2909) docs(Offcanvas): Parity pass (bootstrap-vue-next#2900) fix(directives): Robustness fixes for directives (bootstrap-vue-next#2906) docs(BFormInput): document @wheel.prevent for disabling mousewheel events (bootstrap-vue-next#2903) fix(typings): Fix paths to `*.d.mts` files (bootstrap-vue-next#2907) feat: add name and form props to BFormRating for form submission (bootstrap-vue-next#2895) docs: refactor docs to avoid duplication and boilerplate code (bootstrap-vue-next#2891) docs(BToast): Parity (bootstrap-vue-next#2887) docs(BModal): fix attribute to hide footer (bootstrap-vue-next#2888) docs(BPlaceholder): Parity pass (bootstrap-vue-next#2886) ...

docs(BPlaceholder): Parity pass

9be61a6

Copilot AI review requested due to automatic review settings October 23, 2025 00:42

Copilot AI reviewed Oct 23, 2025

View reviewed changes

apps/docs/src/docs/migration-guide.md Outdated Show resolved Hide resolved

apps/docs/src/docs/components/placeholder.md Outdated Show resolved Hide resolved

coderabbitai bot reviewed Oct 23, 2025

View reviewed changes

apps/docs/src/docs/components/placeholder.md Show resolved Hide resolved

apps/docs/src/docs/migration-guide.md Show resolved Hide resolved

docs(BPlaceholder): Changes based on code review

2b2c5e7

dwgray requested a review from VividLemon October 23, 2025 00:56

VividLemon approved these changes Oct 23, 2025

View reviewed changes

VividLemon merged commit 667ea2b into bootstrap-vue-next:main Oct 23, 2025
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs(BPlaceholder): Parity pass #2886

docs(BPlaceholder): Parity pass #2886

Uh oh!

dwgray commented Oct 23, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

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

Uh oh!

coderabbitai bot commented Oct 23, 2025 •

edited

Loading

Other AI code review bot(s) detected

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

pkg-pr-new bot commented Oct 23, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

docs(BPlaceholder): Parity pass #2886

docs(BPlaceholder): Parity pass #2886

Uh oh!

Conversation

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

Uh oh!

Describe the PR

Small replication

PR checklist

Summary by CodeRabbit

Uh oh!

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

Uh oh!

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

Uh oh!

Other AI code review bot(s) detected

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

pkg-pr-new bot commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

dwgray commented Oct 23, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 23, 2025 •

edited

Loading

pkg-pr-new bot commented Oct 23, 2025 •

edited

Loading