Skip to content

Latest commit

 

History

History
164 lines (122 loc) · 7.24 KB

README.zh-CN.md

File metadata and controls

164 lines (122 loc) · 7.24 KB
Raw

VARLET

一个移动端组件库，基于 Vue3, Material Design 2, Material Design 3，并支持桌面端开发。

文档(Cloudflare) | 文档(Vercel) | 文档(Github) | ENGLISH README

version stars vue licence coverage ci

介绍

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

特性

  • 🚀   提供 60+ 个高质量通用组件
  • 🚀   组件十分轻量
  • 💪   由国人开发，完善的中英文文档和后勤保障
  • 🛠️   支持按需引入
  • 🛠️   支持主题定制
  • 🌍   支持国际化
  • 💡   支持 webstorm 组件属性高亮
  • 💪   支持 SSR
  • 📦   支持 Nuxt Module
  • 💡   支持 Typescript
  • 💪   确保 90% 以上单元测试覆盖率，提供稳定性保证
  • 🎨   同时支持 Material Design 2 和 Material Design 3 两套设计系统
  • 🛠️   支持暗黑模式
  • 🔧   提供官方的 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')

AI 文档助手

在 AI 文档助手 中可通过问询的方式获得 varlet 的更多信息, 感谢 qile AI 提供服务支持.

官方生态

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

名称 描述
@varlet/cli Vue3 组件库快速成型工具
@varlet/touch-emulator 桌面端适配器，让移动端组件库可以在桌面端运行
@varlet/ui-playground Varlet 组件库在线编辑工具
@varlet/import-resolver unplugin-vue-components 的一个解析器，用于实现 Varlet 按需引入
@varlet/preset-unocss varlet 的 UnoCss 预设
@varlet/preset-tailwindcss varlet 的 tailwindcss 预设
varlet-theme-builder 主题生成器，用于为 varlet material design 3 生成主题变量
varlet-vscode-extension Varlet 组件库 VSCode 插件
vscode-theme-varlet Varlet VSCode 主题
varlet-app-example Varlet 组件库移动端模板
varlet-install-example Varlet 组件库与各种生态集成的案例集合

社区生态

以下项目由社区人员维护，欢迎补充。

名称 描述
vue-h5-template 基于 Vue 的移动端模板脚手架，提供了 Varlet 组件库的移动端预设
create-vite-app 基于 Vue3 的桌面端模板脚手架，提供了 Varlet 组件库的桌面端预设
vscode-common-intellisense 为 Varlet 开发人员提供更好的智能感知的 VSCode 扩展
vue3-varlet-mobile 基于 Vue 3 和 Varlet 组件库的移动模板

演练场

在 Varlet UI Playground 对组件进行在线编辑。

贡献

请参考 Contributing Guide。

反馈和交流

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

  • 微信

感谢贡献者们做出的努力

感谢以下赞助者

赞助本项目

赞助本项目，支持我们更好的创作。推荐使用爱发电进行订阅，您的头像将出现在本项目中。

爱发电

https://afdian.net/a/haoziqaq

微信 / 支付宝