exb-widget

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Experience Builder Custom Widget

ArcGIS Experience Builder自定义组件

Developer Edition custom widget work. The compile version is the constraint everything else hangs on — fix it before writing any widget code.

开发者版自定义组件开发工作。编译版本是所有其他内容的约束条件——在编写任何组件代码之前先确定好它。

Establish the version floor first — before any code

先确定版本下限——在编写任何代码之前

Read
```
client/package.json
```
in the Dev Edition install for the actual ExB version in use. Never assume a version.
Ask which ArcGIS Enterprise version(s) must run this widget.
The compile target is the lowest of those Enterprise versions — ExB runs widgets compiled in earlier versions but not newer ones, and the version a widget was compiled in is what matters.
Pick the Dev Edition version that uses the same JS SDK version as that target Enterprise — see VERSIONS.md, and re-verify against Esri's release-versions page.

The

exbVersion

field in

manifest.json

is declarative and not enforced — hand-editing it downward does not backport a widget. Only compiling in the lower version does.

查看开发者版安装目录下的
```
client/package.json
```
，确认当前使用的ExB实际版本。切勿凭假设确定版本。
确认该组件必须运行在哪些ArcGIS Enterprise版本上。
编译目标为这些Enterprise版本中的最低版本——ExB可以运行在早期版本编译的组件，但无法运行在更新版本编译的组件，组件的编译版本才是关键。
选择与目标Enterprise版本使用相同JS SDK版本的开发者版——参考VERSIONS.md，并在Esri的版本发布页面再次验证。

manifest.json

中的

exbVersion

字段是声明性的，不具备强制效力——手动向下修改该字段不会将组件向后兼容。只有在更低版本中编译才能实现向后兼容。

Check the Node and pnpm gate before running anything

在运行任何命令前检查Node和pnpm版本要求

ExB is gated on Node major version, and the gate differs by ExB release. Confirm the Node and recommended pnpm versions for the exact ExB version in use — see VERSIONS.md — before

install

start

. A wrong Node major fails the toolchain.

ExB对Node主版本有要求，且不同ExB版本的要求不同。在执行

install

或

start

命令前，确认当前使用的ExB版本对应的Node和推荐的pnpm版本——参考VERSIONS.md。错误的Node主版本会导致工具链运行失败。

Keep the manifest invariants

保持manifest的不变量

manifest.json

requires

name

type

version

exbVersion

, and

translatedLocales

name

must exactly match the widget's folder name — a mismatch breaks the widget.

manifest.json

必须包含

name

、

type

、

version

、

exbVersion

和

translatedLocales

字段。

name

必须与组件的文件夹名称完全一致——不匹配会导致组件无法正常运行。

Branch on the output target

根据输出目标选择分支流程

The workflow forks by where the widget is going:

Dev loop —
```
npm start
```
; watch the built output under
```
client/dist
```
.
Download build — produces a distributable widget. The build command and its output path have changed across ExB releases, so read the current build script and output folder from
```
client/package.json
```
scripts rather than assuming.
Portal registration — register the widget with the portal. This requires CORS enabled for the portal domain on the hosting server, and JSON may need registering as a MIME type.

工作流会根据组件的部署目标分为不同分支：

开发循环 —— 执行
```
npm start
```
；查看
```
client/dist
```
目录下的构建输出。
可下载构建 —— 生成可分发的组件。不同ExB版本的构建命令和输出路径有所变化，因此请从
```
client/package.json
```
的scripts中读取当前的构建脚本和输出文件夹，切勿凭假设确定。
门户注册 —— 将组件注册到门户。这需要在托管服务器上为门户域名启用CORS，并且可能需要将JSON注册为MIME类型。

Done when

完成标准

The compile version is fixed to the lowest target Enterprise's matching Dev Edition; Node and pnpm are verified for that ExB version; the manifest invariants hold with

name

equal to the folder name; and the steps match the chosen output target.

编译版本已固定为与目标最低Enterprise版本匹配的开发者版；Node和pnpm版本已针对该ExB版本验证通过；manifest的不变量满足要求，且

name

与文件夹名称一致；步骤与所选输出目标匹配。