一个 Vue 3 组件库
主题可调，全量使用 TypeScript 和 SFC，支持 tree shaking
有点意思
English | 中文
## 文档 [Vue Amazing UI](https://themusecatcher.github.io/vue-amazing-ui/) ## 特性 - 组件库采用 `Vue@3.5.29`+ `TypeScript@5.9.3` + `Vite@7.3.1` + `Less@4.5.1` 实现 - 目前共包含 `68` 个基础 `UI` 组件以及 `23` 个工具函数，并且持续探索更新中... - 主题可调，你只需提供一个主题色，剩下的都交给我 - 顺便一提，它们全都可以 `treeshaking` - `Vue Amazing UI` 全量使用 `TypeScript` 编写，和你的 `TypeScript` 项目无缝衔接 - 全部组件均采用单文件组件 `SFC`，可独立使用 - 开箱即用，不墨迹 ## 安装 ```sh pnpm add vue-amazing-ui # or npm install vue-amazing-ui # or yarn add vue-amazing-ui # or bun add vue-amazing-ui ``` ## 使用组件 **全局完整注册（不推荐）** _失去 `tree-shaking` 的能力，打包后有冗余代码_ ```ts import { createApp } from 'vue' import App from './App.vue' import VueAmazingUI from 'vue-amazing-ui' import 'vue-amazing-ui/css' const app = createApp(App) app.use(VueAmazingUI) app.mount('#app') ``` **全局部分注册** _这种情况下，只有导入的组件才会被打包_ ```ts import { createApp } from 'vue' import App from './App.vue' import { Button, Tag } from 'vue-amazing-ui' import 'vue-amazing-ui/es/button/Button.css' import 'vue-amazing-ui/es/tag/Tag.css' const app = createApp(App) app.use(Button).use(Tag) app.mount('#app') ``` **局部注册组件** _这种情况下，也只有导入的组件才会被打包_ ```vue
## 组件
| 名称 | 说明 | 名称 | 说明 |
| :-------------- | :--------- | :------------- | :--------- |
| Alert | 警告提示 | AutoComplete | 自动完成 |
| Avatar | 头像 | BackTop | 回到顶部 |
| Badge | 徽标 | Breadcrumb | 面包屑 |
| Button | 按钮 | Calendar | 日历 |
| Card | 卡片 | Carousel | 轮播图 |
| Cascader | 级联选择 | Checkbox | 复选框 |
| Collapse | 折叠面板 | ColorPicker | 颜色选择器 |
| ConfigProvider | 全局化配置 | Countdown | 倒计时 |
| DatePicker | 日期选择器 | Descriptions | 描述列表 |
| Dialog | 对话框 | Divider | 分割线 |
| Drawer | 抽屉 | Ellipsis | 文本省略 |
| Empty | 空状态 | Flex | 弹性布局 |
| FloatButton | 浮动按钮 | GradientText | 渐变文字 |
| Grid | 栅格 | Highlight | 高亮文本 |
| Image | 图片 | Input | 输入框 |
| InputNumber | 数字输入框 | InputSearch | 搜索框 |
| List | 列表 | LoadingBar | 加载条 |
| Message | 全局提示 | Modal | 模态框 |
| Notification | 通知提醒 | NumberAnimation| 数值动画 |
| Pagination | 分页 | Popconfirm | 弹出确认 |
| Popover | 气泡卡片 | Progress | 进度条 |
| QRCode | 二维码 | Radio | 单选框 |
| Rate | 评分 | Result | 结果 |
| Scrollbar | 滚动条 | Segmented | 分段控制器 |
| Select | 选择器 | Skeleton | 骨架屏 |
| Slider | 滑动输入条 | Space | 间距 |
| Spin | 加载中 | Statistic | 统计数值 |
| Steps | 步骤条 | Swiper | 触摸滑动 |
| Switch | 开关 | Table | 表格 |
| Tabs | 标签页 | Tag | 标签 |
| Textarea | 文本域 | TextScroll | 文字滚动 |
| Timeline | 时间轴 | Tooltip | 文字提示 |
| Upload | 上传 | Video | 播放器 |
| Waterfall | 瀑布流 | Watermark | 水印 |
## 工具函数
| 名称 | 说明 | 类型 |
| :-- | :-- | :-- |
| dateFormat | 格式化日期时间字符串函数 | (value: number | string | Date = Date.now(), format: string = 'YYYY-MM-DD HH:mm:ss') => string |
| formatNumber | 数字格式化函数 | (value: number | string, precision: number = 2, separator: string = ',', decimal: string = '.', prefix?: string, suffix?: string) => string |
| rafTimeout | 使用 `requestAnimationFrame` 实现的延迟 `setTimeout` 或间隔 `setInterval` 调用函数 | (fn: Function, delay: number = 0, interval: boolean = false) => \{ id: number } |
| cancelRaf | 用于取消 `rafTimeout` 函数 | (raf: { id: number }) => void |
| throttle | 节流函数 | (fn: Function, delay: number = 300) => Function |
| debounce | 防抖函数 | (fn: Function, delay: number = 300) => Function |
| add | 消除 `js` 加减精度问题的加法函数 | (num1: number, num2: number) => number |
| downloadFile | 下载文件并自定义文件名，内置同源 `anchor` 与跨域 `iframe` 双下载策略，未传 `fileName` 时，从文件地址中自动提取文件名称 | (url: string, fileName?: string, options?: { target?: '_self' | '_blank'; strategy?: 'auto' | 'anchor' | 'iframe' }) => Promise<void> |
| toggleDark | 一键切换暗黑模式函数 | () => void |
| useEventListener | 使用 `Vue` 的生命周期钩子添加和移除事件监听器 | (target: HTMLElement | Window | Document, event: string, callback: Function) => void |
| useMutationObserver | 使用 `MutationObserver` 观察 `DOM` 元素的变化 | (target: Ref | Ref[] | HTMLElement | HTMLElement[], callback: MutationCallback, options: object = {}) => { start: \() => void, stop: \() => void } |
| useScroll | 实时监测目标元素滚动位置及状态 | (target: Ref | HTMLElement | Window | Document = window, throttleDelay: number = 0, onScroll?: (e: Event) => void, onStop?: (e: Event) => void) => { x: Ref\