@techui/admin/README.md

TechUI Admin is an easy-to-use workbench component library developed based on Vue, with built-in dynamic routing, dynamic menu and TechUI Base component library.

# @techui/admin

[English](#english) | [中文](#中文)

---

## English

### Introduction

**TechUI Admin** is a modern, easy-to-use workbench component library built on Vue 3. It provides a complete solution for developing dashboards and admin panels with minimal configuration.

### Features

- 🚀 **Dynamic Routing** - Automatically generated routes based on configuration
- 📱 **Dynamic Menu** - Smart navigation menu system
- 🔐 **Built-in Login Page** - Ready-to-use authentication interface
- 📂 **Collapsible Sidebar** - Flexible sidebar navigation with collapse functionality
- 🏷️ **Route-based Tabs** - Automatic tab management based on visited routes
- 🎨 **Theme Switching** - Multiple theme support with easy toggling
- 🌍 **i18n Support** - Built-in internationalization
- 🔔 **Audio Alerts** - Notification sound system
- 🎯 **Common Icons** - Pre-integrated icon library
- 💾 **TechUI State Management** - Efficient state management solution
- 🛠️ **Workbench Utilities** - Rich set of built-in helper methods

### Included Libraries

- **@techui/base** - Base component library providing fundamental UI components

> **Note:** @techui/base is currently growing and cannot fully replace comprehensive libraries like ElementPlus. The component count is being gradually increased.

### 🎯 TuiAdaptive - Revolutionary Responsive Component

The library includes **TuiAdaptive**, an incredibly powerful adaptive component that solves responsive design challenges once and for all using proportional scaling.

**Key Features:**

- Multiple adaptation modes for different scenarios
- **Drag Mode** - Activate via browser zoom functionality
- **Coordinate Sync Container** - Special solution for third-party map/GIS components (Cesium, etc.)
  - Prevents coordinate inaccuracy issues when GIS components are placed inside scaled containers
  - Uses a synchronized pass-through container to maintain accurate click coordinates

> **Proudly the best adaptive/responsive component available on the market today!**

### Dependencies

- **@techui/colors** - Color system
- **@techui/lessmixins** - LESS mixins
- **@techui/locales** - Localization files
- **@techui/themes** - Theme system
- **@techui/libs** - Utility libraries
- **@techui/utils** - Utility functions
- **vue** ^3.4.27
- **vue-router** ^4.3.2

### Author

- **aYin**
- Email: <ayin86cn@gmail.com>
- WeChat: jay1986cn

### Homepage

<https://techui.net>

### License

UNLICENSED

---

## 中文

### 简介

**TechUI Admin** 是一个基于 Vue 3 开发的现代化、易用的工作台组件库。它为开发 Dashboard 和管理面板提供了完整的开箱即用解决方案。

### 核心特性

- 🚀 **动态路由** - 基于配置自动生成路由
- 📱 **动态菜单** - 智能导航菜单系统
- 🔐 **内置登录页** - 开箱即用的身份验证界面
- 📂 **可折叠侧边栏** - 灵活的侧边导航,支持折叠功能
- 🏷️ **路由标签页** - 根据访问路由自动管理标签页
- 🎨 **主题切换** - 多主题支持,轻松切换
- 🌍 **国际化支持** - 内置 i18n 多语言方案
- 🔔 **音频提醒** - 通知音效系统
- 🎯 **常用图标** - 预集成图标库
- 💾 **TechUI 状态管理** - 高效的状态管理解决方案
- 🛠️ **工作台工具** - 丰富的内置辅助方法

### 包含的组件库

- **@techui/base** - 基础组件库,提供底层 UI 组件支撑

> **注意:** @techui/base 目前仍在发展中,暂时无法完全替代 ElementPlus 等成熟组件库。组件数量将逐步增加。

### 🎯 TuiAdaptive - 革命性的自适应组件

库中包含功能强大的 **TuiAdaptive** 适配组件，采用等比缩放方式，让开发者一劳永逸地解决自适应问题。

**核心功能:**

- 多种适配模式，适应不同场景
- **拖拽模式** - 可通过浏览器缩放功能激活
- **同步穿透容器** - 专为第三方地图/GIS组件设计（Cesium等）
  - 解决 GIS 组件放置在缩放容器内部时点击坐标不准确的问题
  - 通过同步穿透容器保持准确的点击坐标

> **可以自豪地说，它是现在市面上最好用的自适应/适配组件！**

### 依赖项

- **@techui/colors** - 色彩系统
- **@techui/lessmixins** - LESS 混合样式
- **@techui/locales** - 本地化文件
- **@techui/themes** - 主题系统
- **@techui/libs** - 工具库
- **@techui/utils** - 工具函数
- **vue** ^3.4.27
- **vue-router** ^4.3.2

### 作者

- **aYin**
- 邮箱: <ayin86cn@gmail.com>
- 微信: jay1986cn

### 官网

<https://techui.net>

### 许可证

UNLICENSED

---

## Keywords

`@techui` `techui` `TechUI` `ayin` `@techui/prime` `@techui/admin` `@techui/base` `@techui/scifi` `TechUI Prime` `TechUI Admin` `TechUI Base` `TechUI Scifi` `techui-prime` `techui-admin` `techui-base` `techui-scifi` `Dashboard` `Workbench` `Admin Panel` `Workspace` `Portal`