# WPSTool

**Repository Path**: mwmi/wpstool

## Basic Information

- **Project Name**: WPSTool
- **Description**: wpsjs 加载项开发
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-10
- **Last Updated**: 2026-02-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🚀 WPSTool

欢迎使用 **WPSTool** - 基于WPS的加载项示例项目！🛠️

这是一个WPS Office插件项目，提供了丰富的API调用和自定义UI功能，可用于扩展WPS文字、表格等组件的功能。

## 📋 目录
- [✨ 特性](#-特性)
- [📥 安装](#-安装)
- [🎮 使用](#-使用)
- [🔧 开发](#-开发)
- [🌐 功能](#-功能)
- [🤝 贡献](#-贡献)
- [📄 许可证](#-许可证)

## ✨ 特性
- 🔧 自定义功能区(Ribbon)按钮
- 🚀 任务窗格(TaskPane)和对话框(Dialog)UI
- 🌟 集成WPS JS API进行文档操作
- 💡 支持自定义函数开发
- ⚡ 使用Vite构建工具，支持热更新开发环境

## 📥 安装
要开始使用 WPSTool，请按照以下步骤操作：

1. 克隆仓库到本地
   ```
   git clone https://github.com/yourusername/WPSTool.git
   ```

2. 进入项目目录
   ```
   cd WPSTool
   ```

3. 安装依赖
   ```
   npm install
   ```

## 🎮 使用
1. 启动开发服务器：
   ```
   npm run dev
   ```

2. 将项目部署为WPS加载项：
   - 在WPS中选择"开发工具"选项卡
   - 点击"加载项" -> "注册加载项"
   - 选择项目根目录下的[manifest.xml](./manifest.xml)文件

3. 重启WPS，即可看到名为"HelloEt"的插件标签页

## 🔧 开发
此项目使用Vite作为开发工具，支持实时预览和热更新：

- 启动开发服务器: `npm run dev` (端口 3889)
- 构建生产版本: `npm run build`
- 预览构建结果: `npm run preview`
- 代码检查: `npm run lint`
- 代码格式化: `npm run format`

项目结构:
- [js/](./js/) - 存放所有JavaScript模块
  - [ribbon.js](./js/ribbon.js) - 处理功能区按钮事件
  - [taskpane.js](./js/taskpane.js) - 任务窗格逻辑
  - [dialog.js](./js/dialog.js) - 对话框逻辑
  - [functions.js](./js/functions.js) - 自定义函数
  - [util.js](./js/util.js) - 工具函数库
- [ui/](./ui/) - 存放HTML模板
  - [taskpane.html](./ui/taskpane.html) - 任务窗格页面
  - [dialog.html](./ui/dialog.html) - 对话框页面
- [manifest.xml](./manifest.xml) - WPS加载项描述文件
- [ribbon.xml](./ribbon.xml) - 定义功能区UI布局

## 🌐 功能
WPSTool提供以下功能:

1. **消息弹窗**: 显示当前文档名称
2. **对话框显示**: 弹出网页对话框
3. **任务窗格**: 创建并显示任务窗格
4. **API事件监听**: 监听WPS文档事件
5. **业务系统通信**: 主动向业务系统发送通知
6. **文档操作**: 在文档开头添加字符串等操作

## 🤝 贡献
我们欢迎各种贡献！请按照以下步骤进行：

1. Fork 仓库 🍴
2. 创建新分支 (`git checkout -b feature/AmazingFeature`) 🌿
3. 提交更改 (`git commit -m '添加一些很棒的功能'`) 💾
4. 推送到分支 (`git push origin feature/AmazingFeature`) 🚀
5. 打开 Pull Request 📬

## 📄 许可证
该项目采用 MIT 许可证 - 详情请见 [LICENSE](LICENSE) 文件。

---

由 [Your Name] 用 ❤️ 制作