xl-app-sdk

本包是专为玄灵拓展插件视图量身定制的开发工具包。它集成了多种常用的业务模块和 UI 组件交互功能，旨在简化开发流程，提高开发效率，并确保应用在玄灵生态系统中的体验一致性。

✨ 特性

• 🚀 开箱即用: 提供完善的初始化流程，快速接入。
• 📦 模块化设计: 包含请求封装、文件上传、消息提示、对话框、等多个独立模块。
• 🎨 样式统一: 内置与玄灵系统一致的交互样式和主题管理。
• 🛠️ Vue 3 支持: 深度集成 Vue 3，提供丰富的 Composition API (Hooks)。
• 📝 TypeScript 支持: 完整的类型定义，提供极佳的开发体验。

📦 安装

npm install xl-app-sdk

# 或
yarn add xl-app-sdk

# 或 CDN 引入
<script src="https://cdn.jsdelivr.net/npm/xl-app-sdk/dist/js/xl-app-sdk.js"></script>

🚀 快速上手

// NPM包
import { message } from 'xl-app-sdk';

// 调用消息提示
message.success('欢迎使用');

<!-- CDN引入 -->
<script src="https://cdn.jsdelivr.net/npm/xl-app-sdk/dist/js/xl-app-sdk.js"></script>
<script>
    $xl.message.success('欢迎使用');
</script>

📖 核心模块说明

| 模块 | 说明 | 主要 API / 功能 | | --- | --- | --- | | base | 基础模块 | 环境判断等 | | message | 信息提示 | success, error, warning, info, loading | | dialog | 对话框 | create, confirm, warning 等交互弹窗 | | request | 网络请求 | 基于 axios 封装的统一请求工具 | | upload | 文件上传 | 支持原生的文件/文件夹选取及上传逻辑 | | richTextEdit | 富文本 | 富文本编辑相关功能支持 | | vueHooks | Vue 钩子 | 专为 Vue 3 项目提供的快捷 Hooks |

🛠️ 开发与构建

项目使用 Vite 进行构建，支持 ESM 和 UMD 格式。

📄 开源协议

本项目遵循 MIT 协议。

Keywords: xl-app-sdk, 玄灵, Xuanling, SDK