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

Commit dcc6265

Browse files
authored
Merge pull request bootstrap-vue-next#1326 from VividLemon/main
docs fixes
2 parents 2aec3e2 + 912baad commit dcc6265

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+984
-887
lines changed

apps/docs/.vitepress/theme/Layout.vue

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
<div class="border border-secondary ms-2 me-3" />
5454
<ClientOnly>
5555
<BNavItemDropdown toggle-class="px-0">
56-
<!-- TODO there's no way to adjust these options, say if you wanted to remove the padding -->
56+
<!-- TODO there is no way to adjust these options, say if you wanted to remove the padding -->
5757
<template #button-content>
5858
<component :is="currentIcon" height="1.1rem" :aria-label="`Toggle theme (${dark})`" />
5959
</template>
@@ -441,7 +441,9 @@ watch(
441441
// Navbar.
442442
> .navbar {
443443
color: var(--white);
444-
box-shadow: 0 0.5rem 1rem rgba(0, 0, 0, 0.15), inset 0 -1px 0 rgba(255, 255, 255, 0.15);
444+
box-shadow:
445+
0 0.5rem 1rem rgba(0, 0, 0, 0.15),
446+
inset 0 -1px 0 rgba(255, 255, 255, 0.15);
445447
446448
.nav-link,
447449
.navbar-brand,
@@ -532,7 +534,9 @@ watch(
532534
533535
// Sidebar.
534536
.offcanvas {
535-
box-shadow: 0 0.5rem 1rem rgba(0, 0, 0, 0.15), inset 0 -1px 0 rgba(255, 255, 255, 0.15);
537+
box-shadow:
538+
0 0.5rem 1rem rgba(0, 0, 0, 0.15),
539+
inset 0 -1px 0 rgba(255, 255, 255, 0.15);
536540
.list-group {
537541
padding: 0 0 1.5rem 0;
538542
font-size: 0.875em;

apps/docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ The documentation requires a specific style guide for consistency purposes. You
66
2. Lines should never contain ending periods
77
3. All components should have a description directly after the first top-level h1. You should always use `>` for these top level descriptions
88
4. Code _examples_ -- ie those that use code highlighting, should never contain a wrapper div, card, or other element. The _only_ exception is #5
9-
5. Code examples should always contain a `<template>` if they require a `<script>` tag.
10-
6. `<script>` tags should always be `<script setup lang="ts">` in that exact format
11-
7. Rendered Vue code must be directly _before_ the code example from above. This code example must always be wrapped in a `<BCard>`
9+
5. Code examples should always contain a `template` if they require a `script` tag.
10+
6. `script` tags should always be `<script setup lang="ts">` in that exact format
11+
7. Rendered Vue code must be directly _before_ the code example from above. This code example must always be wrapped in a `BCard`
1212
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 `*`, `+`)
16-
12. There should not be excess lines in markdown files. Either in `<script>` tags, or between elements in examples. This may affect readability, but assuming you've followed the Vue eslint rulings (read below), then it should be fine
16+
12. There should not be excess lines in markdown files. Either in `script` tags, or between elements in examples. This may affect readability, but assuming you have followed the Vue eslint rulings (read below), then it should be fine
1717

1818
It is recommended to put Vue code that is md into a real Vue file first, let it auto lint so we keep regular styling of Vue examples

apps/docs/package.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,25 @@
1212
},
1313
"devDependencies": {
1414
"@iconify-json/bi": "^1.1.17",
15-
"@iconify-json/simple-icons": "^1.1.60",
15+
"@iconify-json/simple-icons": "^1.1.62",
1616
"@rushstack/eslint-patch": "^1.3.2",
17-
"@tsconfig/node20": "^1.0.2",
18-
"@types/node": "^20.4.2",
19-
"@vue/eslint-config-prettier": "^7.1.0",
17+
"@tsconfig/node20": "^20.1.0",
18+
"@types/node": "^20.4.5",
19+
"@vue/eslint-config-prettier": "^8.0.0",
2020
"@vue/eslint-config-typescript": "^11.0.3",
2121
"@vue/tsconfig": "^0.4.0",
2222
"@vueuse/core": "^10.2.1",
23-
"bootstrap": "^5.3.0",
23+
"bootstrap": "^5.3.1",
2424
"bootstrap-vue-next": "workspace:^",
2525
"cross-env": "^7.0.3",
2626
"eslint": "^8.45.0",
2727
"eslint-define-config": "^1.21.0",
2828
"eslint-plugin-vue": "^9.15.1",
29-
"prettier": "^2.8.8",
29+
"prettier": "^3.0.0",
3030
"sitemap": "^7.1.1",
3131
"typescript": "^5.1.6",
3232
"unplugin-icons": "^0.16.5",
33-
"vitepress": "1.0.0-beta.5",
33+
"vitepress": "1.0.0-beta.6",
3434
"vue": "^3.3.4"
3535
},
3636
"lint-staged": {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ export default {
8383
{
8484
name: 'default',
8585
description:
86-
'If Vue-Router has be employed and the `routerComponentName` is `<RouterLink>` this slot scope is used',
86+
'If Vue-Router has be employed and the `routerComponentName` is `RouterLink` this slot scope is used',
8787
scope: [
8888
{
8989
prop: 'href',

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@
1010

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

13-
Build vertically collapsing accordions in combination with `<BCollapse>` component.
13+
Build vertically collapsing accordions in combination with `BCollapse` component.
1414

1515
</div>
1616

1717
## How it works
1818

19-
The `<BAccordionItem>` uses the `<BCollapse>` component internally to make it collapsible. To render an accordion that’s expanded, add the `visible` property on the `<BAccordionItem>` component.
19+
The `BAccordionItem` uses the `BCollapse` component internally to make it collapsible. To render an accordion that’s expanded, add the `visible` property on the `BAccordionItem` component.
2020

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

@@ -31,13 +31,13 @@ Click the accordions below to expand/collapse the accordion content.
3131
<HighlightCard>
3232
<BAccordion>
3333
<BAccordionItem title="Accordion Item #1" visible>
34-
<strong>This is the first item's accordion body.</strong> It is shown by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the <code>.accordion-body</code>, though the transition does limit overflow.
34+
<strong>This is the first item's accordion body.</strong> It is shown by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It is also worth noting that just about any HTML can go within the <code>.accordion-body</code>, though the transition does limit overflow.
3535
</BAccordionItem>
3636
<BAccordionItem title="Accordion Item #2">
37-
<strong>This is the second item's accordion body.</strong> It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the <code>.accordion-body</code>, though the transition does limit overflow.
37+
<strong>This is the second item's accordion body.</strong> It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It is also worth noting that just about any HTML can go within the <code>.accordion-body</code>, though the transition does limit overflow.
3838
</BAccordionItem>
3939
<BAccordionItem title="Accordion Item #3">
40-
<strong>This is the third item's accordion body.</strong> It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the <code>.accordion-body</code>, though the transition does limit overflow.
40+
<strong>This is the third item's accordion body.</strong> It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It is also worth noting that just about any HTML can go within the <code>.accordion-body</code>, though the transition does limit overflow.
4141
</BAccordionItem>
4242
</BAccordion>
4343
<template #html>
@@ -48,23 +48,23 @@ Click the accordions below to expand/collapse the accordion content.
4848
<strong>This is the first item's accordion body.</strong> It is shown by default, until the
4949
collapse plugin adds the appropriate classes that we use to style each element. These classes
5050
control the overall appearance, as well as the showing and hiding via CSS transitions. You can
51-
modify any of this with custom CSS or overriding our default variables. It's also worth noting
51+
modify any of this with custom CSS or overriding our default variables. It is also worth noting
5252
that just about any HTML can go within the <code>.accordion-body</code>, though the transition
5353
does limit overflow.
5454
</BAccordionItem>
5555
<BAccordionItem title="Accordion Item #2">
5656
<strong>This is the second item's accordion body.</strong> It is hidden by default, until the
5757
collapse plugin adds the appropriate classes that we use to style each element. These classes
5858
control the overall appearance, as well as the showing and hiding via CSS transitions. You can
59-
modify any of this with custom CSS or overriding our default variables. It's also worth noting
59+
modify any of this with custom CSS or overriding our default variables. It is also worth noting
6060
that just about any HTML can go within the <code>.accordion-body</code>, though the transition
6161
does limit overflow.
6262
</BAccordionItem>
6363
<BAccordionItem title="Accordion Item #3">
6464
<strong>This is the third item's accordion body.</strong> It is hidden by default, until the
6565
collapse plugin adds the appropriate classes that we use to style each element. These classes
6666
control the overall appearance, as well as the showing and hiding via CSS transitions. You can
67-
modify any of this with custom CSS or overriding our default variables. It's also worth noting
67+
modify any of this with custom CSS or overriding our default variables. It is also worth noting
6868
that just about any HTML can go within the <code>.accordion-body</code>, though the transition
6969
does limit overflow.
7070
</BAccordionItem>
@@ -122,13 +122,13 @@ Add `free` property to make accordion items stay open when another item is opene
122122
<HighlightCard>
123123
<BAccordion free>
124124
<BAccordionItem title="Accordion Item #1">
125-
<strong>This is the first item's accordion body.</strong> It is shown by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the <code>default</code> slot, though the transition does limit overflow.
125+
<strong>This is the first item's accordion body.</strong> It is shown by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It is also worth noting that just about any HTML can go within the <code>default</code> slot, though the transition does limit overflow.
126126
</BAccordionItem>
127127
<BAccordionItem title="Accordion Item #2">
128-
<strong>This is the second item's accordion body.</strong> It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the <code>default</code> slot, though the transition does limit overflow.
128+
<strong>This is the second item's accordion body.</strong> It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It is also worth noting that just about any HTML can go within the <code>default</code> slot, though the transition does limit overflow.
129129
</BAccordionItem>
130130
<BAccordionItem title="Accordion Item #3">
131-
<strong>This is the third item's accordion body.</strong> It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the <code>default</code> slot, though the transition does limit overflow.
131+
<strong>This is the third item's accordion body.</strong> It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It is also worth noting that just about any HTML can go within the <code>default</code> slot, though the transition does limit overflow.
132132
</BAccordionItem>
133133
</BAccordion>
134134
<template #html>
@@ -139,23 +139,23 @@ Add `free` property to make accordion items stay open when another item is opene
139139
<strong>This is the first item's accordion body.</strong> It is shown by default, until the
140140
collapse plugin adds the appropriate classes that we use to style each element. These classes
141141
control the overall appearance, as well as the showing and hiding via CSS transitions. You can
142-
modify any of this with custom CSS or overriding our default variables. It's also worth noting
142+
modify any of this with custom CSS or overriding our default variables. It is also worth noting
143143
that just about any HTML can go within the <code>default</code> slot, though the transition does
144144
limit overflow.
145145
</BAccordionItem>
146146
<BAccordionItem title="Accordion Item #2">
147147
<strong>This is the second item's accordion body.</strong> It is hidden by default, until the
148148
collapse plugin adds the appropriate classes that we use to style each element. These classes
149149
control the overall appearance, as well as the showing and hiding via CSS transitions. You can
150-
modify any of this with custom CSS or overriding our default variables. It's also worth noting
150+
modify any of this with custom CSS or overriding our default variables. It is also worth noting
151151
that just about any HTML can go within the <code>default</code> slot, though the transition does
152152
limit overflow.
153153
</BAccordionItem>
154154
<BAccordionItem title="Accordion Item #3">
155155
<strong>This is the third item's accordion body.</strong> It is hidden by default, until the
156156
collapse plugin adds the appropriate classes that we use to style each element. These classes
157157
control the overall appearance, as well as the showing and hiding via CSS transitions. You can
158-
modify any of this with custom CSS or overriding our default variables. It's also worth noting
158+
modify any of this with custom CSS or overriding our default variables. It is also worth noting
159159
that just about any HTML can go within the <code>default</code> slot, though the transition does
160160
limit overflow.
161161
</BAccordionItem>

0 commit comments

Comments
 (0)