VARLET

Material design mobile component library for Vue3

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

Intro

Varlet is a Material design mobile component library developed based on Vue3, developed and maintained by varletjs community team.

Features

🚀 Provide 60+ 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 syntax highlighting
💪 Support the SSR
💡 Support the Typescript
💪 Make sure more than 90 percent unit test coverage, providing stability assurance
🛠️ Supports both Material Design 2 and Material Design 3 design systems
🛠️ Support dark mode
🛠️ Provide official VSCode extension

Install

CDN

varlet.js contain all the styles and logic of the component library, and you can import them.

<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')

Official Ecosystem

The following projects are maintained by the official team for a long time.

Name	Description
@varlet/cli	`Vue3 component library rapid prototyping tool`
@varlet/touch-emulator	`Desktop adapter, so that the mobile component library can run on the desktop`
@varlet/ui-playground	`Varlet component library online editing tool`
@varlet/import-resolver	`A resolver for` unplugin-vue-components `used to implement Varlet and import it on demand`
varlet-vscode-extension	`Varlet Component Library VSCode Plugin`
vscode-theme-varlet	`Varlet VSCode Theme`
varlet-app-example	`Varlet component library app template`
varlet-install-example	`Case collection of Varlet component library and various ecosystem integration`

Community Ecosystem

The following projects are maintained by community personnel, welcome to add.

Name	Description
vue-h5-template	`Vue-based mobile template scaffolding, providing mobile presets for Varlet component library`
create-vite-app	`A desktop template scaffolding based on Vue3, providing desktop presets for Varlet component library`
vscode-common-intellisense	`A VS Code extension that provides better intellisense to Varlet developers`