小程序 – 引入 npm 模块

简介

目前，小程序中已经支持使用 npm 安装第三方包，从而来提高小程序的开发效率。但是，在小程序中使用 npm 包有如下 3 个限制：

①不支持依赖于 Node.js 内置库的包

②不支持依赖于浏览器内置对象的包

③不支持依赖于 C++ 插件的包

总结：虽然 npm 上的包有千千万，但是能供小程序使用的包却“为数不多”。

使用 npm 包

在项目根目录中，使用 cmd 运行 npm init -y  进行初始化 包文件

在微信开发者工具中，点击 工具 - 构建 npm

点击界面的“详情”- "本地设置" - "使用 npm 模块" 勾上。

即可使用 npm 包。

案例 - Vant weapp 组件库

详情：Vant Weapp

1.通过 npm 安装 vant

npm i @vant/weapp -S --production

2.修改 app.json

将 app.json 中的 "style": "v2"  去除

3.修改 project.config.json

开发者工具创建的项目，miniprogramRoot 默认为 miniprogram，package.json 在其外部，npm 构建无法正常工作。

需要手动在 project.config.json 内添加如下配置，使开发者工具可以正确索引到 npm 依赖的位置。

{
  ...
  "setting": {
    ...
    "packNpmManually": true,
    "packNpmRelationList": [
      {
        "packageJsonPath": "./package.json",
        "miniprogramNpmDistDir": "./miniprogram/"
      }
    ]
  }
}

注意： 由于目前新版开发者工具创建的小程序目录文件结构问题，npm构建的文件目录为miniprogram_npm，并且开发工具会默认在当前目录下创建miniprogram_npm的文件名，所以新版本的miniprogramNpmDistDir配置为'./'即可

4.构建 npm 包

打开微信开发者工具，点击 工具 -> 构建 npm，并勾选 使用 npm 模块 选项，构建完成后，即可引入组件。

5.引入组件

以 Button 组件为例，只需要在app.json或index.json中配置 Button 对应的路径即可。

所有组件文档中的引入路径均以 npm 安装为例，如果你是通过下载源代码的方式使用 @vant/weapp，请将路径修改为项目中 @vant/weapp 所在的目录。

// 通过 npm 安装
// app.json
"usingComponents": {
  "van-button": "@vant/weapp/button/index"
}

6.使用组件

引入组件后，可以在 wxml 中直接使用组件

<van-button type="primary">按钮</van-button>