# tmui design
**Repository Path**: zzcjmxj_admin/tmui-design
## Basic Information
- **Project Name**: tmui design
- **Description**: tmui.design 基于UNIAPP的VUE3 TypeScript的跨端组件,
分支:3.1.x支持nvue原生渲染,H5,小程序,安卓,IOS等全端组件库
主分支:3.2专注uniapp
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: https://tmui.design
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 192
- **Created**: 2025-10-01
- **Last Updated**: 2025-10-01
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
```markdown
# TMUI 4.0 - 一套基于 Vue 的跨平台 UI 组件库
TMUI 是一个基于 Vue.js 的跨平台 UI 组件库,专为 UniApp 和其他 Vue 项目设计,提供丰富的组件和工具,帮助开发者快速构建美观、高效的用户界面。
## 📦 特性
- **跨平台支持**:支持 H5、小程序、App 等多端运行。
- **组件丰富**:提供按钮、表单、弹窗、导航、图表等常用 UI 组件。
- **主题定制**:支持 SCSS 变量定制主题,轻松实现个性化样式。
- **国际化支持**:内置多语言支持,方便构建全球化应用。
- **响应式布局**:基于 Flex 和 Grid 的布局系统,适配各种屏幕尺寸。
- **高性能**:轻量级设计,优化渲染性能,减少资源占用。
## 📁 项目结构概览
- **components/** - 各类 UI 组件(按钮、输入框、弹窗等)。
- **css/** - 提供丰富的 CSS 工具类,支持快速布局和样式定制。
- **local/** - 国际化语言包及 i18n 实现。
- **libs/** - 工具类库,如请求封装、日期处理、颜色转换等。
- **static/** - 静态资源,如地区编码数据等。
- **interface.ts** - 类型定义文件,提供类型安全支持。
- **index.ts** - 入口文件,用于注册组件和初始化配置。
## 🚀 快速开始
### 安装
1. 使用 npm 或 yarn 安装 TMUI:
```bash
npm install tm-ui
# 或
yarn add tm-ui
```
2. 在你的 Vue 项目中引入 TMUI:
```javascript
import TMUI from 'tm-ui'
import 'tm-ui/css/tmui.css'
app.use(TMUI)
```
### 使用组件
在你的 `.vue` 文件中直接使用 TMUI 组件:
```vue
点击我
```
## 🌐 国际化支持
TMUI 提供了完整的 i18n 支持,支持动态切换语言和多语言管理。
### 设置语言
```javascript
import { setLocale } from 'tm-ui/local/i18n'
setLocale('zh-Hans') // 设置为简体中文
```
### 添加语言包
将语言文件放置在 `local/localLanuage/` 目录下,例如 `zh-Hans.json`、`en.json` 等。
## 🎨 主题定制
通过 SCSS 变量实现主题定制,修改 `css/tmui.scss` 文件中的变量即可全局生效。
```scss
$primary-color: #007AFF;
$success-color: #4CAF50;
```
## 📚 文档与示例
详细文档和组件示例请参考:[TMUI 官方文档](https://tmui.design)
## 🧪 工具库
TMUI 提供了多个实用工具类:
- **Axios 请求封装**:支持缓存、拦截器、请求配置等。
- **日期处理**:提供常用日期格式化和计算方法。
- **颜色转换**:支持 RGB、HSL、HEX 等颜色格式转换。
- **路由守卫**:提供页面路由的前置和后置钩子。
## 🧰 开发工具支持
- 支持 TypeScript 类型定义。
- 提供 VitePress 文档站点模板,方便构建组件文档。
- 支持 CLI 工具快速生成组件和配置。
## 📜 开源协议
本项目基于 [MIT License](https://opensource.org/licenses/MIT) 开源,可自由用于商业用途。
## 🤝 贡献与支持
欢迎提交 Issue 和 Pull Request,帮助我们改进项目。如果你喜欢这个项目,欢迎 Star 和赞助,以支持持续更新。
## 📱 示例截图

## 📚 更多文档
- [TMUI 官方文档](https://tmui.design)
- [组件文档](tmuidocs/doc/index.md)
- [国际化使用指南](tmuidocs/doc/local/i18n.md)
- [主题定制指南](tmuidocs/doc/advanced/theme.md)
## 📦 打包与发布
使用 `npm run build` 构建生产版本,发布到 npm 或私有仓库。
## 📝 贡献者
感谢所有贡献者,你们的支持让 TMUI 更加完善。
## 💬 技术支持
如有问题,请提交 Issue 或加入我们的社区讨论。
---
**版本更新日志**:请查看 `src/uni_modules/tm-ui/changelog.md`
**项目主页**:[https://tmui.design](https://tmui.design)
**开源协议**:MIT
**作者**:TMZDY
```