React.js Components Library built on top of Bootstrap 5 and TypeScript.
Explore CoreUI for React.js docs »
Report bug
·
Request feature
·
Blog
- Quick start
- Status
- What's included
- Bugs and feature requests
- Documentation
- Contributing
- Community
- Versioning
- Creators
- Copyright and license
Several quick start options are available:
- Download the latest release
- Clone the repo:
git clone https://github.com/coreui/coreui-react.git - Install with npm:
npm install @coreui/react - Install with yarn:
yarn add @coreui/react
Read the Getting started page for information on the framework contents, templates and examples, and more.
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.
yarn add @coreui/coreuior
npm install @coreui/coreui --saveimport '@coreui/coreui/dist/css/coreui.min.css'yarn add bootstrapor
npm install bootstrapimport "bootstrap/dist/css/bootstrap.min.css";
Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.
The documentation for the CoreUI & CoreUI PRO is hosted at our website CoreUI for React
- Run
yarn installornpm installto install the Node.js dependencies. - Run
yarn bootstrapornpm run bootstrapto link local packages together and install remaining package dependencies. - From the root directory, run
yarn docs:devornpm run docs:dev(or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets. - Open
http://localhost:8000/in your browser, and voilà.
Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.
Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.
Stay up to date on the development of CoreUI and reach out to the community with these helpful resources.
- Read and subscribe to The Official CoreUI Blog.
You can also follow @core_ui on Twitter.
For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI is maintained under the Semantic Versioning guidelines.
See the Releases section of our project for changelogs for each release version.
Łukasz Holeczek
Andrzej Kopański
The CoreUI Team
Copyright 2021 creativeLabs Łukasz Holeczek. Code released under the MIT License. Docs released under Creative Commons.