- Notifications
You must be signed in to change notification settings - Fork138
⚡️ Build scalable and accessible Vue.js applications with ease.
License
chakra-ui/chakra-ui-vue
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
@chakra-ui/vue gives you a set of accessible and composable Vue components that you can use to build your favourite applications and sites.
Made for Vue 2.X
Head over here =>https://vue.chakra-ui.com
- Ease of Styling: Chakra UI contains a set of layout components like
CBox
andCStack
that make it easy to style your components by passing props.Learn more - Flexible & composable: Chakra UI components are built on top of a Vue UI Primitive for endless composability.
- Accessible. Chakra UI components follows the WAI-ARIA guidelinesspecifications and have the right
aria-*
attributes. - Dark Mode 😍: Most components in Chakra UI are dark mode compatible.
yarn add @chakra-ui/vue @emotion/css
or
npm install @chakra-ui/vue @emotion/css
Note:If you're using Nuxt, you need to install
@nuxtjs/emotion
package as well to server-side render your styles.
yarn add @chakra-ui/vue @emotion/css @nuxtjs/emotion
1. Import the Chakra UI plugin in yourmain.js
file.
importVuefrom'vue'importChakrafrom'@chakra-ui/vue'importAppfrom'./App.vue'Vue.use(Chakra)newVue({el:'#app',render:(h)=>h(App)}).$mount()
2. Wrap your application inside the ChakraCThemeProvider
. We also recommend that you include theCReset
component to normalize all browser styling.
In yourApp.vue
file.
<template><CThemeProvider><CReset/><!-- Your application code goes here! 😁 --></CThemeProvider></template><script>import{CThemeProvider,CReset}from'@chakra-ui/vue'exportdefault{name:'App',components:{ CThemeProvider, CReset}}</script>
If you'd like to toggle your app between dark and light mode, you can also wrap your application inside theColorModeProvider
component.
3. Hurray!🎉 Now the fun can begin. You can start using components like so:
<template><CThemeProvider><CReset/><!-- Your application code goes here! 😁 --><CButtonvariantColor="blue"> Chakra consumed ⚡️</CButton></CThemeProvider></template><script>import{CThemeProvider,CReset,CButton}from'@chakra-ui/vue'exportdefault{name:'App',components:{ CThemeProvider, CReset, CButton}}</script>
You can also view all developed components inStorybook!
Interested in contributing? See ouropen issues! Remember to take a look at ourCONTRIBUTORS guide.
yarn installyarn build&& yarn bootstrapyarn dev
Thanks goes to these wonderful people (emoji key):
This project follows theall-contributors specification. Contributions of any kind welcome!
About
⚡️ Build scalable and accessible Vue.js applications with ease.
Topics
Resources
License
Code of conduct
Uh oh!
There was an error while loading.Please reload this page.