CoreUI

React.js Components Library built on top of Bootstrap 5 and TypeScript.
Explore CoreUI docs »

Report bug · Request feature · Community · Blog

Table of contents

• Quick start
• Status
• What's included
• Bugs and feature requests
• Documentation
• Contributing
• Community
• Versioning
• Creators
• Copyright and license

Quick start

Instalation

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@next
• Install with yarn: yarn add @coreui/react@next

Read the Getting started page for information on the framework contents, templates and examples, and more.

Stylesheets

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 is custom CoreUI components, which don't exist in the Bootstrap ecosystem.

CoreUI CSS files

Installation

npm install @coreui/coreui@next

Basic usage

import "@coreui/dist/css/coreui.min.css";

Bootstrap CSS files

Installation

npm install bootstrap@next

Basic usage

import "bootstrap/dist/css/bootstrap.min.css";

Status

Bugs and feature requests

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.

Documentation

The documentation for the CoreUI & CoreUI PRO is hosted at our website CoreUI for React

Running documentation locally

1. Run yarn install to install the Node.js dependencies, including Hugo (the site builder).
2. Run yarn docz:build (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
3. From the root directory, run yarn docz:serve in the command line.
4. Open http://localhost:3000/ in your browser, and voilà.

Contributing

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/.

Community

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.
• Join the official Community.

You can also follow @core_ui on Twitter.

Versioning

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.

Creators

Łukasz Holeczek

• https://twitter.com/lukaszholeczek
• https://github.com/mrholek

Andrzej Kopański

• https://github.com/xidedix

Copyright and license

Copyright 2021 creativeLabs Łukasz Holeczek. Code released under the MIT License. Docs released under Creative Commons.