tiny-vue/README.zh-CN.md

1.8 KiB
Raw Blame History

OpenTiny Logo

一套跨端、跨框架的企业级 UI 组件库,支持 Vue 2 和 Vue 3支持 PC 端和移动端。

English | 简体中文

🌈 特性:

  • 📦 包含 69 个简洁、易用、功能强大的组件
  • 🖖 一套代码同时支持 Vue 2 和 Vue 3
  • 🖥️ 一套代码同时支持 PC 端和移动端
  • 🌍 支持国际化
  • 🎨 支持主题定制
  • 📊 组件内部支持配置式开发,可支持低代码平台可视化组件配置
  • 💡 采用模板、样式、逻辑分离的跨端、跨框架架构,保障灵活性和可移植性

🛠️ 如何使用

1. 安装

执行以下命令,安装 Vue 3 版本的 TinyVue 组件库:

npm i @opentiny/vue@3

执行以下命令,安装 Vue 2 版本的 TinyVue 组件库:

npm i @opentiny/vue@2

2. 引入和使用

App.vue文件中使用 TinyVue 组件。

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

<template>
  <tiny-button>TinyVue</tiny-button>
</template>

🖥️ 本地开发

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

# 启动 Vue3 项目
pnpm dev

# 启动 Vue2 项目
pnpm dev:vue2

打开浏览器访问:http://127.0.0.1:6175/

🤝 参与贡献

如果你对我们的开源项目感兴趣,欢迎加入我们!🎉

参与贡献之前请先阅读贡献指南

开源协议

MIT