生成首个 WPS 加载项

在本教程中,将创建一个 WPS 加载项,该加载项将:

  • 设计自定义功能区
  • 打开对话框
  • 创建自定义任务窗格

准备开发环境

  • 安装WPS 12.1.0.18912个人版
  • 安装Node.js
  • 安装代码编辑器 Visual Studio Code

新建 WPS 加载项

1、通过npm全局安装wpsjs开发工具包

安装命令: 

npm install -g wpsjs

如果之前已经安装了,可以检查下wpsjs版本。

更新wpsjs的命令为:

npm update -g wpsjs

2、新建一个WPS加载项:HelloWps

输入命令: 

wpsjs create HelloWps

会出现如下图的几个选项:

生成首个 WPS 加载项

通过上下方向键可以选择要创建的WPS加载项的类型,如果选择“文字”,则创建的加载项会在WPS文字程序中加载并运行,同理选择“电子表格”,则会在WPS表格中运行,这里假设我们选择的是“文字”,按Enter键确定。

3、选择示例代码的代码风格类型

wpsjs工具包提供了两种不同代码风格的示例,“无”代表示例代码中都是原生的JS及HTML代码,没有集成vue\react等流行的前端框架。

生成首个 WPS 加载项

初步学习建议不使用框架,选“无”。实际项目开发推荐使用Vue框架。

确认后wpsjs工具包会在当前目录下生成一个HelloWps的文件夹,我们进入到此文件夹,可以看到HelloWps的相关代码已经生成。

4、开始调试并愉快的写代码

在HelloWps项目文件夹下,执行命令: 

wpsjs debug
生成首个 WPS 加载项
生成首个 WPS 加载项

执行此命令后即可开始调试,wpsjs工具包会自动启动WPS并加载HelloWps这个加载项,同时wpsjs工具包启了一个HTTP服务,此服务主要提供两方面的能力:

(1)提供前端页的的热更新服务,wpsjs工具包检测到网页数据变化时,自动刷新页面。

生成首个 WPS 加载项

(2)提供WPS加载项的在线服务,wpsjs生成的代码示例是一个在线模式,WPS客户端程序实际上是通过HTTP服务来请求在线的WPS加载项相关代码和资源的。

生成首个 WPS 加载项

最后,可以用Visual Studio Code打开示例代码,开始愉快的写代码了。

备注:wpsjs工具包为示例代码中有一个package.json文件,这是node工具标准的配置文件,其中有一个依赖包为wps-jsapi,这个依赖包是WPS支持的全部接口的TypeScript描述,方便在vscode中敲代码时,提供代码联想功能,由于WPS接口会跟随业务需求不断更新,因此当发现代码联想对于有些接口不支持时,通过”npm update –save-dev wps-jsapi“命令定期更新这个包。

(0)
上一篇 2024年11月12日 下午12:43
下一篇 2024年11月12日 下午9:17

相关推荐

  • 天津市优待目录清单

    序号 现役军人基本优待目录清单 1 为符合悬挂条件的家庭悬挂光荣牌。 2 “八一”、春节为其家庭赠送慰问信。 3 为入伍、退役的军人举行迎送仪式。 4 邀请优秀现役军人代表参加重要庆典和纪念活动。 5 将服役期间荣获个人二等功以上奖励的现役军人名录和事迹载入地方志。 6 为个人立功、获得荣誉称号或勋章的现役军人家庭送喜报。 7 优先聘请优秀现役军人担任大中小…

    其他 2023年2月13日
    3.4K00
  • 银河麒麟操作系统如何修改主机名

    Linux系统中广泛使用Vim文本编辑器修改文件。 Vim文本编辑器一共有三种模式:普通模式、插入模式、命令模式。只有在命令模式下,我们才能保存文件。 下面我们通过一个示例详细介绍如何使用Vim修改文件: 修改计算机主机名 第一步:修改hostname文件 01 打开hostname文件 进入文件系统/etc目录,鼠标右键,在终端中打开,打开终端界面。 输入…

    2024年11月5日
    1.1K00
  • 凤凰县严格落实入凤“先报、即查、即检、即管”措施

    当前,全国疫情呈现点多、面广、频发特点,形势依然严峻复杂,“外防输入”压力持续增大。为进一步做好当前疫情防控“外防输入”工作,根据国务院联防联控机制优化防控工作“二十条”措施等有关要求,凤凰县严格落实入凤“先报、即查、即检、即管”措施。 1.入凤先报备 所有外省或省内发生本土疫情且外溢风险高的市州来(返)凤人员抵凤前,应至少提前1天电话向目的地所在村(社区)…

    其他 2022年11月23日
    80400
  • 国产电脑(银河麒麟系统)如何删除文件和文件夹

    一、删除文件/文件夹:rm 命令 rm 是强大的删除命令,它可以 永久性地 删除文件系统中指定的文件或目录。 在使用 rm 命令删除文件或目录时,系统不会产生任何提示信息。此命令的基本格式为: rm [选项] 文件或目录 选项: -f:强制删除(force),和 -i 选项相反,使用 -f,系统将不再询问,而是直接删除目标文件或目录。 -i:和 -f 正好相…

    其他 2022年7月18日
    9.7K00
  • 四川省退役军人优待目录

    第一批优待项目清单 第二批优待项目清单

    其他 2023年1月27日
    7.5K00

发表回复

登录后才能评论