安装指南

如何安装依赖并构建你的应用程序。

框架支持

TypeScript

本项目及其组件均使用 TypeScript 编写。我们建议你的项目也采用 TypeScript。

不过我们也提供了组件的 JavaScript 版本。JavaScript 版本可通过 CLI 获取。

若要退出 TypeScript,你可以在 components.json 文件中设置 typescript 标志。

components.json
json
{
  "style": "default",
  "tailwind": {
    "config": "tailwind.config.js",
    "css": "src/app/globals.css",
    "baseColor": "zinc",
    "cssVariables": true
  },
  "typescript": false,
  "aliases": {
    "utils": "~/lib/utils",
    "components": "~/components"
  }
}

要配置导入别名,你可以使用以下 jsconfig.json

jsconfig.json
json
{
  "compilerOptions": {
    "paths": {
      "@/*": ["./*"]
    }
  }
}

VSCode 扩展

在 Visual Studio Code 中安装 @selemondev 开发的 shadcn-vue 扩展,以便轻松将 Shadcn Vue 组件添加到你的项目中。

此扩展提供以下功能:

  • 初始化 Shadcn Vue CLI
  • 安装组件
  • 打开文档
  • 直接从 IDE 导航到特定组件的文档页面
  • 提供便捷的代码片段,用于快速导入组件和编写标记
Edit this page on GitHub