README.zh-CN.md

VARLET

基于 Vue3 的 Material design 风格移动端组件库

文档(Vercel) | 文档(Gitee) | ENGLISH README

---

介绍

Varlet 是一个基于 Vue3 开发的 Material 风格移动端组件库，全面拥抱 Vue3 生态，由 varletjs 社区团队进行维护。

特性

• 🚀   提供 60+ 个高质量通用组件
• 🚀   组件十分轻量
• 💪   由国人开发，完善的中英文文档和后勤保障
• 🛠️   支持按需引入
• 🛠️   支持主题定制
• 🌍   支持国际化
• 💡   支持 webstorm 组件属性高亮
• 💪   支持 SSR
• 💡   支持 Typescript
• 💪   确保 90% 以上单元测试覆盖率，提供稳定性保证
• 🛠️   支持暗黑模式
• 🛠️   提供官方的 VSCode 插件

安装

CDN

varlet.js 包含组件库的所有样式和逻辑，引入即可。

<div id="app"></div>
<script src="https://cdn.jsdelivr.net/npm/vue"></script>
 <!-- 桌面端兼容 -->
<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>按钮</var-button>'
  })
  app.use(Varlet).mount('#app')
</script>

Webpack / Vite

# 通过 npm 或 yarn 或 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 对组件进行在线编辑。

贡献

请参考 Contributing Guide。

在 Cloud IDE 中进行在线开发和调试

在 Cloud IDE 对源码进行在线调试。

反馈和交流

我们推荐使用issue列表进行最直接有效的反馈，也可以下面的方式

• 微信

• 加入 Discord 社区交流

感谢贡献者们做出的努力