英文原文正文为项目原始 README（英文），本站后续会翻译为中文，当前仅剔除图片与无关章节并统一排版。

简介

Varlet 是一个基于 Material Design 2 和 3 的 Vue3 组件库，支持移动端和桌面端，由 varletjs 组织开发和维护。

特性

• 🚀   提供 70 个高质量通用组件
• 🚀   组件非常轻量
• 💪   由中国人开发，提供完整的中英文文档和物流支持
• 🛠️   支持按需引入
• 🛠️   支持主题定制
• 🌍   支持国际化
• 💡   支持 WebStorm 语法高亮
• 💪   支持服务端渲染（SSR）
• 📦   支持 Nuxt 模块
• 💡   支持 Typescript
• 💪   确保超过 90% 单元测试覆盖率，提供稳定性保障
• 🎨   支持 Material Design 2 和 Material Design 3 两种设计体系
• 🛠️   支持暗黑模式
• 🔧   提供官方 VSCode 插件
• ⌨️   支持无障碍（仍在改进中）

安装

内容分发网络

varlet.js 包含组件库的所有样式和逻辑，你可以导入它们。

<div id="app"></div>
<script src="https://cdn.jsdelivr.net/npm/vue"></script>
 <!-- Desktop Adaptation -->
<script src="https://cdn.jsdelivr.net/npm/@varlet/touch-emulator/iife.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@varlet/ui/umd/varlet.js"></script>
<script>
  const app = Vue.createApp({
    template: '<var-button>Button</var-button>'
  })
  app.use(Varlet).mount('#app')
</script>

Webpack / Vite

# Install with npm or yarn or pnpm

# npm
npm i @varlet/ui -S

# yarn
yarn add @varlet/ui

# pnpm
pnpm add @varlet/ui

import App from './App.vue'
import Varlet from '@varlet/ui'
import { createApp } from 'vue'
import '@varlet/ui/es/style'

createApp(App).use(Varlet).mount('#app')

官方生态系统

以下项目由官方团队长期维护。

社区生态系统

以下项目由社区工作人员维护，欢迎加入。

操场

查看 Varlet UI Playground。

贡献

请参阅 贡献指南。

GitCode 仓库

请参见 这里。