CoreUI for Vue.js
Vue.js Components Library built on top of Bootstrap 5 and TypeScript.
Explore CoreUI for Vue.js docs »
Report bug
·
Request feature
·
Blog
Table of contents
- Quick start
- Components
- Status
- Bugs and feature requests
- Documentation
- Frameworks
- Templates
- Data Grid
- Contributing
- Community
- Versioning
- Creators
- Support CoreUI Development
- Copyright and license
Quick start
Instalation
Several quick start options are available:
- Download the latest release
- Clone the repo:
git clone https://github.com/coreui/coreui-vue.git - Install with npm:
npm install @coreui/vue - Install with yarn:
yarn add @coreui/vue
Read the Getting started page for information on the framework contents, templates and examples, and more.
Stylesheets
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 are custom CoreUI components, which don't exist in the Bootstrap ecosystem.
CoreUI CSS files
Installation
yarn add @coreui/coreui
or
npm install @coreui/coreui --save
Basic usage
import '@coreui/coreui/dist/css/coreui.min.css'
Bootstrap CSS files
Installation
yarn add bootstrap
or
npm install bootstrap
Basic usage
import "bootstrap/dist/css/bootstrap.min.css";
Components
- Vue Accordion
- Vue Alert
- Vue Avatar
- Vue Badge
- Vue Breadcrumb
- Vue Button
- Vue Button Group
- Vue Callout
- Vue Card
- Vue Carousel
- Vue Checkbox
- Vue Close Button
- Vue Collapse
- Vue Date Picker PRO
- Vue Date Range Picker PRO
- Vue Dropdown
- Vue Floating Labels
- Vue Footer
- Vue Header
- Vue Image
- Vue Input
- Vue Input Group
- Vue List Group
- Vue Loading Button PRO
- Vue Modal
- Vue Multi Select PRO
- Vue Navs & Tabs
- Vue Navbar
- Vue Offcanvas
- Vue Pagination
- Vue Placeholder
- Vue Popover
- Vue Progress
- Vue Radio
- Vue Range
- Vue Rating
- Vue Select
- Vue Sidebar
- Vue Smart Pagination PRO
- Vue Smart Table PRO
- Vue Spinner
- Vue Switch
- Vue Table
- Vue Textarea
- Vue Time Picker PRO
- Vue Toast
- Vue Tooltip
Status
Bugs and feature requests
Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.
Documentation
The documentation for the CoreUI & CoreUI PRO is hosted at our website CoreUI for Vue
Running documentation locally
- Run
yarn installornpm installto install the Node.js dependencies. - Run
yarn bootstrapornpm run bootstrapto link local packages together and install remaining package dependencies. - From the root directory, run
yarn docs:devornpm run docs:dev(or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets. - Open
http://localhost:8000/in your browser, and voilà.
Frameworks
CoreUI supports most popular frameworks.
Templates
Fully featured, out-of-the-box, templates for your application based on CoreUI.
Data Grid
CoreUI Vue Data Grid handles 100,000+ rows with sorting, filtering, virtualization, column pinning, inline editing and CSV export — using the same markup and stylesheet you already use.
npm install @coreui/vue-data-grid
One license also covers JavaScript, React and Angular. It's a separate add-on, not part of CoreUI PRO.
Contributing
Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.
Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.
Community
Stay up to date on the development of CoreUI and reach out to the community with these helpful resources.
- Read and subscribe to The Official CoreUI Blog.
You can also follow @core_ui on Twitter.
Versioning
For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI is maintained under the Semantic Versioning guidelines.
See the Releases section of our project for changelogs for each release version.
Creators
Łukasz Holeczek
Andrzej Kopański
The CoreUI Team
Support CoreUI Development
CoreUI is an MIT-licensed open source project and is completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support development by buying the CoreUI PRO or by becoming a sponsor via Open Collective.
Platinum Sponsors
Support this project by becoming a Platinum Sponsor. A large company logo will be added here with a link to your website.
Gold Sponsors
Support this project by becoming a Gold Sponsor. A big company logo will be added here with a link to your website.
Silver Sponsors
Support this project by becoming a Silver Sponsor. A medium company logo will be added here with a link to your website.
Bronze Sponsors
Support this project by becoming a Bronze Sponsor. The company avatar will show up here with a link to your OpenCollective Profile.
Backers
Thanks to all the backers and sponsors! Support this project by becoming a backer.
Copyright and license
Copyright 2022 creativeLabs Łukasz Holeczek. Code released under the MIT License. Docs released under Creative Commons.