README.md

Vue DevUI

Vue3 component library based on DevUI Design

English | 简体中文

🌈 Features：

• 📦 55 high-quality components that are simple, easy to use, and flexible.
• 🔑 Support for TypeScript.
• ⛰️ Support for Nuxt3.
• ⚡ Support for on-demand import.
• 🌍 Support internationalization.
• 🎨 Support theme customization, and built-in seven beautiful themes such as Galaxy, Sweet and Provence.

🔧 Usage

First install vue-devui with npm, yarn or pnpm.

Install with npm

npm install vue-devui --save

Install with yarn

yarn add vue-devui

Install with pnpm

pnpm add vue-devui

Then import DevUI in the main.ts file:

import { createApp } from 'vue';
import App from './App.vue';

// Import Vue DevUI component and style
import DevUI from 'vue-devui';
import 'vue-devui/style.css';

createApp(App).use(DevUI).mount('#app');

Then you can use the vue devui component(such as <d-button>) in the App.vue file:

<template>
  <d-button>Button</d-button>
</template>

🖥️ Development

git clone [email protected]:DevCloudFE/vue-devui.git
cd vue-devui
pnpm install
pnpm dev

Open your browser and visit: http://localhost:3000/.

Or you can run other command

pnpm scripts

🤝 Contributing

Welcome to join our Vue DevUI open source project!🎉

By participating in the Vue DevUI project, we can together:

• 🔥 Learn the latest cool Vite + Vue3 + TypeScript + JSX technology.
• 🎁 Learn how to design and develop UI components.
• ⭐ Hone programming skills and learn excellent programming practice.
• 🎊 Meet a group of friends who love learning and open source.

If you don't know how to start, please read our contributing guide

✨ Maintainers

Maintainers are community members who have made outstanding contributions and have been active in the DevUI community for a long time.

• kagol
• xingyan95
• linxiang07
• Zcating
• TinsFox
• JensonMiao
• xiejay97
• daviForevel
• AlanLee97
• SituC
• lj1990111
• newer2333
• vaebe
• ivestszheng
• ElsaOOo
• asdlml6
• GaoNeng-wWw
• chenxi24
• ErKeLost
• brenner8023

Outstanding contributions include, but are not limited to, the following:

• 10 or more PRs are merged
• Put forward more than 10 review opinions approved by PR authors
• Provide constructive optimization advice and promote the project to become better

✨ Contributors

Contributors are community members who have 1 or more PR merged in DevUI.

Thanks goes to these wonderful people (emoji key):

Kagol 🚧 💻 📖	TinsFox 🚧 🚇	nif 💻	Zcating 🚧 💻	王凯 💻	iel 🚧 💻	chenxi24 💻	小九九 💻
AlanLee 💻	Echo 💻	GaoNeng 💻	行言 💻 🐛	devin 💻	无声 💻	sleep_fish 💻	迷心whylost 💻
X.Q. Chen 🚇 💻	葉家男孩 💻	lihai 💻	纳撸多 💻	ElsaOOo 🚧 🚇 💻	刘小迪 💻	unfound 💻	Roading 💻
Chestnut 💻	c0dedance 💻	杜庆愉 💻	linxiang 💻	掘墓忍者 💻	一个大胖子 💻 📖	Ikko Ashimine 📖	Bob 💻
populus 💻	tohalf 💻	Miliky 💻 ⚠️	MICD 💻 🐛	mingBin 💻 🐛	陈剑术 💻	Merlin218 🐛	Johnny.Liu 🐛
Yangxfeng 🐛	jCodeLife 🐛	宋小日 🐛	daviForevel 💻	lj1990111 💻	newer2333 💻	哈士奇-黄 💻	寻 💻
Anthonio OuYang 💻	FlingYP 💻	xzxldl55 💻	79 💻	wailen 💻	jenson 💻	dbsdaicheng ⚠️	qinwencheng 💻
Angelanana 💻	joo1es 💻	handsomezyw 💻	Yoki 💻	luopei 💻	Mr.Cheng 💻	Bbbtt04 💻	Zz-ZzzZ 💻
buaalkn 💻	hxj9102 💻	Whbbit1999 💻	zhaoShijuan 💻	XiaoRIGE 💻	xiaogonggong-w 💻	hqchqc 💻	Lucky-Ya-Q 💻
xGuangsPBD 💻	cnvoid 💻	sakanaovo 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Partner project

• H5-Dooring - 让 H5 制作，更简单
• 灯塔 - 公益性质的反霸凌团队

License

MIT