docs: Fix empty-text and empty-filtered-text description as they require show-empty to be set #2755

bperel · 2025-06-20T09:48:51Z

Fixes #2754

Summary by CodeRabbit

Documentation
- Clarified instructions on customizing empty and empty-filtered table states, detailing the use of specific props and slots.
- Improved section title and corrected a minor typo in the migration note.

…ire show-empty to be set

bolt-new-by-stackblitz · 2025-06-20T09:48:53Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-06-20T09:48:57Z

Walkthrough

The documentation for the table component's empty state rendering was updated for clarity. The section title was changed, and the explanation now explicitly states that the show-empty prop is required for both the empty-text prop and the named slots to display when the table is empty. Minor typo corrections were also made.

Changes

File(s)	Change Summary
apps/docs/src/docs/components/table.md	Clarified documentation on empty state rendering, updated section title, and fixed a typo.

Assessment against linked issues

Objective	Addressed	Explanation
Clarify in documentation that `show-empty` is required for `empty-text` prop to display (#2754)	✅

Poem

In the docs, a tale anew,
Of empty tables, clear and true.
"Show-empty" leads the way, you see,
For props and slots in harmony.
Now confusion hops away,
As rabbits cheer this doc display! 🐇✨

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.

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

apps/docs/src/docs/components/table.md (1)
499-501: Add blank lines around list items for Markdown lint compliance.

Lists should be surrounded by blank lines to satisfy MD032 and improve readability:
The content to show when the table is empty can be specified by setting the `show-empty` prop and then specifying:

- Either the `empty-text` prop or the `empty` named slot, for the case where unfiltered items are an empty or falsy array
- Either the `empty-filtered-text` prop or the `empty-filtered` named slot, for the case where filtered items are an empty or falsy array

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ced17a2 and 317ce03.

📒 Files selected for processing (1)

apps/docs/src/docs/components/table.md (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

apps/docs/src/docs/components/table.md

500-500: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)

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

GitHub Check: test-unit
GitHub Check: build

🔇 Additional comments (1)

apps/docs/src/docs/components/table.md (1)

497-497: Section title updated for clarity.

The new heading succinctly describes both empty and empty-filtered rendering without implying slot-only usage.

apps/docs/src/docs/components/table.md

pkg-pr-new · 2025-06-20T09:51:32Z

bsvn-vite-ts

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

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

commit: 317ce03

dwgray

Looks great, thanks!

* upstream/main: docs: clean up css selector docs: fix on-this-page when examples use header tags docs(migration): add component aliases guidelines (bootstrap-vue-next#2771) chore: upgrade dependencies and address all lint warnings (bootstrap-vue-next#2785) chore: release main (bootstrap-vue-next#2769) fix(BDropdown): prevent hydration warning in nuxt production mode (bootstrap-vue-next#2768) docs(BTabs): Updates based on v-model changes (bootstrap-vue-next#2760) docs(table): fix missing anchor in `BTableLite` and `BTableSimple` links (bootstrap-vue-next#2759) docs(BFormRating): Parity pass (bootstrap-vue-next#2749) docs: fix typo in breadcrumb documentation (bootstrap-vue-next#2756) docs: Fix empty-text and empty-filtered-text description as they require show-empty to be set (bootstrap-vue-next#2755) fix InputGroupXPend.vue chore: release main (bootstrap-vue-next#2748) feat: implement BFormRating component (bootstrap-vue-next#2744) chore: release main fix(BLink): move active class to BNavItem (bootstrap-vue-next#2747) feat(BDropdown): allow setting icon prop on nested BButton (bootstrap-vue-next#2746) fix(BToast): close BToast correctly if modelValue is changed from number to false (bootstrap-vue-next#2745)

…keover * upstream/main: (21 commits) feat(b-form-rating): add `icon-clear` slot (#2809) docs: fix dead links, enable rule (#2808) chore: release main (#2801) docs: Fix navbar collapse behavior (#2802) docs: fix code tabs on getting started and icons pages (#2805) docs: fix missing data and use a stronger schema to catch missing errors (#2806) feat(BPopover): add explicit props for focus and hover triggers (#2795) fix(BNavbar): changed autoClose to noAutoClose and fix the documention mistake about it. fix: ssr in scrollspy docs: clean up css selector docs: fix on-this-page when examples use header tags docs(migration): add component aliases guidelines (#2771) chore: upgrade dependencies and address all lint warnings (#2785) chore: release main (#2769) fix(BDropdown): prevent hydration warning in nuxt production mode (#2768) docs(BTabs): Updates based on v-model changes (#2760) docs(table): fix missing anchor in `BTableLite` and `BTableSimple` links (#2759) docs(BFormRating): Parity pass (#2749) docs: fix typo in breadcrumb documentation (#2756) docs: Fix empty-text and empty-filtered-text description as they require show-empty to be set (#2755) ...

docs: Fix empty-text and empty-filtered-text description as they requ…

317ce03

…ire show-empty to be set

coderabbitai bot reviewed Jun 20, 2025

View reviewed changes

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

dwgray approved these changes Jun 20, 2025

View reviewed changes

dwgray merged commit 54ea9b8 into bootstrap-vue-next:main Jun 20, 2025
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: Fix empty-text and empty-filtered-text description as they require show-empty to be set #2755

docs: Fix empty-text and empty-filtered-text description as they require show-empty to be set #2755

Uh oh!

bperel commented Jun 20, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

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

Uh oh!

coderabbitai bot commented Jun 20, 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!

coderabbitai bot left a comment

Uh oh!

Uh oh!

pkg-pr-new bot commented Jun 20, 2025

Uh oh!

dwgray left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

docs: Fix empty-text and empty-filtered-text description as they require show-empty to be set #2755

docs: Fix empty-text and empty-filtered-text description as they require show-empty to be set #2755

Uh oh!

Conversation

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

Uh oh!

Summary by CodeRabbit

Uh oh!

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

Uh oh!

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

Uh oh!

Walkthrough

Changes

Assessment against linked issues

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pkg-pr-new bot commented Jun 20, 2025

Uh oh!

dwgray left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

bperel commented Jun 20, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 20, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)