Need help with coreui-vue?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

coreui
305 Stars 67 Forks MIT License 649 Commits 15 Opened issues

Description

Over 90 Bootstrap based Vue.js components and directives. CoreUI React.js UI Components. CoreUI for Vue.js replaces and extends the Bootstrap javascript. Components have been built from scratch as true Vue components, without jQuery and unneeded dependencies.

Services available

!
?

Need anything else?

Contributors list

CoreUI Vue components library

Tweet NPM Downloads Build License Coverage Daily project check

A @coreui/vue

v3
components library project

Over 90 bootstrap based Vue.js components and directives!

For library guide please visit our Documentation site »

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

Template

Installation

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

shell
npm install @coreui/vue

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:

shell
npm install @coreui/coreui

Basic usage:

scss
@import "[email protected]/coreui/scss/coreui";

Registering components

// Installing whole package
import CoreuiVue from '@coreui/vue';
Vue.use(CoreuiVue);

// Registering a single component import { CSwitch, CButton } from '@coreui/vue';

// globally Vue.component('CButton', CButton)

export default { ... // locally components: { CSwitch }, ... }

Registering directives

// Registering single directives
import { CEmitRootEvent, CTooltip } from '@coreui/vue';

// globally Vue.directive('c-emit-root-event', CEmitRootEvent)

export default { ... // locally directives: { 'c-tooltip': CTooltip }, ... }

Optimization

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 shaking
import { CDataTable } from '@coreui/vue/src';

Code autocompletion

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

Changelog

See the GitHub release history.

Contributing

See CONTRIBUTING.md.

Credits

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.