docs: Fixed typo in tabs.md #2821
Conversation
|
|
WalkthroughCorrected a typographical error in the docs: in Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
apps/docs/src/docs/components/tabs.md (1)
17-21: Typo fix looks good; consider tightening punctuation to avoid a comma splice.Nice catch on "doce" → "docs". Minor style nit: split the sentence or use a semicolon after "attribute" to avoid a comma splice.
Apply one of the following diffs:
-attribute, see the [Vue docs](https://vuejs.org/api/built-in-special-attributes.html#key) for details. +attribute; see the [Vue docs](https://vuejs.org/api/built-in-special-attributes.html#key) for details.or
-attribute, see the [Vue docs](https://vuejs.org/api/built-in-special-attributes.html#key) for details. +attribute. See the [Vue docs](https://vuejs.org/api/built-in-special-attributes.html#key) for details.
📜 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 (1)
apps/docs/src/docs/components/tabs.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: dwgray
PR: bootstrap-vue-next/bootstrap-vue-next#2669
File: apps/docs/src/data/components/table.data.ts:334-336
Timestamp: 2025-04-24T20:35:48.629Z
Learning: The generic type parameter for table items should use the singular form `Item` rather than the plural `Items` to improve readability and follow TypeScript conventions. This change would primarily affect two files: `packages/bootstrap-vue-next/src/types/ComponentProps.ts` and `apps/docs/src/data/components/table.data.ts`.
📚 Learning: 2025-05-28T07:01:55.095Z
Learnt from: xvaara
PR: bootstrap-vue-next/bootstrap-vue-next#2716
File: packages/bootstrap-vue-next/src/components/BTabs/BTabs.vue:240-261
Timestamp: 2025-05-28T07:01:55.095Z
Learning: In BTabs component (packages/bootstrap-vue-next/src/components/BTabs/BTabs.vue), the complex initialization logic with updateInitialActiveIndex and updateInitialActiveId flags is necessary for SSR compatibility. Tab initialization cannot be deferred to mounted lifecycle because tabs must be available for server-side rendering of the initial HTML state.
Applied to files:
apps/docs/src/docs/components/tabs.md
📚 Learning: 2025-05-28T07:57:19.915Z
Learnt from: xvaara
PR: bootstrap-vue-next/bootstrap-vue-next#2716
File: packages/bootstrap-vue-next/src/components/BTabs/BTabs.vue:384-404
Timestamp: 2025-05-28T07:57:19.915Z
Learning: In BTabs component (packages/bootstrap-vue-next/src/components/BTabs/BTabs.vue), the activeIndex and activeId watchers are intentionally designed with separation of concerns: activeIndex watcher handles activate-tab event emission and complex validation logic, while activeId watcher is kept simple for synchronization between activeId and activeIndex values only.
Applied to files:
apps/docs/src/docs/components/tabs.md
🪛 LanguageTool
apps/docs/src/docs/components/tabs.md
[grammar] ~20-~20: There might be a mistake here.
Context: ...pecial-attributes.html#key) for details. ::: ## Cards integration Tabs support ...
(QB_NEW_EN)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (12)
apps/docs/src/docs/components/tabs.md (12)
26-26: Missing space before inline code.There’s no space between “the” and the backticked prop name.
- it inside a `<BCard>` component. Note that you should add the`no-body` prop on the `<BCard>` + it inside a `<BCard>` component. Note that you should add the `no-body` prop on the `<BCard>`
34-34: Hyphenate “sub-component” for consistency.Elsewhere in this section “sub-component” is hyphenated.
- `card-body` class, set the `no-body` prop on the `<BTab>` sub component. + `card-body` class, set the `no-body` prop on the `<BTab>` sub-component.
39-40: Use “effect” (noun), not “affect”.Small grammar fix in the tip.
- Setting the `no-body` prop on `<BTab>` will have no affect when `<BTabs>` is not in + Setting the `no-body` prop on `<BTab>` will have no effect when `<BTabs>` is not in
95-95: Hyphenate “left-hand side”.- Have the tab controls placed on the lefthand side by setting the `vertical` prop to `true`. Vertical + Have the tab controls placed on the left-hand side by setting the `vertical` prop to `true`. Vertical
111-113: Bootstrap version reference may be inconsistent (v4 vs v5).This page elsewhere references “Bootstrap v5’s nav markup” (Line 160), but this sentence mentions “Bootstrap v4 CSS”. Confirm the intended version and align. If v5 is correct, also fix the small tense issue.
- Vertical placement visually works best with the `pills` variant. When using the default `tabs` - variant, you may want to provided your own custom styling classes, as Bootstrap v4 CSS assumes the - tab controls will always be placed on the top of the tabs content. + Vertical placement visually works best with the `pills` variant. When using the default `tabs` + variant, you may want to provide your own custom styling classes, as Bootstrap v5 CSS assumes the + tab controls will always be placed at the top of the tabs content.
129-129: Add missing auxiliary verb.- Fade is enabled by default when changing tabs. It can disabled with `no-fade` property. + Fade is enabled by default when changing tabs. It can be disabled with the `no-fade` property.
148-150: Small grammar polish.- If you want to add custom content to tab title, like HTML code, icons, or another non-interactive - Vue component, this possible by using `title` slot of `<BTab>`. + If you want to add custom content to a tab title—like HTML, icons, or another non-interactive + Vue component—this is possible by using the `title` slot of `<BTab>`.
160-165: Minor editorial fixes: “i.e.” spacing/punctuation, “class name”, and pluralization.- The tab selectors are based on Bootstrap v5's `nav` markup ( i.e. + The tab selectors are based on Bootstrap v5's `nav` markup (i.e., `ul.nav > li.nav-item > a.nav-link`). In some situations, you may want to add classes to the `<li>` - (nav-item) and/or the `<a>` (nav-link) on a per tab basis. To do so, simply supply the classname to + (nav-item) and/or the `<a>` (nav-link) on a per-tab basis. To do so, simply supply the class name to the `title-item-class` prop (for the `<li>` element) or `title-link-class` prop (for the `<a>` - element). Value's can be passed as a string or array of strings. + element). Values can be passed as a string or array of strings.
183-185: Use “unmount” (verb) and fix hyphenation.- By default, once the tab is activated, the content will remain mounted. To un-mounted the content - when the tab is deactivated (hidden) use the `unmount-lazy` prop. + By default, once the tab is activated, the content remains mounted. To unmount the content + when the tab is deactivated (hidden), use the `unmount-lazy` prop.
188-190: Remove possessive apostrophe in plural “tabs”.- One can also make all tab's lazy by setting the `lazy` prop on the parent `<BTabs>` component: + You can also make all tabs lazy by setting the `lazy` prop on the parent `<BTabs>` component:
225-229: Tighten wording and spacing around code ticks.Clarify the sentence and add spaces around backticked method names.
- Each `<BTab>`instance also exposes to activate or deactivate the tab. The - methods are`.activate()`and`.deactivate()`, respectively. If activation or deactivation fails + Each `<BTab>` instance also exposes methods to activate or deactivate the tab. The + methods are `.activate()` and `.deactivate()`, respectively. If activation or deactivation fails (i.e. a tab is disabled or no tab is available to move activation to), then the currently active tab will remain active and the method will return `false`. You will need a reference to the `<BTab>` in order to use these methods.
1-273: Optional: batch tidy-up PRThe above nits are editorial and not required for this typo-only PR. If you’d like, I can open a small follow-up PR that applies all of these doc cleanups in one commit to keep this change scoped.
📜 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 (1)
apps/docs/src/docs/components/tabs.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: dwgray
PR: bootstrap-vue-next/bootstrap-vue-next#2669
File: apps/docs/src/data/components/table.data.ts:334-336
Timestamp: 2025-04-24T20:35:48.629Z
Learning: The generic type parameter for table items should use the singular form `Item` rather than the plural `Items` to improve readability and follow TypeScript conventions. This change would primarily affect two files: `packages/bootstrap-vue-next/src/types/ComponentProps.ts` and `apps/docs/src/data/components/table.data.ts`.
📚 Learning: 2025-05-28T07:01:55.095Z
Learnt from: xvaara
PR: bootstrap-vue-next/bootstrap-vue-next#2716
File: packages/bootstrap-vue-next/src/components/BTabs/BTabs.vue:240-261
Timestamp: 2025-05-28T07:01:55.095Z
Learning: In BTabs component (packages/bootstrap-vue-next/src/components/BTabs/BTabs.vue), the complex initialization logic with updateInitialActiveIndex and updateInitialActiveId flags is necessary for SSR compatibility. Tab initialization cannot be deferred to mounted lifecycle because tabs must be available for server-side rendering of the initial HTML state.
Applied to files:
apps/docs/src/docs/components/tabs.md
📚 Learning: 2025-05-28T07:57:19.915Z
Learnt from: xvaara
PR: bootstrap-vue-next/bootstrap-vue-next#2716
File: packages/bootstrap-vue-next/src/components/BTabs/BTabs.vue:384-404
Timestamp: 2025-05-28T07:57:19.915Z
Learning: In BTabs component (packages/bootstrap-vue-next/src/components/BTabs/BTabs.vue), the activeIndex and activeId watchers are intentionally designed with separation of concerns: activeIndex watcher handles activate-tab event emission and complex validation logic, while activeId watcher is kept simple for synchronization between activeId and activeIndex values only.
Applied to files:
apps/docs/src/docs/components/tabs.md
🪛 LanguageTool
apps/docs/src/docs/components/tabs.md
[grammar] ~20-~20: There might be a mistake here.
Context: ...pecial-attributes.html#key) for details. ::: ## Cards integration Tabs support ...
(QB_NEW_EN)
🔇 Additional comments (2)
apps/docs/src/docs/components/tabs.md (2)
20-20: Typo fix looks good."Vue docs" is correct and matches the official anchor text. No functional impact.
167-169: Keep as-is; LanguageTool false positive.The admonition formatting and punctuation look correct here; the analyzer’s flag appears spurious.
commit: |
2 participants
Describe the PR
Fixed typo in tabs.md:
doce=>docsSmall 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