tiny-vue/README.md at dev

26 KiB

Raw Permalink Blame History

An enterprise-class UI component library, support both Vue.js 2 and Vue.js 3, as well as PC and mobile.

🌈 Features:

📦 104 clean, easy-to-use and powerful components.
🖖 One code, Support both Vue.js 2 and Vue.js 3.
🖥️ One code, Support both PC and Mobile.
🌍 Support internationalization.
🎨 Support theme customization.
📊 Components support configuration development, can support low-code platform.
💡 Use a cross-end and cross-framework architecture, flexible and portable.

🛠️ Usage

1. Installation

Execute the following command to install the TinyVue component library for Vue.js 3.

npm i @opentiny/vue@3

Execute the following command to install the TinyVue component library for Vue.js 2.

npm i @opentiny/vue@2

2. Import component

Then you can use the TinyVue component(such as <tiny-button>) in the App.vue file.

<script lang="ts" setup>
  import { Button as TinyButton } from '@opentiny/vue'
</script>

<template>
  <tiny-button>Tiny Vue</tiny-button>
</template>

🖥️ Development

git clone git@github.com:opentiny/tiny-vue.git
cd tiny-vue
pnpm i

# Vue.js 3
pnpm dev

# Vue.js 2
pnpm dev2

Open your browser and visit: http://127.0.0.1:7130/

🤝 Contributing

Welcome to join our OpenTiny community!🎉

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

Add the official assistant WeChat opentiny-official and join the technical exchange group.
Add to the mailing list opentiny@googlegroups.com

✨ Contributors

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

Thanks goes to these wonderful people (emoji key):

_Kagol 💻	_ajaxzheng 💻	_TC-twwang 💻	_jacknan 💻	_Pithy 💻	_heygsc 💻	_MangoWu 💻	_ADNY 💻
_chenxi-20 💻	_Alaray 💻	_ing 💻	_申君健 💻	_MomoPoppy 💻	_WXC-Spring 💻	_GaoNeng 💻	_acyza 💻
_ygj6 💻	_MrWang2016 💻	_qinwencheng 💻	_黄怡林 💻	_zuixinwang 💻	_luopei 💻	_前端爆冲 🚇	_{Xie Jay} 🚇
_linxiang 💻	_{程序员包子} 💻	_{peter G} 💻 📖	_gimmyhehe 💻	_dong 💻	_凌览 💻	_Caesar-ch 💻	_chenqifeng66 ⚠️
_Zz-ZzzZ ⚠️	_Lyx 💻	_{Spark Bill} 💻	_wendZzoo 💻	_{Gweesin Chan} 💻	_{Binks_} 📖	_yoyo 💻	_Kif 💻
_jack-zishan 💻	_LinboLen 💻	_vaebe 💻	_{YuYan Li} 💻	_shonen7 💻	_xlearns 💻	_tianxin 💻	_Xppp0217 💻
_AcWrong02 🐛	_betavs 💻	_{fanbingbing16} 💻	_dyh333 📖	_{betterdancing} 📖	_David 💻	_falcon-jin 💻	_wuyiping0628 ⚠️
_James 📖	_ichynul 💻	_Davont 💻	_{Nick Wu} 💻	_Floyd 💻	_Jevin 💻	_星河 💻	_{Ranier Yu} 💻
_Zcating 💻	_{Aoi Kaze} ⚠️	_{Simon He} 📖	_zhangpaopao 🔧

❤️ Credits

Thanks to:

The element project which is an old component library based on Vue.js. TinyVue draws on Element at the beginning of its design, and is compatible with Element's component API.
The floating-ui project which is a small library that helps you create "floating" elements such as tooltips, popovers, dropdowns, and more. Many components of TinyVue are based on the capabilities provided by Floating UI.
The vxe-table project which is a Vue-based table component, supports rich features, TinyVue's Grid component is based on vxe-table.
The sortablejs project which is a powerful drag-and-drop library. The drag-and-drop sorting function of TinyVue's Grid / Transfer / Tabs and other components is based on Sortable.
@adamwathan's article Renderless Components in Vue.js, which inspired TinyVue's renderless component design architecture and ultimately enabled cross-end and cross-framework capabilities in the TinyVue project.

License

MIT

26 KiB Raw Permalink Blame History