Skip to content

Commit 6a2004e

Browse files
committed
Ship: v2.5.0
BREAKING CHANGE: - react-router-dom v5
1 parent f2dd6c0 commit 6a2004e

File tree

2 files changed

+45
-1
lines changed

2 files changed

+45
-1
lines changed

CHANGELOG.md

+44
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,49 @@
11
### [@coreui/react](https://coreui.io/) changelog
22

3+
##### `v2.5.0`
4+
- BREAKING CHANGE release for use with `react-router-dom v5`
5+
- feat(Breadcrumb2): mandatory prop `router` :boom: see: [Breadcrumb](./src/Breadcrumb.md)
6+
- feat(SidebarNav2): mandatory prop `router` :boom: see: [SidebarNav](./src/SidebarNav.md)
7+
- refactor: demo update
8+
- refactor(SidebarNav): rename `options` prop for PerfectScrollbar
9+
10+
###### dependencies update
11+
- update `react-router-dom` to `^5.0.0` -> moved to `peerDependencies`
12+
13+
__BREAKING CHANGES:__ :boom:
14+
- removed `react-router-dom` from `dependencies`
15+
- deprecate 'Breadcrumb' in favour of `Breadcrumb2`
16+
- deprecate 'SidebarNav' in favour of `SidebarNav2`
17+
18+
usage in `DefaultLayout.js`:
19+
```jsx
20+
import * as router from 'react-router-dom';
21+
import {
22+
AppBreadcrumb2 as AppBreadcrumb
23+
AppSidebarNav2 as AppSidebarNav
24+
} from '@coreui/react';
25+
// routes config
26+
import routes from '../../routes.js';
27+
```
28+
29+
```html
30+
...
31+
<div className="app-body">
32+
<AppSidebar fixed display="lg">
33+
<AppSidebarNav navConfig={navigation} {...this.props} router={router}/>
34+
<AppSidebarMinimizer />
35+
</AppSidebar>
36+
<main className="main">
37+
<AppBreadcrumb appRoutes={routes} router={router}></AppBreadcrumb>
38+
...
39+
</main>
40+
...
41+
</div>
42+
...
43+
```
44+
45+
---
46+
347
##### `v2.1.7`
448
- maintenance release for use with:
549
- react-router `v4.3.x`

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@coreui/react",
3-
"version": "2.1.7",
3+
"version": "2.5.0",
44
"description": "CoreUI React Bootstrap 4 components",
55
"license": "MIT",
66
"author": {

0 commit comments

Comments
 (0)