Skip to content

Latest commit

 

History

History
94 lines (76 loc) · 2.73 KB

README.zh-CN.md

File metadata and controls

94 lines (76 loc) · 2.73 KB
Raw

VARLET-VUE2

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

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

version ci vue licence coverage gzip ci

介绍

Varlet-vue2 是 Varlet 的 vue2 版本, 是一个 Material 风格移动端组件库，由社区建立起来的组件库团队进行维护。

特性

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

安装

CDN

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

<div id="app"></div>
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
<script src="https://cdn.jsdelivr.net/npm/@varlet-vue2/ui/umd/varlet.js"></script>
<script>
  Vue.use(Varlet)

  new Vue({
    template: '<var-button>按钮</var-button>'
  }).$mount('#app')
</script>

Webpack / Vite

# 通过 npm 或 yarn 或 pnpm 安装
# npm
npm i @varlet-vue2/ui -S

# yarn
yarn add @varlet-vue2/ui

# pnpm
pnpm add @varlet-vue2/ui
import App from './App.vue'
import Varlet from '@varlet-vue2/ui'
import Vue from 'vue'
import '@varlet-vue2/ui/es/style.js'

Vue.use(Varlet)

new Vue({
  render: (h) => h(App)
}).$mount('#app')

贡献者

仓库状态

本仓库不再进行特性更新，只做 bug 修复，推荐使用 Varlet Vue3 版本