Skip to content

Commit 2872856

Browse files
committed
docs: update documentation
1 parent de96ed2 commit 2872856

33 files changed

+55
-55
lines changed

docs/content/components/alerts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ alert.close()
214214

215215
### Events
216216

217-
Bootstrap's alert plugin exposes a few events for hooking into alert functionality.
217+
CoreUI for Bootstrap's alert plugin exposes a few events for hooking into alert functionality.
218218

219219
{{< bs-table >}}
220220
| Event | Description |

docs/content/components/badge.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ You can also replace the `.badge` class with a few more utilities without a coun
6666

6767
## Contextual variations
6868

69-
Add any of the below-mentioned classes to modify the presentation of a badge. Please note that when using Bootstrap's default `.bg-light`, you'll likely need a text color utility like `.text-dark` for proper styling. This is because background utilities do not set anything but `background-color`.
69+
Add any of the below-mentioned classes to modify the presentation of a badge. Please note that when using CoreUI for Bootstrap's default `.bg-light`, you'll likely need a text color utility like `.text-dark` for proper styling. This is because background utilities do not set anything but `background-color`.
7070

7171
{{< example >}}
7272
{{< badge.inline >}}

docs/content/components/card.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ You can instantly change the text arrangement of any card—in its whole or spec
301301

302302
## Navigation
303303

304-
Add some navigation to a card's header (or block) with Bootstrap's [nav components]({{< docsref "/components/navs-tabs" >}}).
304+
Add some navigation to a card's header (or block) with CoreUI for Bootstrap's [nav components]({{< docsref "/components/navs-tabs" >}}).
305305

306306
{{< example >}}
307307
<div class="card text-center">

docs/content/components/carousel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ const carousel = new coreui.Carousel(myCarouselElement, {
351351

352352
### Events
353353

354-
Bootstrap's carousel class exposes two events for hooking into carousel functionality. Both events have the following additional properties:
354+
CoreUI for Bootstrap's carousel class exposes two events for hooking into carousel functionality. Both events have the following additional properties:
355355

356356
- `direction`: The direction in which the carousel is sliding (either `"left"` or `"right"`).
357357
- `relatedTarget`: The DOM element that is being slid into place as the active item.

docs/content/components/collapse.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Be sure to add `aria-expanded` to the control component. This attribute explicit
102102

103103
If your control element is targeting a single collapsible element – i.e., the `data-coreui-target` attribute is pointing to an `id` selector – you should attach the `aria-controls` attribute to the control part, including the `id` of the collapsible element. Modern screen readers and related assistive technologies address this attribute to provide users with extra shortcuts to navigate directly to the collapsible element itself.
104104

105-
Note that Bootstrap's current implementation does not cover the various *optional* keyboard interactions described in the [WAI-ARIA Authoring Practices 1.1 accordion pattern](https://www.w3.org/TR/wai-aria-practices-1.1/#accordion) - you will need to include these yourself with custom JavaScript.
105+
Note that CoreUI for Bootstrap's current implementation does not cover the various *optional* keyboard interactions described in the [WAI-ARIA Authoring Practices 1.1 accordion pattern](https://www.w3.org/TR/wai-aria-practices-1.1/#accordion) - you will need to include these yourself with custom JavaScript.
106106
## Usage
107107

108108
The collapse plugin utilizes a few classes to handle the heavy lifting:
@@ -170,7 +170,7 @@ const bsCollapse = new coreui.Collapse('#myCollapse', {
170170

171171
### Events
172172

173-
Bootstrap's collapse class exposes a few events for hooking into collapse functionality.
173+
CoreUI for Bootstrap's collapse class exposes a few events for hooking into collapse functionality.
174174

175175
{{< bs-table >}}
176176
| Event type | Description |

docs/content/components/dropdowns.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Dropdowns are built on a third party library, [Popper.js](https://popper.js.org/
2020

2121
The [<abbr title="Web Accessibility Initiative">WAI</abbr> <abbr title="Accessible Rich Internet Applications">ARIA</abbr>](https://www.w3.org/TR/wai-aria/) standard defines an actual [`role="menu"` widget](https://www.w3.org/TR/wai-aria/#menu), but this is specific to application-like menus which trigger actions or functions. <abbr title="Accessible Rich Internet Applications">ARIA</abbr> menus can only contain menu items, checkbox menu items, radio button menu items, radio button groups, and sub-menus.
2222

23-
Bootstrap's dropdowns, on the other hand, are designed to be generic and applicable to a variety of situations and markup structures. For instance, it is possible to create dropdowns that contain additional inputs and form controls, such as search fields or login forms. For this reason, Bootstrap does not expect (nor automatically add) any of the `role` and `aria-` attributes required for true <abbr title="Accessible Rich Internet Applications">ARIA</abbr> menus. Authors will have to include these more specific attributes themselves.
23+
CoreUI for Bootstrap's dropdowns, on the other hand, are designed to be generic and applicable to a variety of situations and markup structures. For instance, it is possible to create dropdowns that contain additional inputs and form controls, such as search fields or login forms. For this reason, Bootstrap does not expect (nor automatically add) any of the `role` and `aria-` attributes required for true <abbr title="Accessible Rich Internet Applications">ARIA</abbr> menus. Authors will have to include these more specific attributes themselves.
2424

2525
However, Bootstrap does add built-in support for most standard keyboard menu interactions, such as the ability to move through individual `.dropdown-item` elements using the cursor keys and close the menu with the <kbd>ESC</kbd> key.
2626

@@ -1041,7 +1041,7 @@ Regardless of whether you call your dropdown via JavaScript or instead use the d
10411041
| `boundary` | string, element | `'scrollParent'` | Overflow constraint boundary of the dropdown menu (applies only to Popper's preventOverflow modifier). By default it's `clippingParents` and can accept an HTMLElement reference (via JavaScript only). For more information refer to Popper's [detectOverflow docs](https://popper.js.org/docs/v2/utils/detect-overflow/#boundary). |
10421042
| `display` | string | `'dynamic'` | By default, we use Popper for dynamic positioning. Disable this with `static`. |
10431043
| `offset` | number, string, function | `[0, 2]` | Offset of the dropdown relative to its target. You can pass a string in data attributes with comma separated values like: `data-coreui-offset="10,20"`. When a function is used to determine the offset, it is called with an object containing the popper placement, the reference, and popper rects as its first argument. The triggering element DOM node is passed as the second argument. The function must return an array with two numbers: [skidding](https://popper.js.org/docs/v2/modifiers/offset/#skidding-1), [distance](https://popper.js.org/docs/v2/modifiers/offset/#distance-1). For more information refer to Popper's [offset docs](https://popper.js.org/docs/v2/modifiers/offset/#options). |
1044-
| `popperConfig` | null, object, function | `null` | To change Bootstrap's default Popper config, see [Popper's configuration](https://popper.js.org/docs/v2/constructors/#options). When a function is used to create the Popper configuration, it's called with an object that contains the Bootstrap's default Popper configuration. It helps you use and merge the default with your own configuration. The function must return a configuration object for Popper. |
1044+
| `popperConfig` | null, object, function | `null` | To change CoreUI for Bootstrap's default Popper config, see [Popper's configuration](https://popper.js.org/docs/v2/constructors/#options). When a function is used to create the Popper configuration, it's called with an object that contains the CoreUI for Bootstrap's default Popper configuration. It helps you use and merge the default with your own configuration. The function must return a configuration object for Popper. |
10451045
| `reference` | string, element | `'toggle'` | Reference element of the dropdown menu. Accepts the values of `'toggle'`, `'parent'`, an HTMLElement reference or an object providing `getBoundingClientRect`. For more information refer to Popper's [constructor docs](https://popper.js.org/docs/v2/constructors/#createpopper) and [virtual element docs](https://popper.js.org/docs/v2/virtual-elements/). |
10461046
{{< /bs-table >}}
10471047

docs/content/components/list-group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ Add nearly any HTML within, even for linked list groups like the one below, with
246246

247247
## Checkboxes and radios
248248

249-
Place Bootstrap's checkboxes and radios within list group items and customize as needed. You can use them without `<label>`s, but please remember to include an `aria-label` attribute and value for accessibility.
249+
Place CoreUI for Bootstrap's checkboxes and radios within list group items and customize as needed. You can use them without `<label>`s, but please remember to include an `aria-label` attribute and value for accessibility.
250250

251251
{{< example >}}
252252
<ul class="list-group">

docs/content/components/modal.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ bootstrap: true
1212

1313
## How it works
1414

15-
Bootstrap modals are lightweight and multi-purpose popups. Modals are split into three primary sections: header, body, and footer. Each has its role and so should be used accordingly. Before getting started with Bootstrap's modal component, be sure to read the following as our menu options have recently changed.
15+
Bootstrap modals are lightweight and multi-purpose popups. Modals are split into three primary sections: header, body, and footer. Each has its role and so should be used accordingly. Before getting started with CoreUI for Bootstrap's modal component, be sure to read the following as our menu options have recently changed.
1616

1717
- Modals are built with HTML, CSS, and JavaScript. They're positioned over everything else in the document and remove scroll from the `<body>` so that modal content scrolls instead.
1818
- Clicking on the modal "backdrop" will automatically close the modal.
@@ -846,7 +846,7 @@ const myModal = new coreui.Modal('#myModal', {
846846

847847
### Events
848848

849-
Bootstrap's modal class exposes a few events for hooking into modal functionality. All modal events are fired at the modal itself (i.e. at the `<div class="modal">`).
849+
CoreUI for Bootstrap's modal class exposes a few events for hooking into modal functionality. All modal events are fired at the modal itself (i.e. at the `<div class="modal">`).
850850

851851
{{< bs-table >}}
852852
| Event | Description |

docs/content/components/navbar.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: docs
33
title: Bootstrap navbar
4-
description: Documentation and examples for Bootstrap's powerful, responsive navigation header, the navbar. Includes support for branding, navigation, and more, including support for our collapse plugin.
4+
description: Documentation and examples for CoreUI for Bootstrap's powerful, responsive navigation header, the navbar. Includes support for branding, navigation, and more, including support for our collapse plugin.
55
group: components
66
toc: true
77
---
@@ -324,7 +324,7 @@ Mix and match with other components and utilities as needed.
324324
**New in v4.2.0:** CSS variables are applied to `.navbar`, defaulting to the "light" appearance, and can be overridden with `.navbar-dark`.
325325
{{< /callout >}}
326326

327-
Navbar themes are easier than ever thanks to Bootstrap's combination of Sass and CSS variables. The default is our "light navbar" for use with light background colors, but you can also apply `.navbar-dark` for dark background colors. Then, customize with `.bg-*` utilities.
327+
Navbar themes are easier than ever thanks to CoreUI for Bootstrap's combination of Sass and CSS variables. The default is our "light navbar" for use with light background colors, but you can also apply `.navbar-dark` for dark background colors. Then, customize with `.bg-*` utilities.
328328

329329
<div class="docs-example">
330330
<nav class="navbar navbar-expand-lg navbar-dark bg-dark">

docs/content/components/navs-tabs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: docs
33
title: Bootstrap navs and tabs
4-
description: Documentation and examples for how to use Bootstrap's included navigation components.
4+
description: Documentation and examples for how to use CoreUI for Bootstrap's included navigation components.
55
group: components
66
aliases: "/4.1/components/navs/"
77
toc: true

0 commit comments

Comments
 (0)