About @coreui/vue
@coreui/vue is a robust UI components library specifically crafted for Vue.js developers seeking to streamline their front-end development. This npm package offers a comprehensive suite of reusable components that are not only customizable but also designed to integrate seamlessly with Vue.js applications. By leveraging @coreui/vue, developers can enhance their projects with a variety of UI components such as buttons, modals, and cards, which are essential for building modern, responsive, and aesthetically pleasing web applications. The library is built on the latest standards, ensuring compatibility and performance, thus making it an essential toolkit for professional-grade Vue.js development.
To get started with incorporating these high-quality components into your Vue.js projects, you can simply run the command npm install @coreui/vue. This installation process integrates @coreui/vue into your project environment, allowing you to utilize its components immediately. The ease of installation and the straightforward documentation provided with the package ensures that developers can quickly harness the power of @coreui/vue to create sophisticated user interfaces. Moreover, the library supports Vue 3, the latest version of Vue.js, which offers improved performance and enhanced features, making @coreui/vue a forward-compatible choice for modern web development.
One of the key benefits of using @coreui/vue is its focus on flexibility and customization. Developers have the freedom to tailor components to match their specific design requirements, which is crucial for maintaining a unique brand identity across web applications. Additionally, the library adheres to high standards of accessibility and responsiveness, ensuring that applications built with @coreui/vue deliver a seamless user experience on a wide range of devices. With its combination of ease of use, customization options, and adherence to modern web standards, @coreui/vue stands out as a premier choice for developers looking to elevate their Vue.js applications.
Dependencies
Core dependencies of this npm package and its dev dependencies.
@typescript-eslint/eslint-plugin, @typescript-eslint/parser, @vue/eslint-config-prettier, @vue/eslint-config-typescript, @vue/vue3-jest, eslint, eslint-plugin-prettier, eslint-plugin-vue, eslint-config-prettier, eslint-plugin-unicorn, lerna, npm-run-all, prettier
Documentation
A README file for the @coreui/vue code repository. View Code
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
- 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 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.
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
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.
Copyright and license
Copyright 2024 creativeLabs Łukasz Holeczek. Code released under the MIT License. Docs released under Creative Commons.