8000 feat(BTableLite): add `table-colgroup` slot by a-kriya · Pull Request #2680 · bootstrap-vue-next/bootstrap-vue-next · GitHub
[go: up one dir, main page]

Skip to content

feat(BTableLite): add table-colgroup slot #2680

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

Merged
merged 1 commit into from
May 26, 2025

Conversation

a-kriya
Copy link
Contributor
@a-kriya a-kriya commented May 2, 2025

Describe the PR

Add table-colgroup slot to BTableLite component for custom column width definitions.

Fixes #2520.

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:

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Added support for a new named slot, table-colgroup, in tables, allowing users to specify custom column widths.
    • Introduced a demo component showcasing how to use the new table-colgroup slot for column width customization.
  • Documentation

    • Updated documentation to describe the new table-colgroup slot and provide a usage example.
    • Revised the migration guide to remove outdated references to the slot's availability.

Copy link

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

Copy link
coderabbitai bot commented May 2, 2025

Walkthrough

This update introduces support for the table-colgroup slot in both the BTable and BTableLite components, enabling users to define custom column groups within tables. A new Vue demo component, TableColgroup.vue, demonstrates this functionality. Documentation and migration guides are updated to reflect the new slot support, removing references to the feature as unimplemented and providing usage examples.

Changes

File(s) Change Summary
packages/bootstrap-vue-next/src/components/BTable/BTable.vue,
.../BTableLite.vue
Added support and slot declarations for the table-colgroup slot, allowing custom <colgroup> rendering.
apps/docs/src/docs/components/demo/TableColgroup.vue Added a new demo component showcasing usage of the table-colgroup slot with explicit column widths.
apps/docs/src/docs/components/table.md Updated documentation to describe the table-colgroup slot and added a demo reference.
apps/docs/src/docs/migration-guide.md Updated migration guide to remove mention of the slot as unimplemented and cleaned up formatting.
apps/docs/src/data/components/table.data.ts Added the table-colgroup slot declaration to the tableLiteSlots array with description and scoped props.
apps/docs/src/components/NotYetDocumented.vue Wrapped template content inside a single <p> element for cleaner structure without changing logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BTable
    participant BTableLite

    User->>BTable: Provide table-colgroup slot
    BTable->>BTableLite: Pass table-colgroup slot
    BTableLite->>BTableLite: Render <colgroup> with slot content (if provided)
    BTableLite->>User: Display table with custom column groups
Loading

Assessment against linked issues

Objective Addressed Explanation
Implement the missing table-colgroup slot feature (#2520)

Suggested reviewers

  • VividLemon

Poem

In columns wide and columns neat,
A table’s form is now complete!
With slots for groups—oh, what a treat,
Vue tables march on nimble feet.
Docs refreshed, the guides align,
Rabbits cheer: “It’s table time!”
🐇🍽️

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.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between e5e29c6 and 7949dc2.

📒 Files selected for processing (7)
  • apps/docs/src/components/NotYetDocumented.vue (1 hunks)
  • apps/docs/src/data/components/table.data.ts (1 hunks)
  • apps/docs/src/docs/components/demo/TableColgroup.vue (1 hunks)
  • apps/docs/src/docs/components/table.md (1 hunks)
  • apps/docs/src/docs/migration-guide.md (3 hunks)
  • packages/bootstrap-vue-next/src/components/BTable/BTable.vue (2 hunks)
  • packages/bootstrap-vue-next/src/components/BTable/BTableLite.vue (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (7)
  • apps/docs/src/components/NotYetDocumented.vue
  • packages/bootstrap-vue-next/src/components/BTable/BTable.vue
  • apps/docs/src/docs/components/demo/TableColgroup.vue
  • apps/docs/src/docs/components/table.md
  • apps/docs/src/docs/migration-guide.md
  • apps/docs/src/data/components/table.data.ts
  • packages/bootstrap-vue-next/src/components/BTable/BTableLite.vue
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
✨ 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 repos 8000 itory 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.

Copy link
pkg-pr-new bot commented May 2, 2025

bsvn-vite-ts

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

commit: 7949dc2

@@ -344,6 +347,8 @@ type SortSlotScope = {

const slots = defineSlots<{
// BTableLite
// eslint-disable-next-line @typescript-eslint/no-explicit-any
'table-colgroup'?: (props: {columns: number; fields: typeof computedFields.value}) => any
Copy link
Member

Choose a reason for hiding this comment

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

Remove the fields scope, add it to the migration guide as a breaking change

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

@a-kriya
Copy link
Contributor Author
a-kriya commented May 17, 2025

@xvaara Will you be able to help review this PR, please?

@VividLemon
Copy link
Member

I think I got it mixed up. We want whatever scope is the array of objects. The '.length's property is redundant. Then add in the migration guide that the scope was removed

@a-kriya
Copy link
Contributor Author
a-kriya commented May 17, 2025

Updated.

However, this slot is the odd one now. Most other slots in TableLite provide both fields and columns:

  • thead-top
  • custom-body
  • top-row
  • bottom-row
  • custom-foot

@VividLemon
Copy link
Member

Are they all just aliases of the .length property?

@a-kriya
Copy link
Contributor Author
a-kriya commented May 18, 2025

Yes

@VividLemon
Copy link
Member

Remove them all. Add it to the migration guide

@a-kriya
Copy link
Contributor Author
a-kriya commented May 18, 2025

I can put up a separate PR for that. I don't think those changes belong here.

@VividLemon VividLemon merged commit 16ebcce into bootstrap-vue-next:main May 26, 2025
5 checks passed
@github-actions github-actions bot mentioned this pull request May 26, 2025
@a-kriya a-kriya deleted the table-colgroup branch May 26, 2025 20:09
xvaara added a commit to xvaara/bootstrap-vue-next that referenced this pull request May 26, 2025
* 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
Labels
None yet
Projects
None yet
3D84 Development

Successfully merging this pull request may close these issues.

table-colgroup slot not implemented
2 participants
0