From 5df5ebea90d324fb43bb6305be58f2192a194072 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Holeczek?= Date: Thu, 21 Oct 2021 13:48:00 +0200 Subject: [PATCH] release: v4.0.0 --- README.md | 6 +-- jest.config.js | 17 ++++++++ migration.md | 101 +--------------------------------------------- package.json | 14 ++----- public/index.html | 2 +- yarn.lock | 64 ++++++++++++++--------------- 6 files changed, 55 insertions(+), 149 deletions(-) create mode 100644 jest.config.js diff --git a/README.md b/README.md index 3380ae7..8d4cdaa 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ [![@coreui react](https://img.shields.io/badge/@coreui%20-react-lightgrey.svg?style=flat-square)](https://github.com/coreui/react) [![npm package][npm-coreui-react-badge]][npm-coreui-react] [![NPM downloads][npm-coreui-react-download]][npm-coreui-react] -[![npm next][npm-next]][npm] [npm-coreui]: https://www.npmjs.com/package/@coreui/coreui [npm-coreui-badge]: https://img.shields.io/npm/v/@coreui/coreui.png?style=flat-square @@ -12,7 +11,6 @@ [npm-coreui-react]: https://www.npmjs.com/package/@coreui/react [npm-coreui-react-badge]: https://img.shields.io/npm/v/@coreui/react.png?style=flat-square [npm-coreui-react-download]: https://img.shields.io/npm/dm/@coreui/react.svg?style=flat-square -[npm-next]: https://img.shields.io/npm/v/@coreui/react/next.png?style=flat-square [npm]: https://www.npmjs.com/package/@coreui/react # CoreUI Free React Admin Template v4 @@ -42,8 +40,6 @@ CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of ## CoreUI Pro -**Only customers with [Enterpise Membership Plan](https://coreui.io/pro/#buy) have access to private github CoreUI Pro repository.** - * 💪 [CoreUI Pro Bootstrap Admin Template](https://coreui.io/pro/) * 💪 [CoreUI Pro Angular Admin Template](https://coreui.io/pro/angular) * 💪 [CoreUI Pro React Admin Template](https://coreui.io/pro/react) @@ -51,7 +47,7 @@ CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of ## Quick Start -- [Download the latest release](https://github.com/coreui/coreui-free-react-admin-template/archive/refs/heads/v4.zip) +- [Download the latest release](https://github.com/coreui/coreui-free-react-admin-template/archive/refs/heads/main.zip) - Clone the repo: `git clone https://github.com/coreui/coreui-free-react-admin-template.git` ### Instalation diff --git a/jest.config.js b/jest.config.js new file mode 100644 index 0000000..abf16ab --- /dev/null +++ b/jest.config.js @@ -0,0 +1,17 @@ +/** + * Copyright (c) 2013-present, creativeLabs Lukasz Holeczek. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +'use strict' + +module.exports = { + collectCoverageFrom: [ + 'src/**/*.{js,jsx}', + '!**/*index.js', + '!src/serviceWorker.js', + '!src/polyfill.js', + ], +} diff --git a/migration.md b/migration.md index 7861398..11a3528 100644 --- a/migration.md +++ b/migration.md @@ -1,102 +1,3 @@ # Migration from version 3 -## CSS - -- `ml-*` to `ms-*` -- `mfs-*` to `ms-*` -- `mr-*` to `me-*` -- `mfe-*` to `me-*` -- `pl-*` to `ps-*` -- `pr-*` to `pe-*` -- `float-left` to `float-start` -- `float-right` to `float-end` - -## Components - -- Deprecated component `CEmbed` -- Deprecated component `CJumbotron` - -### Badges - -- variant="pill" => shape="rounded-pill" -- variant="square" => shape="rounded-0" - -### Forms - -- `CInput` => `CFormInput` -- `CInputCheckbox` => `CFormCheck` -- `CLabel` => `CFormLabel` -- `CSelect` => `CFormSelect` -- `CValidFeedback` => `CFormFeedback valid` -- `CInvalidFeedback` => `CFormFeedback invalid` - -- Deprecated component `CFormGroup` -- Deprecated component `CInputGroupAppend` -- Deprecated component `CInputGroupPrepend` -- Depreacted component `CSwitch`, use `CFormCheck switch` instead of. -- Deprecated `.help-block` - -### Header - -- Deprecated pro `withSubheader` -- Deprecated component `CHeaderNavItem`, use `CNavItem` instead of. -- Deprecated component `CHeaderNavLink`, use `CNavLink` instead of. - -### List Group - -- Depracated prop `action` Use `component="a"` or `component="b"` instead of `action`. - -### Modal - -- Depracated prop `show` Use `visible` instead of. - -### Popover - -- Depracated prop `header` Use `title` instead of. - -### Progress Bar - -- Depracated prop `precision` -- Depracated prop `showLabel` -- Depracated prop `showPercentage` -- Depracated prop `showValue` - -### Tabs - -- Deprecated component `` use `` without wrapper component `` - - -# Migration from version 2 - -Migration from version 2 must be performed manually because the components library `@coreui/coreui-react` has been completely rewritten. - -The docs of the new components are available [here](https://coreui.io/react/docs/) - -The good news is that most probably it will be sufficient to migrate layout components (Sidebar, Header, Footer, Aside) and `Switch` component - -The best way to do a migration is: -1. Install `@coreui/coreui-react` v3 -2. Make a copy of the current `containers` folder -2. Paste [containers](https://github.com/coreui/coreui-free-react-admin-template/tree/master/src/containers) folder from v3 template to project -3. Correct routing paths -4. Add previous content to new template layout components -5. Replace `Switch` components with `CSwitch` - -Layout components/ corresponding components in version 3 -- Aside -> CSidebar (with prop aside={true}) -- AsideToggler -> CToggler -- Breadcrumb -> CBreadcrumbRouter -- Footer -> CFooter -- Header -> CHeader -- HeaderDropdown -> CDropdown -- NavbarBrand -> CSidebarBrand -- Sidebar -> CSidebar -- SidebarFooter -> CSidebarFooter -- SidebarForm -> CSidebarForm -- SidebarHeader -> CSidebarHeader -- SidebarMinimizer -> CSidebarMinimizer -- SidebarNav -> CSidebarNav + CSidebarNavDropdown + CSidebarNavItem -- SidebarToggler -> CSidebarToggler -- Switch -> CSwitch - -After the migration is done, you can start using new components of `@coreui/coreui-react` v3 library. +https://coreui.io/react/docs/4.0/migration/v4/ diff --git a/package.json b/package.json index f7e3b21..9558298 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@coreui/coreui-free-react-admin-template", - "version": "4.0.0-rc.4", + "version": "4.0.0", "description": "CoreUI Free React Admin Template", "homepage": "https://coreui.io/react/", "bugs": { @@ -25,21 +25,13 @@ "config": { "coreui_library_short_version": "4.0" }, - "jest": { - "collectCoverageFrom": [ - "src/**/*.{js,jsx}", - "!**/*index.js", - "!src/serviceWorker.js", - "!src/polyfill.js" - ] - }, "dependencies": { "@coreui/chartjs": "^3.0.0", "@coreui/coreui": "^4.0.5", "@coreui/icons": "^2.1.0", "@coreui/icons-react": "2.0.0", - "@coreui/react": "4.0.0-rc.6", - "@coreui/react-chartjs": "2.0.0-rc.3", + "@coreui/react": "4.0.0", + "@coreui/react-chartjs": "2.0.0", "@coreui/utils": "^1.3.1", "@wojtekmaj/enzyme-adapter-react-17": "^0.6.3", "chart.js": "^3.5.1", diff --git a/public/index.html b/public/index.html index 1f2c73c..8e1904f 100644 --- a/public/index.html +++ b/public/index.html @@ -1,7 +1,7 @@