Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 2.78 KB

README.md

File metadata and controls

48 lines (32 loc) · 2.78 KB
Raw

Chakra UI Vue - Chidori Starter Template ⚡️

Template for Chakra UI Vue v1 with Typescript, Vite, components auto-importing, layouts, and static site generation.

Features ✨

  • ✅ Vue 3
  • ✅ Gradients support
  • ✅ CSS Variables support
  • ✅ Dark mode ready
  • ✅ Component style overrides
  • ✅ Feather icons ready
  • ✅ Custom component theming API
  • ✅ Custom variants
  • ✅ Components auto-import
  • ✅ SSG on Vite

Note: This template is currently built using an alpha release of @chakra-ui/vue-next.

Deploy with Vercel

Chakra UI Home page Chakra UI Dashboard page

⚡️ Live Demo

Recommended IDE Setup

VSCode + Vetur. Make sure to enable vetur.experimental.templateInterpolationService in settings!

If Using <script setup>

<script setup> is a feature that is currently in RFC stage. To get proper IDE support for the syntax, use Volar instead of Vetur (and disable Vetur).

Type Support For .vue Imports in TS

Since TypeScript cannot handle type information for .vue imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in .vue imports (for example to get props validation when using manual h(...) calls), you can use the following:

If Using Volar

Run Volar: Switch TS Plugin on/off from VSCode command palette.

If Using Vetur

  1. Install and add @vuedx/typescript-plugin-vue to the plugins section in tsconfig.json
  2. Delete src/shims-vue.d.ts as it is no longer needed to provide module info to Typescript
  3. Open src/main.ts in VSCode
  4. Open the VSCode command palette
  5. Search and run "Select TypeScript version" -> "Use workspace version"