T-ui-plus 开源项目教程

项目介绍

T-ui-plus 是一个基于 Vue3、TypeScript 和 Element-plus 二次封装的基础组件库。该项目旨在提供一套易于使用和高度定制的 UI 组件，以加速 Vue3 项目的开发。通过 T-ui-plus，开发者可以享受到 Vue3 + Vite3 的开发体验，并在 Markdown 中使用 Vue 组件。

项目快速启动

安装

首先，确保你已经安装了 Node.js 和 npm（或 pnpm）。然后，通过以下命令安装 T-ui-plus：

pnpm i @wocwin/t-ui-plus

全局注册

在你的 Vue 项目中，全局注册 Element-plus 和 T-ui-plus 组件库：

// main.js
import { createApp } from 'vue';
import App from './App.vue';
import ElementPlus from 'element-plus';
import 'element-plus/dist/index.css';
import 'element-plus/theme-chalk/dark/css-vars.css';
import locale from 'element-plus/es/locale/lang/zh-cn';
import * as ElementPlusIconsVue from '@element-plus/icons-vue';
import TuiPlus from '@wocwin/t-ui-plus';
import '@wocwin/t-ui-plus/lib/style.css';

const app = createApp(App);

// 注册所有图标
for (const [key, component] of Object.entries(ElementPlusIconsVue)) {
  app.component(key, component);
}

// 注册 ElementPlus
app.use(ElementPlus, { locale });
app.use(TuiPlus);
app.mount('#app');

按需引入

你也可以按需引入组件：

// 在 main.js 中引入样式
import '@wocwin/t-ui-plus/lib/style.css';

// 单个 Vue 文件引入
<script setup lang="ts">
import { TDetail, TForm } from '@wocwin/t-ui-plus';
</script>

应用案例和最佳实践

布局页面

使用 TLayoutPage 和 TLayoutPageItem 组件来创建复杂的布局页面：

<template>
  <TLayoutPage>
    <TLayoutPageItem>
      <!-- 内容 -->
    </TLayoutPageItem>
  </TLayoutPage>
</template>

<script setup lang="ts">
import { TLayoutPage, TLayoutPageItem } from '@wocwin/t-ui-plus';
</script>

表格和查询条件

结合 TQueryCondition 和 TTable 组件来实现数据查询和展示：

<template>
  <TQueryCondition @submit="handleQuery">
    <!-- 查询条件 -->
  </TQueryCondition>
  <TTable :data="tableData">
    <!-- 表格内容 -->
  </TTable>
</template>

<script setup lang="ts">
import { TQueryCondition, TTable } from '@wocwin/t-ui-plus';
</script>

典型生态项目

T-ui-plus 可以与以下生态项目结合使用，以增强功能和性能：

1. Vite: 用于构建快速开发服务器和生产环境打包。
2. Element-plus: 提供基础的 UI 组件。
3. TypeScript: 增强代码的类型安全性和可维护性。
4. Vue Router: 用于管理应用的路由。
5. Pinia: 官方推荐的 Vue 状态管理库。

通过结合这些生态项目，你可以构建出功能丰富、性能优越的 Vue3 应用。