vue-amazing-ui 2.3.0 → 2.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  <h1 align="center">Vue Amazing UI</h1>
8
8
  <p align="center">A Vue 3 Component Library</p>
9
- <p align="center">Uses TypeScript, All components are single-file components (SFC), Supports tree shaking.</p>
9
+ <p align="center">Theme Customizable, Fully using TypeScript and SFC, Supports tree shaking.</p>
10
10
  <p align="center">Kinda Interesting</p>
11
11
  <p align="center">English | <a href="README.zh-CN.md">中文</a></p>
12
12
 
@@ -19,8 +19,9 @@
19
19
  - The component library is implemented with `Vue@3.5.13`+ `TypeScript@5.8.2` + `Vite@6.2.1` + `Less@4.2.2`.
20
20
  - Currently, it includes `66` basic UI components and `17` utility functions, with continuous exploration and updates ongoing...
21
21
  - What's more, they are all treeshakable.
22
+ - Theme Customizable, all you need is to provide a theme color, then all the stuffs will be done by me.
22
23
  - All the stuff in Vue Amazing UI is written in TypeScript. It can work with your typescript project seamlessly.
23
- - All components are built in single file component `SFC` style and can be used independently.
24
+ - All components are built in single file component `SFC` and can be used independently.
24
25
  - Ready to use out of the box, no fuss.
25
26
 
26
27
  ## Installation
@@ -84,7 +85,7 @@ import 'vue-amazing-ui/es/tag/Tag.css'
84
85
  </template>
85
86
  ```
86
87
 
87
- **Both Global Partial Registration and Local Registration require manually importing the global default styles of the component library (Automatic On-Demand Import is recommended).**
88
+ **Both Global Partial Registration and Local Registration require manually importing the global default styles of the component library ([Automatic On-Demand Import](https://themusecatcher.github.io/vue-amazing-ui/guide/ondemand.html#%E8%87%AA%E5%8A%A8%E6%8C%89%E9%9C%80%E5%BC%95%E5%85%A5-%E5%BC%BA%E7%83%88%E6%8E%A8%E8%8D%90) is recommended).**
88
89
 
89
90
  ```ts
90
91
  import { createApp } from 'vue'
@@ -285,4 +286,4 @@ useFps | Function to monitor the browser's refresh rate (FPS) in real time | ()
285
286
  useMediaQuery | Function to determine if the current environment matches a specified media query condition | (mediaQuery: string) => object
286
287
  useResizeObserver | Function to observe changes in the dimensions of DOM elements using `ResizeObserver` | (target: Ref &#124; Ref[] &#124; HTMLElement &#124; HTMLElement[], callback: ResizeObserverCallback, options = {}) => object
287
288
  useSlotsExist | Function to watch for the existence of slots with given names, supporting single slots or an array of slots | (slotsName: string &#124; string[] = 'default') => Reactive &#124; Ref\<boolean>
288
- useInject | 使用依赖注入的函数,用于获取颜色调色板和阴影颜色 | (key: string) => { colorPalettes: Ref<string[]>; shadowColor: Ref<string> }
289
+ useInject | A function that uses injection to obtain color palettes and shadow color | (key: string) => { colorPalettes: Ref<string[]>; shadowColor: Ref<string> }
package/README.zh-CN.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  <h1 align="center">Vue Amazing UI</h1>
8
8
  <p align="center">一个 Vue 3 组件库</p>
9
- <p align="center">使用 TypeScript,都是单文件组件 (SFC),支持 tree shaking</p>
9
+ <p align="center">主题可调,全量使用 TypeScript SFC,支持 tree shaking</p>
10
10
  <p align="center">有点意思</p>
11
11
  <p align="center"><a href="README.md">English</a> | 中文</p>
12
12
 
@@ -19,8 +19,9 @@
19
19
  - 组件库采用 `Vue@3.5.13`+ `TypeScript@5.8.2` + `Vite@6.2.1` + `Less@4.2.2` 实现
20
20
  - 目前共包含 `66` 个基础 `UI` 组件以及 `17` 个工具函数,并且持续探索更新中...
21
21
  - 顺便一提,它们全都可以 `treeshaking`
22
+ - 主题可调,你只需提供一个主题色,剩下的都交给我
22
23
  - `Vue Amazing UI` 全量使用 `TypeScript` 编写,和你的 `TypeScript` 项目无缝衔接
23
- - 全部组件均采用单文件组件 `SFC` 风格,可独立使用
24
+ - 全部组件均采用单文件组件 `SFC`,可独立使用
24
25
  - 开箱即用,不墨迹
25
26
 
26
27
  ## 安装
@@ -84,7 +85,7 @@ import 'vue-amazing-ui/es/tag/Tag.css'
84
85
  </template>
85
86
  ```
86
87
 
87
- **全局部分注册和局部注册组件,都需手动引入组件库全局默认样式(推荐使用自动按需引入)**
88
+ **全局部分注册和局部注册组件,都需手动引入组件库全局默认样式(推荐使用[自动按需引入](https://themusecatcher.github.io/vue-amazing-ui/guide/ondemand.html#%E8%87%AA%E5%8A%A8%E6%8C%89%E9%9C%80%E5%BC%95%E5%85%A5-%E5%BC%BA%E7%83%88%E6%8E%A8%E8%8D%90))**
88
89
 
89
90
  ```ts
90
91
  import { createApp } from 'vue'
@@ -285,4 +286,4 @@ useFps | 实时监测浏览器刷新率FPS | () => object
285
286
  useMediaQuery | 使用媒体查询来判断当前环境是否符合指定的媒体查询条件 | (mediaQuery: string) => object
286
287
  useResizeObserver | 使用 `ResizeObserver` 观察 `DOM` 元素尺寸变化 | (target: Ref &#124; Ref[] &#124; HTMLElement &#124; HTMLElement[], callback: ResizeObserverCallback, options = {}) => object
287
288
  useSlotsExist | 监听给定名称或名称数组的插槽是否存在,支持监听单个插槽或一组插槽的存在 | (slotsName: string &#124; string[] = 'default') => Reactive &#124; Ref\<boolean>
288
- useInject | A function that uses injection to obtain color palettes and shadow color | (key: string) => { colorPalettes: Ref<string[]>; shadowColor: Ref<string> }
289
+ useInject | 使用依赖注入的函数,用于获取颜色调色板和阴影颜色 | (key: string) => { colorPalettes: Ref<string[]>; shadowColor: Ref<string> }