forked from opentiny/tiny-vue
42cd6d084d
* docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Kagol <kagol@sina.com> |
||
|---|---|---|
| .cid | ||
| .codecheck | ||
| .github | ||
| .husky | ||
| .vscode | ||
| examples | ||
| internals | ||
| linting | ||
| packages | ||
| patches | ||
| .all-contributorsrc | ||
| .depcheckrc.yaml | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| .hintrc | ||
| .npmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| CONTRIBUTING.zh-CN.md | ||
| LICENSE | ||
| README.md | ||
| README.zh-CN.md | ||
| build.sh | ||
| commitlint.config.js | ||
| jsconfig.json | ||
| lerna.json | ||
| logo.svg | ||
| package.json | ||
| pnpm-workspace.yaml | ||
| tsconfig.json | ||
| tsconfig.vue2.7.json | ||
| tsconfig.vue2.json | ||
| tsconfig.vue3.json | ||
| volar.config.js | ||
README.md
An enterprise-class UI component library, support both Vue.js 2 and Vue.js 3, as well as PC and mobile.
English | 简体中文
🌈 Features:
- 📦 69 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 dev:vue2
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-officialand 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 💻 |