xl-app-sdk 0.0.2 → 0.0.5
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 +69 -0
- package/dist/es/index.js +1378 -0
- package/dist/js/xl-app-sdk.esm.js +3147 -0
- package/dist/js/xl-app-sdk.js +6 -0
- package/dist/types/index.d.ts +1 -8
- package/package.json +24 -19
- package/dist/xl-app-sdk.esm.js +0 -8
- package/dist/xl-app-sdk.umd.js +0 -1
package/README.md
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# xl-app-sdk
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/xl-app-sdk)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
本包是专为玄灵拓展插件视图量身定制的开发工具包。它集成了多种常用的业务模块和 UI 组件交互功能，旨在简化开发流程，提高开发效率，并确保应用在玄灵生态系统中的体验一致性。
|
|
7
|
+
|
|
8
|
+
## ✨ 特性
|
|
9
|
+
|
|
10
|
+
- 🚀 **开箱即用**: 提供完善的初始化流程，快速接入。
|
|
11
|
+
- 📦 **模块化设计**: 包含请求封装、文件上传、消息提示、对话框、等多个独立模块。
|
|
12
|
+
- 🎨 **样式统一**: 内置与玄灵系统一致的交互样式和主题管理。
|
|
13
|
+
- 🛠️ **Vue 3 支持**: 深度集成 Vue 3，提供丰富的 Composition API (Hooks)。
|
|
14
|
+
- 📝 **TypeScript 支持**: 完整的类型定义，提供极佳的开发体验。
|
|
15
|
+
|
|
16
|
+
## 📦 安装
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm install xl-app-sdk
|
|
20
|
+
|
|
21
|
+
# 或
|
|
22
|
+
yarn add xl-app-sdk
|
|
23
|
+
|
|
24
|
+
# 或 CDN 引入
|
|
25
|
+
<script src="https://cdn.jsdelivr.net/npm/xl-app-sdk/dist/js/xl-app-sdk.js"></script>
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## 🚀 快速上手
|
|
29
|
+
|
|
30
|
+
```typescript
|
|
31
|
+
// NPM包
|
|
32
|
+
import { message } from 'xl-app-sdk';
|
|
33
|
+
|
|
34
|
+
// 调用消息提示
|
|
35
|
+
message.success('欢迎使用');
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
```html
|
|
39
|
+
<!-- CDN引入 -->
|
|
40
|
+
<script src="https://cdn.jsdelivr.net/npm/xl-app-sdk/dist/js/xl-app-sdk.js"></script>
|
|
41
|
+
<script>
|
|
42
|
+
$xl.message.success('欢迎使用');
|
|
43
|
+
</script>
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## 📖 核心模块说明
|
|
47
|
+
|
|
48
|
+
| 模块 | 说明 | 主要 API / 功能 |
|
|
49
|
+
| --- | --- | --- |
|
|
50
|
+
| **base** | 基础模块 | 环境判断等 |
|
|
51
|
+
| **message** | 信息提示 | `success`, `error`, `warning`, `info`, `loading` |
|
|
52
|
+
| **dialog** | 对话框 | `create`, `confirm`, `warning` 等交互弹窗 |
|
|
53
|
+
| **request** | 网络请求 | 基于 axios 封装的统一请求工具 |
|
|
54
|
+
| **upload** | 文件上传 | 支持原生的文件/文件夹选取及上传逻辑 |
|
|
55
|
+
| **richTextEdit** | 富文本 | 富文本编辑相关功能支持 |
|
|
56
|
+
| **vueHooks** | Vue 钩子 | 专为 Vue 3 项目提供的快捷 Hooks |
|
|
57
|
+
|
|
58
|
+
## 🛠️ 开发与构建
|
|
59
|
+
|
|
60
|
+
项目使用 [Vite](https://vitejs.dev/) 进行构建，支持 ESM 和 UMD 格式。
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
## 📄 开源协议
|
|
64
|
+
|
|
65
|
+
本项目遵循 [MIT](LICENSE) 协议。
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
**Keywords**: `xl-app-sdk`, `玄灵`, `Xuanling`, `SDK`
|