---

Intro

Varlet is a Vue3 component library based on Material Design 2 and 3, supporting mobile and desktop, developed and maintained by varletjs organization.

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 Nuxt Module
• 💡   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
• ⌨️   Support Accessibility (still improving)

Install

CDN

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

1<div id="app"></div>
2<script src="https://cdn.jsdelivr.net/npm/vue"></script>
3 <!-- Desktop Adaptation -->
4<script src="https://cdn.jsdelivr.net/npm/@varlet/touch-emulator/iife.js"></script>
5<script src="https://cdn.jsdelivr.net/npm/@varlet/ui/umd/varlet.js"></script>
6<script>
7  const app = Vue.createApp({
8    template: '<var-button>Button</var-button>'
9  })
10  app.use(Varlet).mount('#app')
11</script>

Webpack / Vite

1# Install with npm or yarn or pnpm
2
3# npm
4npm i @varlet/ui -S
5
6# yarn
7yarn add @varlet/ui
8
9# pnpm
10pnpm add @varlet/ui

1import App from './App.vue'
2import Varlet from '@varlet/ui'
3import { createApp } from 'vue'
4import '@varlet/ui/es/style'
5
6createApp(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/preset-unocss	UnoCss presets for varlet
@varlet/preset-tailwindcss	tailwindcss presets for varlet
varlet-theme-builder	Theme generator for generating theme variables for varlet Material Design 3
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
vue3-varlet-mobile	A mobile template based on Vue 3 and Varlet Component Library

Playground

See Varlet UI Playground.

Contribution

See Contributing Guide.

GitCode Repo

See Here.

Community

We recommend that issue be used for problem feedback, or others:

• Wechat group

• Join the Discord

Thanks to contributors

Thanks to the following sponsors

Sponsor this project

Sponsor this project to support our better creation.

Wechat / Alipay