coreui/coreui-react

CoreUI for React.js

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

Report bug · Request feature · Blog

Table of contents

• Quick start
• Components
• Status
• Bugs and feature requests
• Documentation
• Frameworks
• Templates
• Contributing
• Community
• Versioning
• Creators
• Support CoreUI Development
• 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
• Install with yarn: yarn add @coreui/react

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

CoreUI CSS files

Installation

yarn add @coreui/coreui

or

npm install @coreui/coreui --save

Basic usage

import '@coreui/coreui/dist/css/coreui.min.css'

Bootstrap CSS files

Installation

yarn add bootstrap

or

npm install bootstrap

Basic usage

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

Components

• React Accordion
• React Alert
• React Avatar
• React Badge
• React Breadcrumb
• React Button
• React Button Group
• React Callout
• React Card
• React Carousel
• React Checkbox
• React Close Button
• React Collapse
• React Date Picker PRO
• React Date Range Picker PRO
• React Dropdown
• React Floating Labels
• React Footer
• React Header
• React Image
• React Input
• React Input Group
• React List Group
• React Loading Button PRO
• React Modal
• React Multi Select PRO
• React Navs & Tabs
• React Navbar
• React Offcanvas
• React Pagination
• React Placeholder
• React Popover
• React Progress
• React Radio
• React Range
• React Select
• React Sidebar
• React Smart Pagination PRO
• React Smart Table PRO
• React Spinner
• React Switch
• React Table
• React Textarea
• React Time Picker PRO
• React Toast
• React Tooltip

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 or npm install to install the Node.js dependencies.
2. Run yarn bootstrap or npm run bootstrap to link local packages together and install remaining package dependencies.
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.
4. Open http://localhost:8000/ in your browser, and voilà.

Frameworks

CoreUI supports most popular frameworks.

• CoreUI for Angular
• CoreUI for Bootstrap (Vanilla JS)
• CoreUI for React
• CoreUI for Vue

Templates

Fully featured, out-of-the-box, templates for your application based on CoreUI.

• Angular Admin Template
• Bootstrap Admin Template
• React Admin Template
• Vue Admin Template

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.

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

The CoreUI Team

• https://github.com/orgs/coreui/people

Support CoreUI Development

CoreUI is an MIT-licensed open source project and is completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support development by buying the CoreUI PRO or by becoming a sponsor via Open Collective.

Platinum Sponsors

Support this project by becoming a Platinum Sponsor. A large company logo will be added here with a link to your website.

Gold Sponsors

Support this project by becoming a Gold Sponsor. A big company logo will be added here with a link to your website.

Silver Sponsors

Support this project by becoming a Silver Sponsor. A medium company logo will be added here with a link to your website.

Bronze Sponsors

Support this project by becoming a Bronze Sponsor. The company avatar will show up here with a link to your OpenCollective Profile.

Backers

Thanks to all the backers and sponsors! Support this project by becoming a backer.

Copyright and license

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