Repository files navigation

Open Source UI Components Library for Vue.js.
Explore CoreUI docs »

Report bug ·Request feature ·Community ·Blog

• Quick start
• Bugs and feature requests
• Documentation
• Contributing
• Community
• Versioning
• Creators
• Thanks
• Copyright and license

Several quick start options are available:

• Download the latest release
• Clone the repo:git clone https://github.com/coreui/coreui-vue.git
• Install withnpm:npm install @coreui/vue@next
• Install withyarn:yarn add @coreui/vue@next

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

Components are styled using @coreui/coreui CSS library, but you can use them also with bootstrap CSS library. That is possible because @coreui/coreui-vue 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! ImportCoreUI CSS library (recommended), orBootstrap library

Installation:

yarn add @coreui/coreui

or

npm install @coreui/coreui

Basic usage:

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

// Installing whole packageimportCoreuiVuefrom'@coreui/vue';app.use(CoreuiVue);// Registering a single componentimport{CSwitch,CButton}from'@coreui/vue';// globallyapp.component('CButton',CButton)exportdefault{  ...// locallycomponents:{CSwitch},  ...}

// Registering single directivesimport{CPopover,CTooltip}from'@coreui/vue';// globallyapp.directive('c-tooltip',CTooltip)exportdefault{  ...// locallydirectives:{'c-tooltip':CTooltip},  ...}

Components are imported from CommonJS module by default, if you want to use only specific components you can import them from source to enable treeshaking.

// Import components this way to allow tree shakingimport{CAlert}from'@coreui/vue/src';

If you are usingVS Code editor with Vetur plugin installed, then the editor would display hints for our library (component names and prop names).

Have a bug or a feature request? Please first read theissue 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 websiteCoreUI

1. Runyarn install ornpm install to install the Node.js dependencies, including Hugo (the site builder).
2. Runyarn docs:dev ornpm run docs:dev (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
3. From the project directory, runyarn docs:dev ornpm run docs:dev in the command line.
4. Openhttp://localhost:8080/ in your browser, and voilà.

Please read through ourcontributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Editor preferences are available in theeditor config for easy use in common text editors. Read more and download plugins athttps://editorconfig.org/.

Stay up to date on the development of CoreUI and reach out to the community with these helpful resources.

• Read and subscribe toThe Official CoreUI Blog.
• Jointhe official Community.

You can also follow@core_ui on Twitter.

For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI is maintained underthe Semantic Versioning guidelines.

Seethe Releases section of our project for changelogs for each release version.

Łukasz Holeczek

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

Andrzej Kopański

• https://github.com/xidedix

CoreUI Team

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

Contributors

• https://github.com/coreui/coreui-vue/graphs/contributors

Copyright 2021 creativeLabs Łukasz Holeczek. Code released under theMIT License. Docs released underCreative Commons.