Skip to content

Latest commit

 

History

History
98 lines (77 loc) · 2.98 KB

README.md

File metadata and controls

98 lines (77 loc) · 2.98 KB
Raw

VARLET-VUE2

Material design mobile component library for Vue2

Documentation(Vercel) | Documentation(Gitee) | 中文README

version ci vue licence coverage gzip ci

Intro

Varlet-vue2 is a Material design mobile component library developed based on Vue2, developed and maintained by partners in the community.

Features

  • 🚀 Provide 50 high quality general purpose components
  • 🚀 Components are very lightweight
  • 💪 Developed by Chinese, complete Chinese and English documentation and logistics support
  • 🛠️ Support on-demand introduction
  • 🛠️ Support theme customization
  • 🌍 Support internationalization
  • 💡 Support WebStorm, VS Code component syntax highlighting
  • 💪 Support the SSR
  • 💡 Support the Typescript
  • 💪 Make sure more than 90 percent unit test coverage, providing stability assurance
  • 🛠️ Support dark mode

Install

CDN

varlet.js component functions have been completed, and unit testing is in progress, recommended for internal testing

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

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

Webpack / Vite

# Install with npm or yarn or 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')

Contributors

Repo Status

This repo will no longer perform feature updates, only bug fixes, It is recommended to use Varlet Vue3 version