Skip to content

Commit d109bc3

Browse files
committed
relese: v4.0.1
1 parent 482560f commit d109bc3

File tree

9 files changed

+162
-16
lines changed

9 files changed

+162
-16
lines changed

.github/SUPPORT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ See the [contributing guidelines](CONTRIBUTING.md) for sharing bug reports.
66

77
For general troubleshooting or help getting started:
88

9-
- Join [the official community](https://community.coreui.io/).
9+
- Join [GitHub Discussions](https://github.com/coreui/coreui-react/discussions/).

README.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@
2020
·
2121
<a href="https://github.com/coreui/coreui-react/issues/new?template=feature_request.md">Request feature</a>
2222
·
23-
<a href="https://community.coreui.io/">Community</a>
24-
·
2523
<a href="https://blog.coreui.io/">Blog</a>
2624
</p>
2725

@@ -45,7 +43,7 @@
4543

4644
Several quick start options are available:
4745

48-
- [Download the latest release](https://github.com/coreui/coreui-react/archive/v4.0.0.zip)
46+
- [Download the latest release](https://github.com/coreui/coreui-react/archive/v4.0.1.zip)
4947
- Clone the repo: `git clone https://github.com/coreui/coreui-react.git`
5048
- Install with [npm](https://www.npmjs.com/): `npm install @coreui/react`
5149
- Install with [yarn](https://yarnpkg.com/): `yarn add @coreui/react`
@@ -130,7 +128,6 @@ Editor preferences are available in the [editor config](https://github.com/coreu
130128
Stay up to date on the development of CoreUI and reach out to the community with these helpful resources.
131129

132130
- Read and subscribe to [The Official CoreUI Blog](https://blog.coreui.io/).
133-
- Join [the official Community](https://community.coreui.io/).
134131

135132
You can also follow [@core_ui on Twitter](https://twitter.com/core_ui).
136133

lerna.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
"packages/*"
55
],
66
"useWorkspaces": true,
7-
"version": "4.0.0"
7+
"version": "4.0.1"
88
}

packages/coreui-react-chartjs/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@
1818
·
1919
<a href="https://github.com/coreui/coreui-react/issues/new?template=feature_request.md">Request feature</a>
2020
·
21-
<a href="https://community.coreui.io/">Community</a>
22-
·
2321
<a href="https://blog.coreui.io/">Blog</a>
2422
</p>
2523

packages/coreui-react/README.md

+157
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
<p align="center">
2+
<a href="https://coreui.io/">
3+
<img
4+
src="https://coreui.io/images/brand/coreui-signet.svg"
5+
alt="CoreUI logo"
6+
width="200"
7+
/>
8+
</a>
9+
</p>
10+
11+
<h3 align="center">CoreUI for React.js</h3>
12+
13+
<p align="center">
14+
React.js Components Library built on top of Bootstrap 5 and TypeScript.
15+
<br>
16+
<a href="https://coreui.io/react/docs/getting-started/introduction"><strong>Explore CoreUI for React.js docs »</strong></a>
17+
<br>
18+
<br>
19+
<a href="https://github.com/coreui/coreui-react/issues/new?template=bug_report.md">Report bug</a>
20+
·
21+
<a href="https://github.com/coreui/coreui-react/issues/new?template=feature_request.md">Request feature</a>
22+
·
23+
<a href="https://blog.coreui.io/">Blog</a>
24+
</p>
25+
26+
27+
## Table of contents
28+
29+
- [Quick start](#quick-start)
30+
- [Status](#status)
31+
- [What's included](#whats-included)
32+
- [Bugs and feature requests](#bugs-and-feature-requests)
33+
- [Documentation](#documentation)
34+
- [Contributing](#contributing)
35+
- [Community](#community)
36+
- [Versioning](#versioning)
37+
- [Creators](#creators)
38+
- [Copyright and license](#copyright-and-license)
39+
40+
## Quick start
41+
42+
### Instalation
43+
44+
Several quick start options are available:
45+
46+
- [Download the latest release](https://github.com/coreui/coreui-react/archive/v4.0.1.zip)
47+
- Clone the repo: `git clone https://github.com/coreui/coreui-react.git`
48+
- Install with [npm](https://www.npmjs.com/): `npm install @coreui/react`
49+
- Install with [yarn](https://yarnpkg.com/): `yarn add @coreui/react`
50+
51+
Read the [Getting started page](https://coreui.io/react/docs/getting-started/introduction/) for information on the framework contents, templates and examples, and more.
52+
53+
### Stylesheets
54+
55+
React components are styled using `@coreui/coreui` CSS library, but you can use them also with bootstrap CSS library. That is possible because `@coreui/coreui` library is compatible with bootstrap, it just extends its functionalities. The only exception are custom CoreUI components, which don't exist in the Bootstrap ecosystem.
56+
57+
#### CoreUI CSS files
58+
59+
##### Installation
60+
61+
```bash
62+
yarn add @coreui/coreui
63+
```
64+
65+
or
66+
67+
```bash
68+
npm install @coreui/coreui --save
69+
```
70+
71+
##### Basic usage
72+
73+
```js
74+
import '@coreui/coreui/dist/css/coreui.min.css'
75+
```
76+
77+
#### Bootstrap CSS files
78+
79+
##### Installation
80+
81+
```bash
82+
yarn add bootstrap
83+
```
84+
85+
or
86+
87+
```bash
88+
npm install bootstrap
89+
```
90+
91+
##### Basic usage
92+
93+
```js
94+
import "bootstrap/dist/css/bootstrap.min.css";
95+
```
96+
97+
## Status
98+
99+
[![Build Status](https://github.com/coreui/coreui-react/workflows/JS%20Tests/badge.svg?branch=main)](https://github.com/coreui/coreui-react/actions?query=workflow%3AJS+Tests+branch%3Amain)
100+
[![npm version](https://img.shields.io/npm/v/@coreui/react)](https://www.npmjs.com/package/@coreui/react)
101+
[![peerDependencies Status](https://img.shields.io/david/peer/coreui/coreui)](https://david-dm.org/coreui/coreui?type=peer)
102+
[![devDependency Status](https://img.shields.io/david/dev/coreui/coreui)](https://david-dm.org/coreui/coreui?type=dev)
103+
[![Coverage Status](https://img.shields.io/coveralls/github/coreui/coreui-react/v4)](https://coveralls.io/github/coreui/coreui-react?branch=v4)
104+
105+
## Bugs and feature requests
106+
107+
Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/coreui/coreui-react/blob/v4/.github/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/coreui/coreui-react/issues/new).
108+
109+
## Documentation
110+
111+
The documentation for the CoreUI & CoreUI PRO is hosted at our website [CoreUI for React](https://coreui.io/react/docs/getting-started/introduction)
112+
113+
### Running documentation locally
114+
115+
1. Run `yarn install` or `npm install` to install the Node.js dependencies.
116+
2. Run `yarn bootstrap` or `npm run bootstrap` to link local packages together and install remaining package dependencies.
117+
3. From the root directory, run `yarn docs:dev` or `npm run docs:dev` (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
118+
4. Open `http://localhost:8000/` in your browser, and voilà.
119+
120+
## Contributing
121+
122+
Please read through our [contributing guidelines](https://github.com/coreui/coreui-react/blob/v4/.github/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
123+
124+
Editor preferences are available in the [editor config](https://github.com/coreui/coreui-react/blob/v4/.editorconfig) for easy use in common text editors. Read more and download plugins at <https://editorconfig.org/>.
125+
126+
## Community
127+
128+
Stay up to date on the development of CoreUI and reach out to the community with these helpful resources.
129+
130+
- Read and subscribe to [The Official CoreUI Blog](https://blog.coreui.io/).
131+
132+
You can also follow [@core_ui on Twitter](https://twitter.com/core_ui).
133+
134+
## Versioning
135+
136+
For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI is maintained under [the Semantic Versioning guidelines](http://semver.org/).
137+
138+
See [the Releases section of our project](https://github.com/coreui/coreui-react/releases) for changelogs for each release version.
139+
140+
## Creators
141+
142+
**Łukasz Holeczek**
143+
144+
- <https://twitter.com/lukaszholeczek>
145+
- <https://github.com/mrholek>
146+
147+
**Andrzej Kopański**
148+
149+
- <https://github.com/xidedix>
150+
151+
**The CoreUI Team**
152+
153+
- <https://github.com/orgs/coreui/people>
154+
155+
## Copyright and license
156+
157+
Copyright 2021 creativeLabs Łukasz Holeczek. Code released under the [MIT License](https://github.com/coreui/coreui-react/blob/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).

packages/coreui-react/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@coreui/react",
3-
"version": "4.0.0",
3+
"version": "4.0.1",
44
"description": "UI Components Library for React.js",
55
"keywords": [
66
"react",

packages/docs/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@coreui/react-docs",
3-
"version": "4.0.0",
3+
"version": "4.0.1",
44
"private": true,
55
"description": "",
66
"homepage": "https://coreui.io/react/",

packages/docs/src/components/Footer.tsx

-3
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@ const Footer: FC = () => {
1414
<li className="d-inline-block ms-3">
1515
<a href="https://twitter.com/core_ui">Twitter</a>
1616
</li>
17-
<li className="d-inline-block ms-3">
18-
<a href="https://community.coreui.io/">Community</a>
19-
</li>
2017
<li className="d-inline-block ms-3 ps-3 border-start border-2">
2118
<a href="https://coreui.io/">CoreUI (Vanilla)</a>
2219
</li>

packages/docs/src/components/Header.tsx

-3
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,6 @@ const Header: FC = () => {
4242
<CIcon icon={cilMenu} size="lg" />
4343
</CHeaderToggler>
4444
<CHeaderNav className="ms-auto">
45-
<CNavItem href="https://community.coreui.io/">
46-
<CIcon icon={cibDiscourse} size="xl" />
47-
</CNavItem>
4845
<CNavItem href="https://github.com/coreui/coreui-react/">
4946
<CIcon icon={cibGithub} size="xl" />
5047
</CNavItem>

0 commit comments

Comments
 (0)