Skip to content

Bootstrap 5 based Vue 3 components and directives. CoreUI for Vue.js replaces and extends the Bootstrap 5 javascript. Components have been built from scratch as true Vue 3 components.

License

Notifications You must be signed in to change notification settings

coreui/coreui-vue

Repository files navigation

CoreUI Vue components library

Tweet NPM Downloads Jest Vue

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 »

Installation

npm install @coreui/vue

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';

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

About

Bootstrap 5 based Vue 3 components and directives. CoreUI for Vue.js replaces and extends the Bootstrap 5 javascript. Components have been built from scratch as true Vue 3 components.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 9