@wlydfe/pro-ui 0.2.19 → 0.2.21

package/docs/README.md

@@ -0,0 +1,9 @@
+# plus-pro-components docs
+
+## 本地开发命令的区别
+
+| 命令       | 作用                             | 备注                         |
+| ---------- | -------------------------------- | ---------------------------- |
+| pnpm dev   | 预览的文档是在线的组件           |                              |
+| pnpm debug | 预览的文档是本地最新的组件       | 写作本地最新组件时使用       |
+| pnpm start | 预览的文档是本地最新打包后的组件 | 测试最新组件打包后效果时使用 |

package/docs/api/utils/cookie.md

@@ -0,0 +1,58 @@
+## setCookie
+
+设置 cookie
+
+```ts
+/**
+ * 设置 cookie
+ * @returns
+ */
+declare function setCookie(key: string, data: any): string | undefined
+```
+
+使用示例
+
+```ts
+import { setCookie } from '@wlydfe/pro-ui-utils'
+
+setCookie('username', 'name')
+```
+
+## getCookie
+
+获取 cookie
+
+```ts
+/**
+ * 获取 cookie
+ * @returns
+ */
+declare function getCookie(key: string): string | undefined
+```
+
+使用示例
+
+```ts
+import { getCookie } from '@wlydfe/pro-ui-utils'
+
+getCookie('username') // name
+```
+
+## removeCookie
+
+移除 cookie
+
+```ts
+/**
+ * 移除 cookie
+ */
+declare function removeCookie(key: string): void
+```
+
+使用示例
+
+```ts
+import { removeCookie } from '@wlydfe/pro-ui-utils'
+
+removeCookie('username')
+```

package/docs/api/utils/day.md

@@ -0,0 +1,115 @@
+## formatDate
+
+格式化时间
+
+```ts
+import type { ConfigType } from 'dayjs'
+/**
+ * 格式化时间
+ * @param {string | number | Date | Dayjs | null | undefined} date
+ * @param format 默认YYYY-MM-DD HH:mm:ss
+ * @returns YYYY-MM-DD HH:mm:ss
+ */
+declare function formatDate(date?: ConfigType, format?: string): string
+```
+
+使用示例
+
+```ts
+import { formatDate } from '@wlydfe/pro-ui-utils'
+
+formatDate(new Date()) //  2023-01-01 01:01:01
+```
+
+## formatDateToDay
+
+格式化时间到天
+
+```ts
+import type { ConfigType } from 'dayjs'
+/**
+ * 格式化时间到天
+ * @param {string | number | Date | Dayjs | null | undefined} date
+ * @returns YYYY-MM-DD
+ */
+declare const formatDateToDay: (date: ConfigType) => string
+```
+
+使用示例
+
+```ts
+import { formatDateToDay } from '@wlydfe/pro-ui-utils'
+
+formatDateToDay(new Date()) //  2023-01-01
+```
+
+## formatDateToMinute
+
+格式化时间到分钟
+
+```ts
+import type { ConfigType } from 'dayjs'
+/**
+ * 格式化时间到分钟
+ * @param {string | number | Date | Dayjs | null | undefined} date
+ * @returns YYYY-MM-DD HH:mm
+ */
+declare const formatDateToMinute: (date: ConfigType) => string
+```
+
+使用示例
+
+```ts
+import { formatDateToMinute } from '@wlydfe/pro-ui-utils'
+
+formatDateToDay(new Date()) // 2023-01-01 01:01
+```
+
+## diffDate
+
+获取两个 Dayjs 对象的时间差，默认秒。
+
+```ts
+import type { QUnitType, OpUnitType, ConfigType } from 'dayjs'
+/**
+ * 获取两个 Dayjs 对象的时间差，默认秒。
+ * @param date1
+ * @param date2
+ * @param format  默认 'second'
+ * @returns
+ */
+declare function diffDate(
+  date1: ConfigType,
+  date2?: ConfigType,
+  format?: QUnitType | OpUnitType
+): number | string | undefined
+```
+
+使用示例
+
+```ts
+import { diffDate } from '@wlydfe/pro-ui-utils'
+
+diffDate(new Date(), '2023-01-01 01:01:01') // 18014030
+```
+
+## diffDateFromCurrent
+
+获取距离当前时间差 返回多少年（月/天/小时/分钟/秒）前
+
+```ts
+/**
+ * @desc 获取距离当前时间差
+ * @param date 时间秒数
+ * @returns
+ */
+declare function diffDateFromCurrent(date: number): string
+```
+
+使用示例
+
+```ts
+import { diffDateFromCurrent } from '@wlydfe/pro-ui-utils'
+
+diffDateFromCurrent(61) // 1秒前
+```

package/docs/api/utils/encrypt.md

@@ -0,0 +1,53 @@
+## encrypt
+
+AES 加密
+
+```ts
+import CryptoJS from 'crypto-js'
+
+/**
+ * AES加密
+ * @param key
+ * @param data
+ * @returns
+ */
+declare function encrypt(
+  key: string | CryptoJS.lib.WordArray,
+  data: string | CryptoJS.lib.WordArray
+): string
+```
+
+使用示例
+
+```ts
+import { encrypt } from '@wlydfe/pro-ui-utils'
+
+encrypt('key', 'message') // U2FsdGVkX19GcnbMMQplTX7ZrBomhN24tzbA5Nlc1dw=
+```
+
+## decrypt
+
+AES 解密
+
+```ts
+import CryptoJS from 'crypto-js'
+
+/**
+ * AES 解密
+ * @param key
+ * @param encrypted
+ * @returns
+ */
+declare function decrypt(
+  key: string | CryptoJS.lib.WordArray,
+  encrypted: string | CryptoJS.lib.CipherParams
+): string
+```
+
+使用示例
+
+```ts
+import { decrypt } from '@wlydfe/pro-ui-utils'
+
+decrypt('key', 'U2FsdGVkX19GcnbMMQplTX7ZrBomhN24tzbA5Nlc1dw=') // message
+```

package/docs/api/utils/file.md

@@ -0,0 +1,212 @@
+## download
+
+下载文件
+
+```ts
+import type { FileSaverOptions } from 'file-saver'
+
+interface Download<T = Blob | string> {
+  (data: T, filename: string, options?: FileSaverOptions): Promise<T>
+}
+
+/**
+ * @description 下载文件
+ * @param {Blob | string} data  文件 Blob
+ * @param  {string} filename 文件名称
+ * @param  {object} options 可选参数
+ */
+declare const download: Download
+```
+
+使用示例
+
+```ts
+import { download } from '@wlydfe/pro-ui-utils'
+
+const handleDownload = async () => {
+  await download('data', 'test.txt')
+}
+
+handleDownload()
+```
+
+## isLegalFile
+
+判断文件类型是否符合预期
+
+```ts
+/**
+ *
+ * @desc 限制文件类型
+ * @param {File|Blob} file 源文件
+ * "默认限制图"片
+ * @return 合法文件返回true否则返回false
+ */
+declare const isLegalFile: (file: File | Blob, types: string[]) => boolean
+```
+
+使用示例
+
+```ts
+import { isLegalFile } from '@wlydfe/pro-ui-utils'
+
+const file = new File(['data'], 'test.txt', {
+  type: 'text/plain'
+})
+
+isLegalFile(file, ['.txt', '.cad', '.bom', '.dwg', '.job', '.lib']) // true
+```
+
+## isMaxFileSize
+
+判断文件文件上传大小是否符合预期
+
+```ts
+/**
+ * @desc 限制文件上传大小
+ * @param {File|Blob} file 源文件
+ * @param {number} fileMaxSize  文件大小单位（MB）
+ * @return 在限制内返回true否则返回false
+ */
+declare const isMaxFileSize: (file: File | Blob, fileMaxSize?: number) => boolean
+```
+
+使用示例
+
+```ts
+import { isMaxFileSize } from '@wlydfe/pro-ui-utils'
+
+const file = new File(['data'], 'test.txt', {
+  type: 'text/plain'
+})
+
+isMaxFileSize(file, 1) // true
+```
+
+## fileToDataURL
+
+读取文件为 DataURL 文件格式 （base64）
+
+```ts
+/**
+ *
+ * @desc 读取文件为DataURL文件格式 （base64）
+ * @param {file|Blob} file 源文件
+ * @return 返回DataURL文件 （base64）
+ */
+declare const fileToDataURL: (file: File | Blob) => Promise<string>
+```
+
+使用示例
+
+```ts
+import { fileToDataURL } from '@wlydfe/pro-ui-utils'
+
+const file = new File(['data'], 'test.txt', {
+  type: 'text/plain'
+})
+
+const handleFileToDataURL = async () => {
+  const data = await fileToDataURL(file) // data:text/plain;base64,ZGF0YQ==
+}
+
+handleFileToDataURL()
+```
+
+## fileToText
+
+读取文件为 text 文件格式
+
+```ts
+/**
+ * @desc 读取文件为text文件格式
+ * @param {file} file 源文件
+ * @return 返回text文件
+ */
+declare const fileToText: (file: File | Blob) => Promise<string>
+```
+
+使用示例
+
+```ts
+import { fileToText } from '@wlydfe/pro-ui-utils'
+
+const file = new File(['hello-data'], 'test.txt', {
+  type: 'text/plain'
+})
+
+const handleFileToText = async () => {
+  const data = await fileToText(file) // hello-data
+}
+
+handleFileToText()
+```
+
+## loadImage
+
+加载图片
+
+```ts
+/**
+ * @desc 加载真实图片，读取成功返回图片真实宽高和图片本身对象 ag: { width: 100,height: 100,image: '' }
+ * @param {string} src  图片地址
+ * @return `{ width: ,height: , image:  }`
+ */
+declare const loadImage: (src: string) => Promise<{
+  width: number
+  height: number
+  image: HTMLImageElement
+}>
+```
+
+使用示例
+
+```ts
+import { loadImage } from '@wlydfe/pro-ui-utils'
+
+const handleLoadImage = async () => {
+  const url = 'https://fuss10.elemecdn.com/e/5d/4a731a90594a4af544c0c25941171jpeg.jpeg'
+  const data = await loadImage(url) //  {width: 800, height: 572, image: img}
+}
+
+handleLoadImage()
+```
+
+## isLegalResolutionRatio
+
+判断图片文件的分辨率是否在限定范围之内
+
+```ts
+/**
+ * @desc  判断图片文件的分辨率是否在限定范围之内，分辨率不在限定范围之内则抛出异常
+ * @param {File | Blob} file 源文件
+ * @param {object} props   文件分辨率的宽和高   ag: props={width:100, height :100}
+ */
+declare const isLegalResolutionRatio: (
+  file: File | Blob,
+  props: {
+    width: number
+    height: number
+  }
+) => Promise<boolean>
+```
+
+使用示例
+
+```ts
+import { isLegalResolutionRatio } from '@wlydfe/pro-ui-utils'
+
+const file = new File(['image'], 'test.jpeg', {
+  type: 'image/jpeg'
+})
+
+const handleIsLegalResolutionRatio = async () => {
+  try {
+    await isLegalResolutionRatio(file, { width: 100, height: 100 })
+  } catch (error) {
+    console.log(error) // false
+  }
+}
+
+handleIsLegalResolutionRatio()
+```

package/docs/api/utils/index.md

@@ -0,0 +1,40 @@
+# @wlydfe/pro-ui-utils
+
+[![@wlydfe/pro-ui-utils version badge](https://img.shields.io/npm/v/@wlydfe/pro-ui-utils.svg?style=flat-square)](https://www.npmjs.org/package/@wlydfe/pro-ui-utils)
+
+## 简介
+
+`@wlydfe/pro-ui-utils` 提供了 web 开发常用的工具库，它具有以下特点：
+
+- 和`plus-pro-components`解耦，独立的 npm 包，可选安装。
+- 安装后结合 plus-pro-components 使用会非常方便。
+- 它提供了基于 ES Module 的开箱即用的 [Tree Shaking](https://webpack.js.org/guides/tree-shaking/) 功能，无需担心引入会导致打包体积增大。
+- 使用 TypeScript 编写，提供 d.ts，使用起来安全便捷。
+
+有新的工具需求 👉 欢迎 [issues](https://github.com/plus-pro-components/plus-pro-components/issues)
+
+## 独立安装
+
+::: code-group
+
+```sh [pnpm]
+pnpm install @wlydfe/pro-ui-utils
+```
+
+```sh [npm]
+npm install @wlydfe/pro-ui-utils  --save
+```
+
+```sh [yarn]
+yarn add @wlydfe/pro-ui-utils
+```
+
+:::
+
+## 使用示例
+
+```ts
+import { formatMoney } from '@wlydfe/pro-ui-utils'
+
+formatMoney('100') // ￥100.00
+```