Skip to content

Commit 887a61f

Browse files
committed
docs: update content
1 parent 2ce4208 commit 887a61f

File tree

10 files changed

+30
-30
lines changed

10 files changed

+30
-30
lines changed

packages/docs/content/4.2/components/accordion.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: React Accordion Component
33
name: Accordion
4-
description: Build vertically collapsing accordions in combination with our React Collapse component.
4+
description: Build vertically collapsing accordions in combination with our React Accordion component.
55
menu: Components
66
route: /components/accordion
77
---
@@ -17,7 +17,7 @@ import {
1717
} from '@coreui/react/src/index'
1818

1919

20-
## Examples
20+
## How to use React Accordion component.
2121

2222
Click the accordions below to expand/collapse the accordion content.
2323

@@ -203,7 +203,7 @@ Add `flush` to remove the default `background-color`, some borders, and some rou
203203

204204
### Always open
205205

206-
Add `alwaysOpen` property to make accordion items stay open when another item is opened.
206+
Add `alwaysOpen` property to make react accordion items stay open when another item is opened.
207207

208208
<Example>
209209
<CAccordion alwaysOpen activeItemKey={2}>

packages/docs/content/4.2/components/alert.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import CIcon from '@coreui/icons-react'
1919

2020
import { cilBurn, cilCheckCircle, cilInfo, cilWarning } from '@coreui/icons'
2121

22-
## Examples
22+
## How to use React Alert Component.
2323

2424
React Alert is prepared for any length of text, as well as an optional close button. For a styling, use one of the **required** contextual `color` props (e.g., `primary`). For inline dismissal, use the [dismissing prop](#dismissing).
2525

@@ -114,7 +114,7 @@ return (
114114

115115
### Link color
116116

117-
Use the `<CAlertLink>` component to immediately give matching colored links inside any alert.
117+
Use the `<CAlertLink>` component to immediately give matching colored links inside any react alert component.
118118

119119
<Example>
120120
<CAlert color="primary">
@@ -172,7 +172,7 @@ Use the `<CAlertLink>` component to immediately give matching colored links insi
172172

173173
### Additional content
174174

175-
Alert can also incorporate supplementary components &amp; elements like heading, paragraph, and divider.
175+
React Alert can also incorporate supplementary components &amp; elements like heading, paragraph, and divider.
176176

177177
<Example>
178178
<CAlert color="success">
@@ -194,7 +194,7 @@ Alert can also incorporate supplementary components &amp; elements like heading,
194194

195195
### Icons
196196

197-
Similarly, you can use [flexbox utilities](https//coreui.io/docs/4.0/utilities/flex") and [CoreUI Icons](https://icons.coreui.io) to create alerts with icons. Depending on your icons and content, you may want to add more utilities or custom styles.
197+
Similarly, you can use [flexbox utilities](https//coreui.io/docs/4.0/utilities/flex") and [CoreUI Icons](https://icons.coreui.io) to create react alerts with icons. Depending on your icons and content, you may want to add more utilities or custom styles.
198198

199199
<Example>
200200
<CAlert color="primary" className="d-flex align-items-center">
@@ -218,7 +218,7 @@ Similarly, you can use [flexbox utilities](https//coreui.io/docs/4.0/utilities/f
218218
</CAlert>
219219
```
220220

221-
Need more than one icon for your alerts? Consider using [CoreUI Icons](https://icons.coreui.io).
221+
Need more than one icon for your react alerts? Consider using [CoreUI Icons](https://icons.coreui.io).
222222

223223
<Example>
224224
<CAlert color="primary" className="d-flex align-items-center">
@@ -302,7 +302,7 @@ Use `variant="solid"` to change contextual colors to solid.
302302

303303
### Dismissing
304304

305-
Alerts can also be easily dismissed. Just add the `dismissible` prop.
305+
React Alert component can also be easily dismissed. Just add the `dismissible` prop.
306306

307307
<Example>
308308
<CAlert

packages/docs/content/4.2/components/avatar.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ import Avatar3 from './../assets/images/avatars/3.jpg'
4848

4949
## Rounded avatars
5050

51-
Use the `shape="rounded"` prop to make avatars squared with rounded corners.
51+
Use the `shape="rounded"` prop to make react avatars squared with rounded corners.
5252

5353
<Example>
5454
<CAvatar color="primary" textColor="white" shape="rounded">
@@ -70,7 +70,7 @@ Use the `shape="rounded"` prop to make avatars squared with rounded corners.
7070

7171
## Square avatars
7272

73-
Use the `shape="rounded-0"` prop to make avatars squared.
73+
Use the `shape="rounded-0"` prop to make react avatars squared.
7474

7575
<Example>
7676
<CAvatar color="primary" textColor="white" shape="rounded-0">
@@ -92,7 +92,7 @@ Use the `shape="rounded-0"` prop to make avatars squared.
9292

9393
## Sizes
9494

95-
Fancy larger or smaller avatar? Add `size="xl"`, `size="lg"` or `size="sm"` for additional sizes.
95+
Fancy larger or smaller react avatar component? Add `size="xl"`, `size="lg"` or `size="sm"` for additional sizes.
9696

9797
<Example>
9898
<CAvatar color="secondary" size="xl">

packages/docs/content/4.2/components/badge.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import { CBadge, CButton } from '@coreui/react/src/index'
1111

1212
## Example
1313

14-
Badge component scales to suit the size of the parent element by using relative font sizing and `em` units.
14+
React badge component scales to suit the size of the parent element by using relative font sizing and `em` units.
1515

1616
### Basic usage
1717

@@ -33,7 +33,7 @@ Badge component scales to suit the size of the parent element by using relative
3333
<h6>Example heading <CBadge color="secondary">New</CBadge></h6>
3434
```
3535

36-
Badges can be used as part of links or buttons to provide a counter.
36+
React badges can be used as part of links or buttons to provide a counter.
3737

3838
<Example>
3939
<CButton color="primary">
@@ -47,7 +47,7 @@ Badges can be used as part of links or buttons to provide a counter.
4747
</CButton>
4848
```
4949

50-
Remark that depending on how you use them, badges may be complicated for users of screen readers and related assistive technologies.
50+
Remark that depending on how you use them, react badges may be complicated for users of screen readers and related assistive technologies.
5151

5252
Unless the context is clear, consider including additional context with a visually hidden piece of additional text.
5353

packages/docs/content/4.2/components/image.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Images in CoreUI for React.js are made responsive with `fluid` property. This ap
2525

2626
## Image thumbnails
2727

28-
In addition to our [border-radius utilities](https://coreui.io/docs/4.0/utilities/borders), you can use prop`thumbnail` to give an image a rounded 1px border appearance.
28+
In addition to our [border-radius utilities](https://coreui.io/docs/utilities/borders), you can use prop`thumbnail` to give an image a rounded 1px border appearance.
2929

3030
<Example>
3131
<CImage rounded thumbnail src={React400Img} width={200} height={200} />

packages/docs/content/4.2/components/navbar.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -514,7 +514,7 @@ Place various form controls and components within a navbar:
514514
</CNavbar>
515515
```
516516

517-
Immediate child elements of `<CNavbar>` use flex layout and will default to `justify-content: space-between`. Use additional [flex utilities](https://coreui.io/docs/4.0/utilities/flex/) as needed to adjust this behavior.
517+
Immediate child elements of `<CNavbar>` use flex layout and will default to `justify-content: space-between`. Use additional [flex utilities](https://coreui.io/docs/utilities/flex/) as needed to adjust this behavior.
518518

519519
<Example>
520520
<CNavbar colorScheme="light" className="bg-light">

packages/docs/content/4.2/components/table.mdx

+9-9
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ import {
1717
CTableRow,
1818
} from '@coreui/react/src/index'
1919

20-
## Overview
20+
## How to use React Table Component
2121

22-
Due to the widespread use of `<CTable>` elements across third-party widgets like calendars and date pickers, CoreUI's tables are **opt-in**. All table styles are not inherited in CoreUI, meaning any nested tables can be styled independent from the parent.
22+
Due to the widespread use of `<CTable>` elements across third-party widgets like calendars and date pickers, CoreUI's react tables are **opt-in**. All table styles are not inherited in CoreUI, meaning any nested tables can be styled independent from the parent.
2323

2424
Using the most basic table CoreUI, here's how `<CTable>`-based tables look in CoreUI.
2525

@@ -89,7 +89,7 @@ Using the most basic table CoreUI, here's how `<CTable>`-based tables look in Co
8989

9090
## Variants
9191

92-
Use contextual classes to color tables, table rows or individual cells.
92+
Use contextual classes to color react tables, table rows or individual cells.
9393

9494
<Example>
9595
<CTable>
@@ -213,7 +213,7 @@ Use contextual classes to color tables, table rows or individual cells.
213213

214214
### striped rows
215215

216-
Use `striped` property to add zebra-striping to any table row within the `<CTableBody>`.
216+
Use `striped` property to add zebra-striping to any react table row within the `<CTableBody>`.
217217

218218
<Example>
219219
<CTable striped>
@@ -279,7 +279,7 @@ Use `striped` property to add zebra-striping to any table row within the `<CTabl
279279
</CTable>
280280
```
281281

282-
These classes can also be added to table variants:
282+
These classes can also be added to react table variants:
283283

284284
<Example>
285285
<CTable color="dark" striped>
@@ -411,7 +411,7 @@ These classes can also be added to table variants:
411411

412412
### Hoverable rows
413413

414-
Use `hover` property to enable a hover state on table rows within a `<CTableBody>`.
414+
Use `hover` property to enable a hover state on react table rows within a `<CTableBody>`.
415415

416416
<Example>
417417
<CTable hover>
@@ -817,7 +817,7 @@ Add `bordered` property for borders on all sides of the table and cells.
817817
</CTable>
818818
```
819819

820-
[Border color utilities](https://coreui.io/docs/4.0/utilities/borders#border-color) can be added to change colors:
820+
[Border color utilities](https://coreui.io/docs/utilities/borders#border-color) can be added to change colors:
821821

822822
<Example>
823823
<CTable bordered borderColor="primary">
@@ -885,7 +885,7 @@ Add `bordered` property for borders on all sides of the table and cells.
885885

886886
### Tables without borders
887887

888-
Add `borderless` property for a table without borders.
888+
Add `borderless` property for a react table without borders.
889889

890890
<Example>
891891
<CTable borderless>
@@ -1221,7 +1221,7 @@ Table cells of `<CTableHead>` are always vertical aligned to the bottom. Table c
12211221

12221222
## Nesting
12231223

1224-
Border styles, active styles, and table variants are not inherited by nested tables.
1224+
Border styles, active styles, and react table component variants are not inherited by nested tables.
12251225

12261226
<Example>
12271227
<CTable striped>

packages/docs/content/4.2/components/toast.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ You can stack toasts by wrapping them in a toast container, which will verticall
276276

277277
### Custom content
278278

279-
Customize your toasts by removing sub-components, tweaking them with [utilities](https://coreui.io/docs/4.0/utilities/api), or by adding your own markup. Here we've created a simpler toast by removing the default `<CToastHeader>`, adding a custom hide icon from [CoreUI Icons](https://icons.coreui.io), and using some [flexbox utilities](https://coreui.io/docs/4.0/utilities/flex) to adjust the layout.
279+
Customize your toasts by removing sub-components, tweaking them with [utilities](https://coreui.io/docs/utilities/api), or by adding your own markup. Here we've created a simpler toast by removing the default `<CToastHeader>`, adding a custom hide icon from [CoreUI Icons](https://icons.coreui.io), and using some [flexbox utilities](https://coreui.io/docs/utilities/flex) to adjust the layout.
280280

281281
<Example>
282282
<CToast autohide={false} visible={true} className="align-items-center">
@@ -332,7 +332,7 @@ Alternatively, you can also add additional controls and components to toasts.
332332

333333
### Color schemes
334334

335-
Building on the above example, you can create different toast color schemes with our [color](https://coreui.io/docs/4.0/utilities/colors) and [background](https://coreui.io/docs/4.0//utilities/background) utilities. Here we've set `color="primary"` and added `.text-white` class to the `<Ctoast>`, and then set `white` property to our close button. For a crisp edge, we remove the default border with `.border-0`.
335+
Building on the above example, you can create different toast color schemes with our [color](https://coreui.io/docs/utilities/colors) and [background](https://coreui.io/docs//utilities/background) utilities. Here we've set `color="primary"` and added `.text-white` class to the `<Ctoast>`, and then set `white` property to our close button. For a crisp edge, we remove the default border with `.border-0`.
336336

337337
<Example>
338338
<CToast autohide={false} visible={true} color="primary" className="text-white align-items-center">

packages/docs/content/4.2/layout/breakpoints.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ $grid-breakpoints: (
7676
);
7777
```
7878

79-
For more information and examples on how to modify our Sass maps and variables, please refer to [the Sass section of the Grid documentation](https://coreui.io/docs/4.0/layout/grid#sass).
79+
For more information and examples on how to modify our Sass maps and variables, please refer to [the Sass section of the Grid documentation](https://coreui.io/docs/layout/grid#sass).
8080

8181
## Media queries
8282

packages/docs/content/4.2/migration/v4.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ menu: "Migration"
55
route: "/migration/v4"
66
---
77

8-
CoreUI for React is the React.js version of CoreUI components library, so before read this migration guide, please check also [CoreUI 3 to 4 migration guide](https://coreui.io/docs/4.0/migration/).
8+
CoreUI for React is the React.js version of CoreUI components library, so before read this migration guide, please check also [CoreUI 3 to 4 migration guide](https://coreui.io/docs/migration/).
99

1010
## Components
1111

0 commit comments

Comments
 (0)