Skip to content
This repository was archived by the owner on Mar 27, 2025. It is now read-only.

Commit 447bcec

Browse files
authored
Merge pull request bootstrap-vue-next#1230 from VividLemon/main
docs: PascalCase
2 parents 1fe6ec3 + 01e6efa commit 447bcec

File tree

12 files changed

+27
-37
lines changed

12 files changed

+27
-37
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a href="https://www.npmjs.com/package/bootstrap-vue-next">
1515
<img src="https://flat.badgen.net/npm/v/bootstrap-vue-next" alt="Current version">
1616
</a>
17-
<a href="https://getbootstrap.com/docs/5.0/getting-started/introduction/">
17+
<a href="https://getbootstrap.com/docs/5.3/getting-started/introduction/">
1818
<img src="https://flat.badgen.net/badge/bootstrap/5.3.x/563d7c" alt="Bootstrap version">
1919
</a>
2020
<a href="https://v3.vuejs.org/">

apps/docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The documentation requires a specific style guide for consistency purposes. You
99
5. Code examples should always contain a `<template>` if they require a `<script>` tag.
1010
6. `<script>` tags should always be `<script setup lang="ts">` in that exact format
1111
7. Rendered Vue code must be directly _before_ the code example from above. This code example must always be wrapped in a `<BCard>`
12-
8. Use kebab-case for components. In Vue code or example code
12+
8. Use PascalCase for components. In Vue code or example code
1313
9. Headers should be APA Title Case <https://capitalizemytitle.com/style/APA/>
1414
10. Props should always be kebab case, ex modelValue => model-value
1515
11. Unordered lists should always use `-`, not any alternative (ie never `*`, `+`)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export default {
2020
prop: 'id',
2121
type: 'string',
2222
description:
23-
'The Id to be injected to accordian items and used to in b-collaspe for state managment',
23+
'The Id to be injected to accordian items and used to in BCollapse for state managment',
2424
},
2525
],
2626
emits: [],

apps/docs/src/docs/components/accordion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The `<BAccordionItem>` uses the `<BCollapse>` component internally to make it co
2020

2121
<BAlert variant="info" :model-value="true" class="my-5">
2222

23-
The animation effect of this component is dependent on the prefers-reduced-motion media query. See the [reduced motion section of our accessibility documentation](https://getbootstrap.com/docs/5.0/getting-started/accessibility/#reduced-motion).
23+
The animation effect of this component is dependent on the prefers-reduced-motion media query. See the [reduced motion section of our accessibility documentation](https://getbootstrap.com/docs/5.3/getting-started/accessibility/#reduced-motion).
2424

2525
</BAlert>
2626

apps/docs/src/docs/components/button.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ Create responsive stacks of full-width, “block buttons” like those in Bootst
200200
</template>
201201
</HighlightCard>
202202

203-
**Note:** Bootstrap 5 no long supports the `.btn-block` class, so it's removed. Use bootstrap 5's utility classes to get the same effect. [See](https://getbootstrap.com/docs/5.0/components/buttons/#block-buttons).
203+
**Note:** Bootstrap 5 no long supports the `.btn-block` class, so it's removed. Use bootstrap 5's utility classes to get the same effect. [See](https://getbootstrap.com/docs/5.3/components/buttons/#block-buttons).
204204

205205
## Pill style
206206

@@ -331,12 +331,7 @@ To create a button that can be toggled between active and non-active states, use
331331
</p>
332332
<h5>In a button group</h5>
333333
<BButtonGroup size="sm">
334-
<BButton
335-
v-for="(btn, idx) in buttons"
336-
:key="idx"
337-
v-model:pressed="btn.state"
338-
variant="primary"
339-
>
334+
<BButton v-for="(btn, idx) in buttons" :key="idx" v-model:pressed="btn.state" variant="primary">
340335
{{ btn.caption }}
341336
</BButton>
342337
</BButtonGroup>

apps/docs/src/docs/components/card.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ By default, the `<BCard>` content is automatically placed in a `<BCardBody>` sec
7676
<HighlightCard>
7777
<BCard class="text-center">
7878
<div class="bg-secondary text-light">
79-
This is some content within the default <samp>&lt;b-card-body&gt;</samp> block of the
80-
<samp>&lt;b-card&gt;</samp> component. Notice the padding between the card's border and this
79+
This is some content within the default <samp>&lt;BCardBody&gt;</samp> block of the
80+
<samp>&lt;BCard&gt;</samp> component. Notice the padding between the card's border and this
8181
gray <samp>&lt;div&gt;</samp>.
8282
</div>
8383
</BCard>
@@ -86,8 +86,8 @@ By default, the `<BCard>` content is automatically placed in a `<BCardBody>` sec
8686
```vue-html
8787
<BCard class="text-center">
8888
<div class="bg-secondary text-light">
89-
This is some content within the default <samp>&lt;b-card-body&gt;</samp> block of the
90-
<samp>&lt;b-card&gt;</samp> component. Notice the padding between the card's border and this
89+
This is some content within the default <samp>&lt;BCardBody&gt;</samp> block of the
90+
<samp>&lt;BCard&gt;</samp> component. Notice the padding between the card's border and this
9191
gray <samp>&lt;div&gt;</samp>.
9292
</div>
9393
</BCard>
@@ -102,7 +102,7 @@ on the `<BCard>`.
102102
<HighlightCard>
103103
<BCard no-body class="text-center">
104104
<div class="bg-secondary text-light">
105-
This is some content without the default <samp>&lt;b-card-body&gt;</samp> section. Notice the
105+
This is some content without the default <samp>&lt;BCardBody&gt;</samp> section. Notice the
106106
lack of padding between the card's border and this gray <samp>&lt;div&gt;</samp>.
107107
</div>
108108
</BCard>
@@ -111,7 +111,7 @@ on the `<BCard>`.
111111
```vue-html
112112
<BCard no-body class="text-center">
113113
<div class="bg-secondary text-light">
114-
This is some content without the default <samp>&lt;b-card-body&gt;</samp> section. Notice the
114+
This is some content without the default <samp>&lt;BCardBody&gt;</samp> section. Notice the
115115
lack of padding between the card's border and this gray <samp>&lt;div&gt;</samp>.
116116
</div>
117117
</BCard>
@@ -284,7 +284,7 @@ Place the image in the background of the card by setting the boolean prop `overl
284284

285285
#### Lazy loaded images
286286

287-
`<BCardImgLazy>` has been removed in favor of using a standalone prop on b-img. Use prop `lazy` on b-img and it will automatically use the browsers built in lazy-loading features that are supported natively on all major browsers.
287+
`<BCardImgLazy>` has been removed in favor of using a standalone prop on BImg. Use prop `lazy` on BImg and it will automatically use the browsers built in lazy-loading features that are supported natively on all major browsers.
288288

289289
### Header and footer
290290

apps/docs/src/docs/components/form-group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ the invalid feedback to show when using one of the above-mentioned form controls
381381

382382
## Floating labels
383383

384-
BFormGroup supports the new and fancy [Floating labels](https://getbootstrap.com/docs/5.0/forms/floating-labels/) feature of Bootstrap 5.
384+
BFormGroup supports the new and fancy [Floating labels](https://getbootstrap.com/docs/5.3/forms/floating-labels/) feature of Bootstrap 5.
385385

386386
You can make a floating label by setting the property `floating` to true and specify a placeholder on the `<BFormInput>`.
387387

apps/docs/src/docs/components/form.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -93,12 +93,7 @@ supported components, form layout, and more.
9393
</BFormGroup>
9494
9595
<BFormGroup id="input-group-2" label="Your Name:" label-for="input-2">
96-
<BFormInput
97-
id="input-2"
98-
v-model="form.name"
99-
placeholder="Enter name"
100-
required
101-
></BFormInput>
96+
<BFormInput id="input-2" v-model="form.name" placeholder="Enter name" required></BFormInput>
10297
</BFormGroup>
10398
<BFormGroup id="input-group-3" label="Food:" label-for="input-3">
10499
<BFormSelect id="input-3" v-model="form.food" :options="foods" required></BFormSelect>
@@ -156,7 +151,7 @@ const onReset = (event) => {
156151

157152
## Inline form
158153

159-
Bootstrap 5 has dropped form-specific layout classes for the grid system. See [this](https://getbootstrap.com/docs/5.0/migration/#forms).
154+
Bootstrap 5 has dropped form-specific layout classes for the grid system. See [this](https://getbootstrap.com/docs/5.3/migration/#forms).
160155

161156
To create horizontal forms with the grid by add the `.row` class to form groups and use the `.col-_-_` classes to specify the width of your labels and controls. Be sure to add `.col-form-label` to your `<label>`s as well, so they’re vertically centered with their associated form controls.
162157

@@ -439,7 +434,7 @@ of three contextual states:
439434
- `null` Displays no validation state (neither valid nor invalid)
440435

441436
Refer to the
442-
[Bootstrap v5 Form Validation Documentation](https://getbootstrap.com/docs/5.0/forms/validation/)
437+
[Bootstrap v5 Form Validation Documentation](https://getbootstrap.com/docs/5.3/forms/validation/)
443438
for details on the Bootstrap v5 validation states.
444439

445440
<ComponentReference :data="data" />

apps/docs/src/docs/components/link.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ By defaut links with no options will default to # location.
2929
External Links can be specified with the `href` prop.
3030

3131
<HighlightCard>
32-
<BLink href="https://getbootstrap.com/docs/5.0">
32+
<BLink href="https://getbootstrap.com/docs/5.3">
3333
External Link to Bootstrap
3434
</BLink>
3535
<BLink to="sample">
@@ -41,7 +41,7 @@ External Links can be specified with the `href` prop.
4141
<template #html>
4242

4343
```vue-html
44-
<BLink href="https://getbootstrap.com/docs/5.0">
44+
<BLink href="https://getbootstrap.com/docs/5.3">
4545
External Link to Bootstrap
4646
</BLink>
4747
@@ -62,20 +62,20 @@ External Links can be specified with the `href` prop.
6262
External Links can be specified with the `href` prop.
6363

6464
<HighlightCard>
65-
<BLink class="btn btn-primary me-2" href="https://getbootstrap.com/docs/5.0">
65+
<BLink class="btn btn-primary me-2" href="https://getbootstrap.com/docs/5.3">
6666
External Link to Bootstrap
6767
</BLink>
68-
<BLink class="btn btn-primary disabled" href="https://getbootstrap.com/docs/5.0">
68+
<BLink class="btn btn-primary disabled" href="https://getbootstrap.com/docs/5.3">
6969
Disabled Link
7070
</BLink>
7171
<template #html>
7272

7373
```vue-html
74-
<BLink class="btn btn-primary m-2" href="https://getbootstrap.com/docs/5.0">
74+
<BLink class="btn btn-primary m-2" href="https://getbootstrap.com/docs/5.3">
7575
External Link to Bootstrap
7676
</BLink>
7777
78-
<BLink class="btn btn-primary disabled m-2" href="https://getbootstrap.com/docs/5.0">
78+
<BLink class="btn btn-primary disabled m-2" href="https://getbootstrap.com/docs/5.3">
7979
Disabled Link
8080
</BLink>
8181
```

apps/docs/src/docs/components/spinner.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Spinners in Bootstrap are built with `rem`s, currentColor, and `display: inline-
110110

111111
### Margin
112112

113-
Use [margin utilities](https://getbootstrap.com/docs/5.0/utilities/spacing/) like `.m-5` for easy spacing.
113+
Use [margin utilities](https://getbootstrap.com/docs/5.3/utilities/spacing/) like `.m-5` for easy spacing.
114114

115115
<HighlightCard>
116116
<BSpinner class="m-5"></BSpinner>
@@ -125,7 +125,7 @@ Use [margin utilities](https://getbootstrap.com/docs/5.0/utilities/spacing/) lik
125125

126126
### Placement
127127

128-
Use [flexbox utilities](https://getbootstrap.com/docs/5.0/utilities/flex/), [float utilities](https://getbootstrap.com/docs/5.0/utilities/float/), or [text alignment](https://getbootstrap.com/docs/5.0/utilities/text/) utilities to place spinners exactly where you need them in any situation.
128+
Use [flexbox utilities](https://getbootstrap.com/docs/5.3/utilities/flex/), [float utilities](https://getbootstrap.com/docs/5.3/utilities/float/), or [text alignment](https://getbootstrap.com/docs/5.3/utilities/text/) utilities to place spinners exactly where you need them in any situation.
129129

130130
#### Flex
131131

apps/docs/src/docs/composables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ const routeLocation = (name: string): string => withBase(`/docs/composables/${na
1818
const composablesList: {name: string; description: string}[] = [
1919
{
2020
name: 'useBreadcrumb',
21-
description: 'A global breadcrumb system to pair with the b-breadcrumb component'
21+
description: 'A global breadcrumb system to pair with the BBreadcrumb component'
2222
},
2323
{
2424
name: 'useColorMode',

apps/docs/src/docs/composables/useBreadcrumb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
<div class="lead mb-5">
1212

13-
'useBreadcrumb' is a helper utility for the 'b-breadcrumb' component. It provides a **globally** changable context so you can modify a breadcrumb. It should be noted that the breacrumb component will automatically use the global context by default. 'useBreadcrumb' is shared globally, one modification to the state will be recognized throughout the app. As noted in the BBreadcrumb documentation, the items prop for the component takes precedence over 'useBreadcrumb'.
13+
'useBreadcrumb' is a helper utility for the 'BBreadcrumb' component. It provides a **globally** changable context so you can modify a breadcrumb. It should be noted that the breacrumb component will automatically use the global context by default. 'useBreadcrumb' is shared globally, one modification to the state will be recognized throughout the app. As noted in the BBreadcrumb documentation, the items prop for the component takes precedence over 'useBreadcrumb'.
1414

1515
</div>
1616

0 commit comments

Comments
 (0)