Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 2.66 KB

README.md

File metadata and controls

71 lines (48 loc) · 2.66 KB
Raw

CoreUI React components library

npm package npm next NPM downloads

@coreui/react v3 for CoreUI 3 for React
Over 90 bootstrap based React components and directives
For library guide please visit our Documentation site »

Check out demo of components usage: CoreUI React Admin Template »

Template

Installation

Before installation you need to install node and npm on your machine.

npm install @coreui/react

Styling

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 (template components, callout, switch).

Styles have to be imported separately! Import CoreUI CSS library (recommended), or Bootstrap library

Installation:

npm install @coreui/coreui

Styles usage:

@import "~@coreui/coreui/scss/coreui";

Changelog

See the GitHub release history.

Contributing

See CONTRIBUTING.md.

Credits

Some design ideas and solutions in this library inspired by reactstrap library

  • bootstrapped with nwb toolkit

npm run scripts

package.json is configured with "scripts" we can use with npm run while developing the project.

Command Description
npm test run tests
npm run test:coverage run tests and produce a code coverage report in coverage/
npm run test:watch start a test server and re-run tests on every change
npm run build prepare for publishing to npm
npm run clean delete built resources

see also: