Skip to content

Commit 671ef4e

Browse files
jacobmllr95jacobmllr95
authored
chore(docs): align navigation with section titles (#6296)
* chore(docs): align navigation with section titles * Update package.json * Use titlecase * Use Titelcase
1 parent 26a0f52 commit 671ef4e

File tree

38 files changed

+121
-59
lines changed

38 files changed

+121
-59
lines changed

‎CHANGELOG-OLD.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3474,7 +3474,7 @@ Released: 2017-07-04
34743474
([60b1fd8](https://github.com/bootstrap-vue/bootstrap-vue/commit/60b1fd8))
34753475
- **docs:** add root wrapper to templates
34763476
([ff6432d](https://github.com/bootstrap-vue/bootstrap-vue/commit/ff6432d))
3477-
- **docs:** Fix ScrollSpy example
3477+
- **docs:** Fix Scrollspy example
34783478
([0365208](https://github.com/bootstrap-vue/bootstrap-vue/commit/0365208))
34793479
- **docs:** form-radio typo fix
34803480
([db6d5d7](https://github.com/bootstrap-vue/bootstrap-vue/commit/db6d5d7))

‎docs/assets/css/docs.min.css.map

Lines changed: 63 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/components/alert/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Alerts
1+
# Alert
22

33
> Provide contextual feedback messages for typical user actions with the handful of available and
44
> flexible alert messages.

‎src/components/badge/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Badges
1+
# Badge
22

33
> Small and adaptive tag for adding context to just about any content.
44

‎src/components/button-group/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Button group
1+
# Button Group
22

33
> Group a series of buttons together on a single line with `<b-button-group>`.
44
55
## Overview
66

7-
Button groups are an easy way to group a series of buttons together.
7+
Button Groups are an easy way to group a series of buttons together.
88

99
```html
1010
<div>

‎src/components/button-toolbar/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Button toolbar
1+
# Button Toolbar
22

33
> Group a series of button-groups and/or input-groups together on a single line, with optional
44
> keyboard navigation

‎src/components/button/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Buttons
1+
# Button
22

33
> Use Bootstrap's custom `b-button` component for actions in forms, dialogs, and more. Includes
44
> support for a handful of contextual variations, sizes, states, and more.

‎src/components/card/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Cards
1+
# Card
22

33
> A card is a flexible and extensible content container. It includes options for headers and
44
> footers, a wide variety of content, contextual background colors, and powerful display options.

‎src/components/dropdown/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Dropdowns
1+
# Dropdown
22

33
> Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a
44
> dropdown menu format.

‎src/components/embed/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Responsive Embeds
1+
# Embed
22

33
> Create responsive video or slideshow embeds based on the width of the parent by creating an
44
> intrinsic ratio that scales on any device.

‎src/components/form-checkbox/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Form Checkbox Inputs
1+
# Form Checkbox
22

33
> For cross browser consistency, `<b-form-checkbox-group>` and `<b-form-checkbox>` use Bootstrap's
44
> custom checkbox input to replace the browser default checkbox input. It is built on top of

‎src/components/form-file/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Form File Input
1+
# Form File
22

33
> Customized, cross-browser consistent, file input control that supports single file, multiple
44
> files, and directory upload (for browsers that support directory mode).

‎src/components/form-group/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Form group
1+
# Form Group
22

33
> The `<b-form-group>` component is the easiest way to add some structure to forms. Its purpose is
44
> to pair form controls with a legend or label, and to provide help text and invalid/valid feedback

‎src/components/form-input/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Textual and Value inputs
1+
# Form Input
22

33
> Create various type inputs such as: `text`, `password`, `number`, `url`, `email`, `search`,
44
> `range`, `date` and more.

‎src/components/form-radio/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Form Radio Inputs
1+
# Form Radio
22

33
> For cross browser consistency, `<b-form-radio-group>` and `<b-form-radio>` uses Bootstrap's custom
44
> radio input to replace the browser default radio input. It is built on top of semantic and

‎src/components/form-textarea/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Form textarea
1+
# Form Textarea
22

33
> Create multi-line text inputs with support for auto height sizing, minimum and maximum number of
44
> rows, and contextual states.

‎src/components/form/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,9 +198,9 @@ See also:
198198
- [`<b-form-timepicker>`](/docs/components/form-timepicker) Time picker custom form input
199199
- [`<b-form-rating>`](/docs/components/form-rating) Star rating custom form input and display
200200
- [`<b-button>`](/docs/components/button) Buttons
201-
- [`<b-form-group>`](/docs/components/form-group) Form input wrapper to generate form-groups that
201+
- [`<b-form-group>`](/docs/components/form-group) Form Input wrapper to generate form-groups that
202202
support labels, help text and feedback
203-
- [`<b-input-group>`](/docs/components/input-group) Form inputs with add-ons
203+
- [`<b-input-group>`](/docs/components/input-group) Form Inputs with add-ons
204204
- [`<b-form-row>`](/docs/components/layout) Create grid rows and columns with tighter margins
205205
(available via the [Layout and grid components](/docs/components/layout))
206206

‎src/components/image/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Images
1+
# Image
22

33
> Documentation and examples for opting images (via `<b-img>` component) into responsive behavior
44
> (so they never become larger than their parent elements), optionally adding lightweight styles to

‎src/components/input-group/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Input Groups
1+
# Input Group
22

33
> Easily extend form controls by adding text, buttons, or button groups on either side of textual
44
> inputs.

‎src/components/link/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Links
1+
# Link
22

33
> Use BootstrapVue's custom `b-link` component for generating a standard `<a>` link or
44
> `<router-link>`. `<b-link>` supports the `disabled` state and `click` event propagation.

‎src/components/list-group/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# List group
1+
# List Group
22

3-
> List groups are a flexible and powerful component for displaying a series of content. List group
3+
> List Groups are a flexible and powerful component for displaying a series of content. List Group
44
> items can be modified to support just about any content within. They can also be used as
55
> navigation via various props.
66
@@ -161,7 +161,7 @@ more with the help of some [flex utility classes](/docs/reference/utility-classe
161161
<!-- b-list-group-badges.vue -->
162162
```
163163

164-
## List groups inside cards
164+
## List Groups inside cards
165165

166166
Incorporate list groups into [cards](/docs/components/card). Use the `<b-list-group>` prop `flush`
167167
prop when using cards with `no-body` to make the sides of the list group flush with the card.
@@ -247,7 +247,7 @@ help of [flexbox utility classes](/docs/reference/utility-classes).
247247
<b-list-group>
248248
<b-list-group-item href="#" active class="flex-column align-items-start">
249249
<div class="d-flex w-100 justify-content-between">
250-
<h5 class="mb-1">List group item heading</h5>
250+
<h5 class="mb-1">List Group item heading</h5>
251251
<small>3 days ago</small>
252252
</div>
253253

@@ -260,7 +260,7 @@ help of [flexbox utility classes](/docs/reference/utility-classes).
260260

261261
<b-list-group-item href="#" class="flex-column align-items-start">
262262
<div class="d-flex w-100 justify-content-between">
263-
<h5 class="mb-1">List group item heading</h5>
263+
<h5 class="mb-1">List Group item heading</h5>
264264
<small class="text-muted">3 days ago</small>
265265
</div>
266266

@@ -273,7 +273,7 @@ help of [flexbox utility classes](/docs/reference/utility-classes).
273273

274274
<b-list-group-item href="#" disabled class="flex-column align-items-start">
275275
<div class="d-flex w-100 justify-content-between">
276-
<h5 class="mb-1">Disabled List group item</h5>
276+
<h5 class="mb-1">Disabled List Group item</h5>
277277
<small class="text-muted">3 days ago</small>
278278
</div>
279279

‎src/components/list-group/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
"name": "@bootstrap-vue/list-group",
33
"version": "1.0.0",
44
"meta": {
5-
"title": "List group",
6-
"description": "List groups are a flexible and powerful component for displaying a series of content. List group items can be modified to support just about any content within. They can also be used as navigation via various props.",
5+
"title": "List Group",
6+
"description": "List Groups are a flexible and powerful component for displaying a series of content. List Group items can be modified to support just about any content within. They can also be used as navigation via various props.",
77
"components": [
88
{
99
"component": "BListGroup",

‎src/components/modal/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Modals
1+
# Modal
22

33
> Modals are streamlined, but flexible dialog prompts powered by JavaScript and CSS. They support a
44
> number of use cases from user notification to completely custom content and feature a handful of

‎src/components/nav/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Navs
1+
# Nav
22

33
> Navigation available in Bootstrap share general markup and styles, from the base `<b-nav>` class
44
> to the `active` and `disabled` states. Swap modifier props to switch between each style.

‎src/components/navbar/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ Use `<b-nav-form>` to place inline form controls into your navbar
241241
<!-- b-navbar-form.vue -->
242242
```
243243

244-
Input groups work as well:
244+
Input Groups work as well:
245245

246246
```html
247247
<div>

‎src/components/pagination-nav/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Pagination Navigation
1+
# Pagination Nav
22

33
> Quick first, previous, next, last, and page buttons for navigation based pagination, supporting
44
> regular links or router links.

‎src/components/spinner/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Spinners
1+
# Spinner
22

33
> The `<b-spinner>` component can be used to show the loading state in your projects. They're
44
> rendered only with basic HTML and CSS as a lightweight Vue functional component. Their appearance,

‎src/components/table/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Tables
1+
# Table
22

33
> For displaying tabular data, `<b-table>` supports pagination, filtering, sorting, custom
44
> rendering, various style options, events, and asynchronous data. For simple display of tabular

‎src/components/toast/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Toasts
1+
# Toast
22

33
> Push notifications to your visitors with a `<b-toast>` and `<b-toaster>`, lightweight components
44
> which are easily customizable for generating alert messages.

‎src/components/toast/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@bootstrap-vue/toast",
33
"version": "1.0.0",
44
"meta": {
5-
"title": "Toasts",
5+
"title": "Toast",
66
"slug": "toast",
77
"description": "Push notifications to your visitors with a toast, a lightweight and easily customizable alert message.",
88
"plugins": [

‎src/components/tooltip/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Tooltips
1+
# Tooltip
22

33
> Easily add tooltips to elements or components via the `<b-tooltip>` component or
44
> [`v-b-tooltip`](/docs/directives/tooltip) directive (preferred method).

‎src/directives/popover/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Popovers
1+
# Popover
22

33
> Documentation and examples for adding BootstrapVue popovers to any element on your site, using
44
> Bootstrap v4 CSS for styling and animations. Popovers can be triggered by hovering, focusing, or

‎src/directives/scrollspy/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ScrollSpy
1+
# Scrollspy
22

33
> Automatically update Bootstrap navigation or list group components based on scroll position to
44
> indicate which link is currently active in the viewport.
@@ -299,7 +299,7 @@ If any of the options are invalid types, then an error is written to the console
299299

300300
- If scroll element is not present, then we assume scrolling on `<body>`
301301
- If scroll element is a CSS selector, the first found element is chosen
302-
- If scroll element is not found, then ScrollSpy silently does nothing
302+
- If scroll element is not found, then Scrollspy silently does nothing
303303

304304
**Important! Requires relative positioning** No matter the implementation method, scrollspy requires
305305
the use of `position: relative;` on the element you're scrolling on. In most cases this is the

‎src/directives/scrollspy/helpers/bv-scrollspy.class.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* ScrollSpy class definition
2+
* Scrollspy class definition
33
*/
44

55
import { EVENT_OPTIONS_NO_CAPTURE } from '../../../constants/events'
@@ -115,7 +115,7 @@ const typeCheckConfig = (
115115
*/
116116

117117
/* istanbul ignore next: not easy to test */
118-
export class BVScrollSpy /* istanbul ignore next: not easy to test */ {
118+
export class BVScrollspy /* istanbul ignore next: not easy to test */ {
119119
constructor(element, config, $root) {
120120
// The element we activate links in
121121
this.$el = element

‎src/directives/scrollspy/scrollspy.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@ import { isNumber, isObject, isString } from '../../utils/inspect'
33
import { mathRound } from '../../utils/math'
44
import { toInteger } from '../../utils/number'
55
import { keys } from '../../utils/object'
6-
import { BVScrollSpy } from './helpers/bv-scrollspy.class'
6+
import { BVScrollspy } from './helpers/bv-scrollspy.class'
77

88
// Key we use to store our instance
9-
const BV_SCROLLSPY = '__BV_ScrollSpy__'
9+
const BV_SCROLLSPY = '__BV_Scrollspy__'
1010

1111
// Pre-compiled regular expressions
1212
const onlyDigitsRE = /^\d+$/
1313
const offsetRE = /^(auto|position|offset)$/
1414

15-
// Build a ScrollSpy config based on bindings (if any)
15+
// Build a Scrollspy config based on bindings (if any)
1616
// Arguments and modifiers take precedence over passed value config object
1717
/* istanbul ignore next: not easy to test */
1818
const parseBindings = bindings => /* istanbul ignore next: not easy to test */ {
@@ -47,7 +47,7 @@ const parseBindings = bindings => /* istanbul ignore next: not easy to test */ {
4747
// Value is config object
4848
// Filter the object based on our supported config options
4949
keys(bindings.value)
50-
.filter(k => !!BVScrollSpy.DefaultType[k])
50+
.filter(k => !!BVScrollspy.DefaultType[k])
5151
.forEach(k => {
5252
config[k] = bindings.value[k]
5353
})
@@ -56,7 +56,7 @@ const parseBindings = bindings => /* istanbul ignore next: not easy to test */ {
5656
return config
5757
}
5858

59-
// Add or update ScrollSpy on our element
59+
// Add or update Scrollspy on our element
6060
const applyScrollspy = (el, bindings, vnode) => /* istanbul ignore next: not easy to test */ {
6161
if (!IS_BROWSER) {
6262
/* istanbul ignore next */
@@ -66,11 +66,11 @@ const applyScrollspy = (el, bindings, vnode) => /* istanbul ignore next: not eas
6666
if (el[BV_SCROLLSPY]) {
6767
el[BV_SCROLLSPY].updateConfig(config, vnode.context.$root)
6868
} else {
69-
el[BV_SCROLLSPY] = new BVScrollSpy(el, config, vnode.context.$root)
69+
el[BV_SCROLLSPY] = new BVScrollspy(el, config, vnode.context.$root)
7070
}
7171
}
7272

73-
// Remove ScrollSpy on our element
73+
// Remove Scrollspy on our element
7474
/* istanbul ignore next: not easy to test */
7575
const removeScrollspy = el => /* istanbul ignore next: not easy to test */ {
7676
if (el[BV_SCROLLSPY]) {

‎src/directives/tooltip/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Tooltips
1+
# Tooltip
22

3-
> Documentation and examples for adding custom BootstrapVue tooltips, using Bootstrap v4 CSS for
4-
> styling and animations. Tooltips can be triggered by hovering, focusing, or clicking an element
3+
> Add custom BootstrapVue tooltips to any element. Tooltips can be triggered by hovering, focusing,
4+
> or clicking an element.
55
66
## Overview
77

‎src/icons/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Bootstrap Icons
1+
# Icons
22

33
> Bootstrap Icons are designed to work with Bootstrap components, from form controls to navigation.
44
> Bootstrap Icons are SVGs, so they scale quickly and easily and can be styled with CSS. While they
@@ -661,7 +661,7 @@ font scaled by 125%).
661661
<!-- icons-buttons.vue -->
662662
```
663663

664-
### Button groups and toolbars
664+
### Button Groups and toolbars
665665

666666
#### Button Group
667667

@@ -734,7 +734,7 @@ font scaled by 125%).
734734
<!-- icons-button-toolbar.vue -->
735735
```
736736

737-
### Input groups
737+
### Input Groups
738738

739739
```html
740740
<template>
@@ -774,7 +774,7 @@ font scaled by 125%).
774774
<!-- icons-input-groups.vue -->
775775
```
776776

777-
### List groups
777+
### List Groups
778778

779779
```html
780780
<template>

‎src/icons/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@bootstrap-vue/icons",
33
"version": "1.0.0",
44
"meta": {
5-
"title": "Bootstrap Icons",
5+
"title": "Icons",
66
"version": "2.2.0",
77
"bootstrap-icons-version": "1.2.2",
88
"slug": "",

0 commit comments

Comments
 (0)