Repository files navigation

A @coreui/vuev3 components library project

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

Before installation you need to installnode and npm on your machine.

npm install @coreui/vue

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! ImportCoreUI CSS library (recommended), orBootstrap library

Installation:

npm install @coreui/coreui

Basic usage:

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

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

// Registering single directivesimport{CEmitRootEvent,CTooltip}from'@coreui/vue';// globallyVue.directive('c-emit-root-event',CEmitRootEvent)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{CDataTable}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).

See the GitHubrelease history.

SeeCONTRIBUTING.md.

Some design ideas and solutions in this library are inspired byBootstrap-Vue library