# chyi-ui

**Repository Path**: zhiling91/chyi-ui

## Basic Information

- **Project Name**: chyi-ui
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-06-18
- **Last Updated**: 2024-06-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# chyi-ui

## Document & Online preview

[Chyi UI](https://themusecatcher.github.io/chyi-ui/)

## Install & Use

```bash
pnpm i chyi-ui
# or
npm install chyi-ui
# or
yarn add chyi-ui
```

Import and register component

**Global**

```ts
import { createApp } from 'vue'
import App from './App.vue'

import ChyiUI from 'chyi-ui'
import 'chyi-ui/css'

const app = createApp(App)
app.use(ChyiUI)
```

**Local**

```vue
<script setup lang="ts">
import { Button } from 'chyi-ui'
import 'chyi-ui/css'
</script>
```

## Project

- Install dependencies

```sh
cd chyi-ui

pnpm i
```

- Run project

```sh
pnpm dev
```

## Components

| Component name | Descriptions | Component name | Descriptions |
| :------------- | :----------- | :------------- | :----------- |
| Breadcrumb     | 面包屑       | Button         | 按钮         |
| Carousel       | 走马灯       | Cascader       | 级联选择     |
| Checkbox       | 多选框       | Collapse       | 折叠面板     |
| Countdown      | 倒计时       | DatePicker     | 日期选择     |
| Dialog         | 对话框       | Divider        | 分割线       |
| Empty          | 空状态       | Image          | 图片         |
| InputNumber    | 数字输入框   | Message        | 全局提示     |
| Modal          | 信息提示     | Notification   | 通知提醒框   |
| Pagination     | 分页器       | Progress       | 进度条       |
| QRCode         | 二维码       | Radio          | 单选框       |
| Rate           | 评分         | Select         | 选择器       |
| Slider         | 滑动输入条   | Spin           | 加载中       |
| Steps          | 步骤条       | Swiper         | 触摸滑动插件 |
| Switch         | 开关         | Table          | 表格         |
| Tabs           | 标签页       | TextScroll     | 文字滚动     |
| Timeline       | 时间轴       | Tooltip        | 文字提示     |
| Upload         | 上传         | Video          | 播放器       |
| Waterfall      | 瀑布流       |

## Details

[My CSDN Blogs](https://blog.csdn.net/Dandrose)

## Functions

| Function name         | Descriptions                                                                        | Arguments                                                                           |
| :-------------------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------- |
| dateFormat            | 简单易用的日期格式化函数！                                                          | (timestamp: number&#124;string&#124;Date, format = 'YYYY-MM-DD HH:mm:ss') => string |
| requestAnimationFrame | 针对不同浏览器进行兼容处理！                                                        | 使用方式不变                                                                        |
| cancelAnimationFrame  | 针对不同浏览器进行兼容处理！                                                        | 使用方式不变                                                                        |
| rafTimeout            | 使用 requestAnimationFrame 实现的定时器函数，等效替代 (setTimeout 和 setInterval)！ | (func: Function, delay = 0, interval = false) => object                             |
| cancelRaf             | 用于取消 rafTimeout 函数！                                                          | (raf: { id: number }) => void                                                       |
| throttle              | 使用 rafTimeout 实现的节流函数！                                                    | (fn: Function, delay = 300) => any                                                  |
| debounce              | 使用 rafTimeout 实现的防抖函数！                                                    | (fn: Function, delay = 300) => any                                                  |
| add                   | 消除js加减精度问题的加法函数！                                                      | (num1: number, num2: number) => number                                              |
| downloadFile          | 下载文件并自定义文件名！                                                            | (url: string, name: string) => void                                                 |