Skip to content

Commit 21b6455

Browse files
committed
docs: update documentation
1 parent fdc1997 commit 21b6455

File tree

6 files changed

+78
-59
lines changed

6 files changed

+78
-59
lines changed

docs/4.0/components/CCard.mdx

Lines changed: 29 additions & 29 deletions
Large diffs are not rendered by default.

docs/4.0/components/CHeader.mdx

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,6 @@ import {
3434
CHeaderToggler
3535
} from '../../../src/index.ts'
3636

37-
## Example
38-
39-
Here's what you need to know before getting started with the header:
40-
41-
- Headers require a wrapping `.header` with `.header-expand{-sm|-md|-lg|-xl|-xxl}` for responsive collapsing and [color scheme](#color-schemes) classes.
42-
- Headers and their contents are fluid by default. Change the [container](#containers) to limit their horizontal width in different ways.
43-
- Use our [spacing](https://coreui.io/docs/utilities/spacing") and [flex](https://coreui.io/docs/4.0/utilities/flex) utility classes for controlling spacing and alignment within headers.
44-
- Headers are responsive by default, but you can easily modify them to change that. Responsive behavior depends on our Collapse JavaScript plugin.
45-
- Ensure accessibility by using a `<nav>` element or, if using a more generic element such as a `<div>`, add a `role="navigation"` to every header to explicitly identify it as a landmark region for users of assistive technologies.
46-
- Indicate the current item by using `aria-current="page"` for the current page or `aria-current="true"` for the current item in a set.
47-
4837
## Supported content
4938

5039
Headers come with built-in support for a handful of sub-components. Choose from the following as needed:

docs/4.0/components/CNav.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import {
2828

2929
Navigation available in CoreUI for React share general markup and styles, from the base `.nav` class to the active and disabled states. Swap modifier classes to switch between each style.
3030

31-
The base `.nav` component is built with flexbox and provide a strong foundation for building all types of navigation components. It includes some style overrides (for working with lists), some link padding for larger hit areas, and basic disabled styling.
31+
The base `<CNav>` component is built with flexbox and provide a strong foundation for building all types of navigation components. It includes some style overrides (for working with lists), some link padding for larger hit areas, and basic disabled styling.
3232

3333
<Playground>
3434
<CNav>
@@ -68,7 +68,7 @@ Classes are used throughout, so your markup can be super flexible. Use `<ul>`s l
6868

6969
## Available styles
7070

71-
Change the style of `.nav`s component with modifiers and utilities. Mix and match as needed, or build your own.
71+
Change the style of `<CNav>`'s component with modifiers and utilities. Mix and match as needed, or build your own.
7272

7373
### Horizontal alignment
7474

@@ -197,7 +197,7 @@ Take that same HTML, but use `variant="pills"` instead:
197197

198198
### Fill and justify
199199

200-
Force your `.nav`'s contents to extend the full available width one of two modifier classes. To proportionately fill all available space with your `.nav-item`s, use `layout="fill"`. Notice that all horizontal space is occupied, but not every nav item has the same width.
200+
Force your `<CNav>`'s contents to extend the full available width one of two modifier classes. To proportionately fill all available space with your `.nav-item`s, use `layout="fill"`. Notice that all horizontal space is occupied, but not every nav item has the same width.
201201

202202
<Playground>
203203
<CNav variant="pills" layout="fill">

docs/4.0/components/COffcanvas.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,3 +141,21 @@ Try the top, right, and bottom examples out below.
141141
)
142142
}}
143143
</Playground>
144+
145+
## API
146+
147+
### COffcanvas
148+
149+
<Props of={COffcanvas} />
150+
151+
### COffcanvasBody
152+
153+
<Props of={COffcanvasBody} />
154+
155+
### COffcanvasHeader
156+
157+
<Props of={COffcanvasHeader} />
158+
159+
### COffcanvasTitle
160+
161+
<Props of={COffcanvasTitle} />

docs/4.0/components/CSidebar.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ route: /components/sidebar
77

88
import { Playground, Props } from 'docz'
99
import CIcon from '@coreui/icons-react'
10+
import { cilSpeedometer } from '@coreui/icons'
1011

1112
import {
1213
CBadge,
@@ -41,11 +42,11 @@ Sidebar come with built-in support for a handful of sub-components. Choose from
4142
<CSidebarNav>
4243
<CNavTitle>Nav Title</CNavTitle>
4344
<CNavItem href="#">
44-
<CIcon customClassName="nav-icon" name="cil-speedometer"/>
45+
<CIcon customClassName="nav-icon" name={cilSpeedometer}/>
4546
Nav item
4647
</CNavItem>
4748
<CNavItem href="#">
48-
<CIcon customClassName="nav-icon" name="cil-speedometer"/>
49+
<CIcon customClassName="nav-icon" name={cilSpeedometer}/>
4950
With badge
5051
<CBadge color="primary ms-auto">NEW</CBadge>
5152
</CNavItem>

docs/4.0/migration/v4.mdx

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ route: "/migration/v4"
77

88
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/).
99

10-
### Components
10+
## Components
1111

1212
- Deprecated component `CEmbed`
1313
- Deprecated component `CJumbotron`
1414

15-
#### Badges
15+
### Badges
1616

17-
- variant="pill" => shape="rounded-pill"
18-
- variant="square" => shape="rounded-0"
17+
- `variant="pill"` => `shape="rounded-pill"`
18+
- `variant="square"` => `shape="rounded-0"`
1919

20-
#### Forms
20+
### Forms
2121

2222
- `CInput` => `CFormInput`
2323
- `CInputCheckbox` => `CFormCheck`
@@ -27,36 +27,47 @@ CoreUI for React is the React.js version of CoreUI components library, so before
2727
- `CInvalidFeedback` => `CFormFeedback invalid`
2828

2929
- Deprecated component `CFormGroup`
30-
- Deprecated component `CInputGroupAppend`
31-
- Deprecated component `CInputGroupPrepend`
32-
- Depreacted component `CSwitch`, use `CFormCheck switch` instead of.
30+
- Deprecated component `CInputGroupAppend`, use `CInputGroupText` instead of.
31+
- Deprecated component `CInputGroupPrepend` use `CInputGroupText` instead of.
32+
- Depreacted component `CSwitch`, use `CFormSwitch` instead of.
3333
- Deprecated `.help-block`
3434

35-
#### Header
35+
### Header
3636

3737
- Deprecated property `withSubheader`
3838
- Deprecated component `CHeaderNavItem`, use `CNavItem` instead of.
3939
- Deprecated component `CHeaderNavLink`, use `CNavLink` instead of.
4040

41-
#### List Group
41+
### List Group
4242

4343
- Depracated prop `action` Use property `component="a"` or `component="button"` instead of `action`.
4444

45-
#### Modal
45+
### Modal
4646

4747
- Depracated prop `show` Use `visible` instead of.
4848

49-
#### Popover
49+
### Popover
5050

5151
- Depracated prop `header` Use `title` instead of.
5252

53-
#### Progress Bar
53+
### Progress Bar
5454

5555
- Depracated prop `precision`
5656
- Depracated prop `showLabel`
5757
- Depracated prop `showPercentage`
5858
- Depracated prop `showValue`
5959

60-
#### Tabs
60+
### Sidebar
61+
- Deprecated property `minimize` use `narrow` instead of.
62+
- Deprecated property `dropdownMode`.
63+
64+
- Deprecated component `CSidebarForm`, use `CForm` instead of.
65+
- Deprecated component `CSidebarNavDivider`, use `CNavDivider` instead of.
66+
- Deprecated component `CSidebarNavDropdown`, use `CNavGroup` instead of.
67+
- Deprecated component `CSidebarNavLink`, use `CNavLink` instead of.
68+
- Deprecated component `CSidebarNavItem`, use `CNavItem` instead of.
69+
- Deprecated component `CSidebarNavTitile`, use `CNavTitle` instead of.
70+
71+
### Tabs
6172

6273
- Deprecated component `<CTabs>` use `<CNav variant="tabs">` without wrapper component `<CTabs>`

0 commit comments

Comments
 (0)