https://github.com/chakra-ui/vue-cli-plugin-chakra-ui
This plugin setups Chakra UI Vue in your Vue CLI generated projoect
https://github.com/chakra-ui/vue-cli-plugin-chakra-ui
Last synced: 12 months ago
JSON representation
This plugin setups Chakra UI Vue in your Vue CLI generated projoect
- Host: GitHub
- URL: https://github.com/chakra-ui/vue-cli-plugin-chakra-ui
- Owner: chakra-ui
- License: mit
- Created: 2020-03-22T08:20:02.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2020-09-06T10:40:20.000Z (almost 6 years ago)
- Last Synced: 2025-06-06T11:07:27.115Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/vue-cli-plugin-chakra-ui
- Size: 79.1 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# vue-cli-plugin-chakra-ui 🔥
This plugin setups Chakra UI Vue in your Vue CLI generated project.
## Install Vue CLI 3 🔌
If you haven't yet installed vue-cli 3, install it like so:
```
npm install -g @vue/cli
```
or
```
yarn global add @vue/cli
```
>If you still need the legacy `vue init` functionality, you can install a global bridge by following the instructions [here](https://cli.vuejs.org/guide/creating-a-project.html#pulling-2-x-templates-legacy)
Generate a project using vue-cli 3.0:
```vue create my-app```
Before installing the chakra-ui plugin, make sure to commit or stash your changes in case you need to revert the changes.
## Usage 😎
To install the chakra-ui plugin simply navigate to your application's folder and add chakra-ui.
```
vue add chakra-ui
```
The plugin will install [`@chakra-ui/vue`](https://vue.chakra-ui.com) and it's peer dependency - [Emotion](https://emotion.sh)
> As of v1.0.0, If you chose to allow automatic import of Chakra UI components from the prompt in the installation, [Chakra-Loader](https://github.com/chakra-ui/chakra-loader) will be installed for you.
The plugin will also touch `main.js` and `App.vue` to set up your project for consumption of Chakra UI components.
MIT © [Kelvin Omereshone](https://github.com/DominusKelvin)