设计器

@xihan-form/designer 的公开接口。样式在 @xihan-form/designer/style.css，还要同时引入 @xihan-ui/designer-shell/style.css 与 @xihan-form/runtime/style.css。

<xh-form-designer>

注册 <xh-form-designer> 与它用到的全部元素：渲染器（画布与预览共用）及其库内元素、工具栏与菜单等库内元素、设计器零件；重复调用不报错。宿主自定义字段渲染器用到的元素由宿主注册。

属性

属性	attribute	类型	说明
expressionEngine	—	ExpressionEngine | undefined	校验表达式与预览用，缺省为 createExpressionEngine()。
commandLayout	—	DesignerCommandLayout | undefined	菜单栏、工具栏、右键菜单与选中工具条的排列：位置（menubar:file、menubar:edit、menubar:view、menubar:help 与扩展登记的菜单 menubar:<菜单 id>，toolbar、menu:node、menu:region、menu:cell、menu:blank、selection:node）→ 若干组命令 id，内置命令与扩展命令混排。写了某个位置就只显示列出的；没写的位置用内置的缺省排列，再把 placement 含它的扩展命令追加成一组。
previewValues	—	Readonly<Record<string, JsonValue>> | undefined	预览的示例数据。
loadOptions	—	OptionLoader | undefined	预览的选项加载。
uploadFile	—	FileUploader | undefined	预览里文件字段的上传函数，与渲染器的同名属性一样交给 xh-file-upload；组件自己不发请求。
translations	—	Partial<FormDesignerTranslations> | undefined	元素自己的文案，压在全局配置之上。
readonly	readonly	boolean | undefined	可选择、浏览与预览，不能修改。attribute 按三态读：没写或写 "false" 为可修改，其余写法为只读。
mode	mode	FormDesignerMode | undefined	设计态或预览态，缺省 design。
previewWidth	preview-width	FormPreviewWidth | undefined	预览宽度，缺省 full。
defaultLayout	—	DesignerLayout | undefined	宿主的缺省面板布局：用户没存过布局（settings 里没有 layout.panels）时用它，「恢复默认布局」也回到它；写了的字段整项覆盖内置缺省（物料在左栏、属性在右栏、问题在下栏，全部显示）。面板 id 见 FORM_DESIGNER_PANELS。用户挪了面板、改了显隐或大小，整份布局写进设置的 layout.panels 并派发 settings-change。预览态不显示面板，不动布局。
settings	—	DesignerSettings | undefined	设置的值：扁平的键值，键是「分区 id.条目 id」，如 general.theme；没写的键取条目的缺省值。赋值即生效；用户在设置对话框里改了以后设计器换成新的一份并派发 settings-change。
settingsPolicy	—	DesignerSettingsPolicy | undefined	宿主对设置条目的管控：键是条目键或分区 id，hidden 不显示，locked 只读、说明换成「由所在系统管理」。
settingsStorageKey	settings-storage-key	string | undefined	设置存在根所在窗口 localStorage 的哪个键下：给了，连上文档时若没赋 settings 就从这里读，用户改了设置就写回去，标了 secret 的条目不存；读写失败派发 settings-storage-error。不给就不读写。同名 attribute settings-storage-key。
draftKey	draft-key	string | undefined	自动保存草稿的键：区分同一页、同一种设计器里的不同模板（宿主写模板 id）；不给时按页面地址区分。设置里开着自动保存时，未保存的修改停手约一秒存成这台浏览器里的草稿；下次装进同一个键的模板、和草稿不一样时问恢复还是丢弃。同名 attribute draft-key。
historyLimit	history-limit	number | undefined	撤销步数上限，缺省 100；在下一次装载（赋 schema）时生效。同名 attribute history-limit。
autoTour	auto-tour	boolean | undefined	第一次铺好画布后自动开始新手引导，缺省开；设置里记着引导已经走完或跳过（help.tourDone）时不开。写 false 不自动开始，仍能用 startTour() 或命令 start-tour 开。同名 attribute auto-tour，写 "false" 为关。

存取器

属性	读写	类型	说明
schema	可读写	FormDocument	当前模板；赋值即装载：清空历史与选择，赋回当前这一份不重新装载；同一个草稿键下有不一样的草稿时问恢复还是丢弃。
extensions	可读写	readonly FormDesignerExtension[] | undefined	扩展：种类、渲染、属性编辑器、编辑方式、规则、命令与面板都从这里来，内置扩展自动排在最前；画布、预览与校验用同一份。赋值时当场合并查重，冲突抛 DesignerExtensionError、什么都不变；各扩展的 setup 在元素连上文档时调用、断开时清理。同一个扩展对象换了引用当作卸下再装上，宿主要保持引用稳定。
canUndo	只读	boolean	有可撤销的修改。
canRedo	只读	boolean	有可重做的修改。
canPaste	只读	boolean	内部剪贴板里有内容可粘贴。
xhConfig	只读	XhConfig	设计器这棵子树的配置：设置里选了语言时是这一语言的 UI、designer-shell 与表单语言包，跟随页面时是空对象。设计器自己、里面的元素与它弹出的浮层都按它取 locale 与文案，页面别处不受影响。
dirty	只读	boolean	有没保存的修改：上次 markSaved 之后改过。
historyState	只读	HistorySnapshot	撤销历史的快照：各步的说明按此刻的语言取好，位置号用于 goToHistory。

方法

方法	说明
goToHistory(position: number): boolean	跳到撤销历史里的一步或起点（historyState 里的位置号），一次跳到；只读、预览、拖动中或位置号不认识时返回 false。
clearHistory(): void	清空撤销与重做；模板与是否已保存不变。只读或拖动中什么都不做。
execute(operations: readonly FormOperation[], options?: ExecuteOptions): FormDocument	执行一组操作并记为一步撤销；返回新模板。
undo(): boolean	撤销一步；只读、正在拖动跨度或没有可撤销的时返回 false。
redo(): boolean	重做一步；只读、正在拖动跨度或没有可重做的时返回 false。
markSaved(): void	把当前模板记为已保存：dirty 变为 false，并派发 dirty-change。
addNode(kind: string, target?: FormDropTarget): FormNode | undefined	按种类新建节点并选中它；目标缺省为选中节点之后，没有选中时为末尾。目标不收时返回 undefined。
select(selection: Partial<FormSelection>): void	选中节点或区域：给了非空的 regions 就选区域，否则选 nodes。
getSelection(): FormSelection	当前的选择。
startTour(): boolean	开始新手引导，从第一步起；同一页别的设计器的引导开着时先收起它。没有能走的步骤时返回 false。引导收起时派发 tour-end，并在设置里记下 help.tourDone。命令 start-tour 与设置对话框帮助页的「开始引导」都走这里。
openJsonEditor(): void	打开 JSON 编辑框，写出此刻的整份模板。改一次就按 validate() 同一套检查一次，有错误时不能应用；应用后整份换上，作为一步进撤销栈。只读或预览态时只能看、能复制，不能应用。
openSettings(section?: string): void	打开设置对话框，给了分区 id 就显示那一页：基础是 general，扩展的分区用它们自己的 id。
deleteSelection(): boolean	删除选中的节点或区域；只读或什么都没删时返回 false。
copy(): FormClipboard | undefined	复制选中的节点，放进这个设计器的剪贴板并返回；没有选中时返回 undefined。
cut(): FormClipboard | undefined	复制并删除选中的节点；只读或没有选中时返回 undefined。
paste(clipboard?: FormClipboard, options?: { readonly at?: FormDropTarget }): FormSelection	粘贴：给了内容就粘贴它，否则粘贴最近一次复制或剪切的内容；返回新的选择。给了 at 就粘贴到那里（如物料来源的条目拖到画布上的落点），不给时在选中节点之后，没有选中时在末尾。
duplicate(): FormSelection	复制选中节点并紧跟在原节点之后粘贴，不改动剪贴板；返回新的选择。
validate(): readonly FormSchemaIssue[]	检查模板结构，规则里的表达式用 expressionEngine 检查。
scrollToNode(id: string): void	滚动到节点：必要时先切到所在的标签页、展开所在的折叠项。
revealNode(id: string): void	节点不在可见区内时才滚动到它。

事件

事件都是冒泡的 CustomEvent。

事件	detail	说明
schema-change	{ schema: FormDocument, operations: readonly FormOperation[], kind: FormSchemaChangeKind }	模板变了：执行操作、撤销、重做或换了 schema；schema 是变化后的模板，operations 是这一步实际应用的操作。
selection-change	FormSelection	选择变了。
dirty-change	{ dirty: boolean }	有没有未保存修改的状态变了。
issues-change	{ issues: readonly FormSchemaIssue[] }	模板问题变了；issues 是当前全部问题。
save	Record<string, never>	用户要保存：按了 Ctrl / ⌘ + S 或点了保存命令（designer-shell 内置的 save）。保存由宿主做，存好后调用 markSaved()。
node-dblclick	{ id: string }	双击了画布上的节点。
node-contextmenu	{ id: string, x: number, y: number }	要在节点上打开右键菜单，x、y 是视口坐标；可取消，取消后不打开内建菜单。
blank-contextmenu	{ x: number, y: number }	要在画布空白处打开右键菜单；可取消，取消后不打开内建菜单。
mode-change	{ mode: FormDesignerMode }	在设计态与预览态之间切换了。
settings-change	{ key: string, value: JsonValue | undefined, settings: DesignerSettings }	在设置对话框里改了一条设置，或在外框上挪了面板（键是 layout.panels，值是整份布局）：设计器已换成新的 settings 并生效（主题、主题色、状态栏与面板布局）；value 为 undefined 表示删掉这个键、回到缺省值。宿主存起来，下次赋回 settings。
settings-storage-error	VisualEnvironmentStorageError	读写 settingsStorageKey 指的本机存储失败（内容不是对象、无痕窗口、配额满）；设置留在内存里。
history-change	HistorySnapshot	撤销历史变了：执行（含并入上一步）、撤销、重做、跳转、装载、清空与保存之后都派发，拖动跨度这样的事务进行中不派发。detail 是此刻的 historyState。
tour-end	{ reason: 'complete' | 'skip' | 'close', step: string | undefined }	新手引导收起了：reason 是 complete（走完）、skip（跳过或 Esc）或 close（关闭钮），step 是收起时那一步的 id。设计器同时在设置里记下 help.tourDone（会派发 settings-change），下次不再自动开始。

类型

FormDesignerMode

设计态或预览态。取值：design、preview。

FormPreviewWidth

预览宽度：全宽、平板、手机，设计态画布同样生效。取值：full、tablet、phone。

FORM_DESIGNER_PANELS

设计器的面板 id：宿主写 defaultLayout、settingsPolicy（layout.panels.<面板 id>）时用；每块面板有一条开关命令 panel:<面板 id>。

const FORM_DESIGNER_PANELS = { palette: 'palette', outline: 'outline', properties: 'properties', issues: 'issues', history: 'history' } as const

FormSchemaChangeKind

schema-change 的来源。取值：execute、undo、redo、load。

FormSelection

选择：选中的节点，或同一个容器里的区域（栅格的列、标签页、折叠项、表格单元格），二者互斥，按选中的先后。选中区域时 nodes 为空。

属性	类型	说明
nodes	readonly string[]	选中节点的 id。
regions?	readonly string[]	选中区域的 id，都在同一个容器里。

FormDropTarget

放置位置：区域 id（null 为文档顶层）与放在该区域现有子节点里的第几个之前，缺省放到末尾。

属性	类型	说明
parent	string | null	区域 id；null 为文档顶层。
index?	number	放在该区域现有子节点里的第几个之前，从 0 起；缺省放到末尾。

FormClipboard

剪贴板内容：被复制的节点，按文档顺序，不含被选中节点的后代里重复选中的那些。

属性	类型	说明
nodes	readonly FormNode[]	被复制的节点，粘贴时 id 全部换新。

扩展与命令

FormDesignerExtension

表单设计器层的扩展：运行时层的全部字段，加上属性编辑器、命令、面板、物料来源、导入导出与 setup。物料来源的条目拖到画布上放下时，落点是 FormDropTarget。

其余成员见视图组件文档的 designer-shell。

继承 FormRuntimeExtension、DesignerShellExtension<FormDesignerContext, FormPropertyEditor, FormDocument, FormRuleContext, FormDropTarget>。

属性	类型	说明
kindIcons?	Readonly<Record<string, IconRecord>>	本扩展登记的种类的图标，物料面板与页面结构用；键是种类名，只能给本扩展 kinds 里的种类。

FormDesignerContext

命令、面板与扩展装上时拿到的上下文。

属性	类型	说明
designer	XhFormDesigner	这个设计器实例。
translations	FormDesignerTranslations	此刻生效的设计器文案。
commands	DesignerCommandsTranslations	此刻生效的共用命令文案（designer-shell 语言包的 xh-designer-commands）：撤销、剪切、删除、设计与预览这些四款都有的命令。
settings	DesignerSettings	此刻生效的设置：键是「分区 id.条目 id」，各分区没写的条目取了缺省值。
frame	XhDesignerFrameElement | undefined	设计器的外框：面板的开关经它；外框还没建出来时为 undefined。

FormDesignerCommand

设计器的命令。

type FormDesignerCommand = DesignerCommand<FormDesignerContext>

FormMenuSubject

右键菜单落在哪类对象上：节点、区域、表格布局的单元格，或空白处。取值：node、region、cell、blank。

FormSelectionSubject

选中工具条落在哪类选中上：眼下只有单个节点。取值：node。

文案

FormDesignerTranslations

表单设计器的文案：无参的是字符串，带参的是函数。

文案键是 xh-form-designer，各语言的文案在 @xihan-form/runtime/locale，如中文的 formZhCN。

属性	类型	说明
label	string	设计器的可访问名。
canvas	string	画布的可访问名。
palette	string	物料面板的标题。
properties	string	属性面板的标题。
issues	string	问题列表的标题。
paletteHelp	string	物料面板头的帮助。
propertiesHelp	string	属性面板头的帮助。
issuesHelp	string	问题列表面板头的帮助。
selectParent	string	选中上一级命令。
moveUp	string	上移命令。
moveDown	string	下移命令。
clear	string	清空命令。
previewWidth	string	预览宽度这组按钮的可访问名。
widthFull	string	全宽。
widthTablet	string	平板宽度。
widthPhone	string	手机宽度。
propertiesTab	string	属性区的「属性」页签。
validationTab	string	属性区的「校验」页签。
linkageTab	string	属性区的「联动」页签。
emptyCanvas	string	画布为空时的提示。
emptyRegion	string	区域为空时的提示。
settings	string	什么都没选时属性区的标题。
addRule	string	新增规则的按钮。
removeRule	string	删除规则的按钮。
ruleMessage	string	规则的「提示」输入框。
ruleWhen	string	联动规则的「条件」输入框。
ruleValue	string	联动赋值的「取值」输入框。
ruleMin	string	规则的「最小值」输入框。
ruleMax	string	规则的「最大值」输入框。
rulePattern	string	正则规则的「正则」输入框。
ruleFlags	string	正则规则的「标志」输入框。
ruleExpression	string	表达式规则的「表达式」输入框。
ruleAction	string	联动规则的「动作」选择框。
noRules	string	还没有规则时的提示。
variableValue	string	表达式补全里运行时变量 $value 的说明。
variableRow	string	表达式补全里运行时变量 $row 的说明。
variableIndex	string	表达式补全里运行时变量 $index 的说明。
mergeCells	string	表格布局右键菜单：合并单元格。
splitCell	string	表格布局右键菜单：拆分单元格。
insertRowAbove	string	表格布局右键菜单：在上方插入行。
insertRowBelow	string	表格布局右键菜单：在下方插入行。
insertColumnLeft	string	表格布局右键菜单：在左侧插入列。
insertColumnRight	string	表格布局右键菜单：在右侧插入列。
removeRow	string	表格布局右键菜单：删除行。
removeColumn	string	表格布局右键菜单：删除列。
history	FormHistoryTranslations	撤销历史里各步的说明。
tour	FormTourTranslations	新手引导里表单自己的几步。
help	FormHelpTranslations	设置对话框「帮助」「关于」两页里表单自己的文字。
keys	FormKeyTranslations	快捷键表里不是命令的按键。
sourceStructure	string	问题列表里结构问题的来源小标签。
sourceBinding	string	问题列表里数据绑定问题的来源小标签。

方法	说明
statusFields(count: number): string	状态栏：什么都没选中时写表单里的字段数。
statusSelected(count: number): string	状态栏：选中多项时写已选的个数。
nodeTag(kind: string, key: string | undefined): string	画布上选中节点的标签，如「单行文本 · name」。
category(category: string): string	物料分类名，按种类的 category。
kind(kind: string): string	种类名，按 kind。
group(group: string): string	属性分组名：basic / data / appearance / region / settings。
property(kind: string, group: string, name: string): string	属性名：先按「种类:分组.名」，再按「分组.名」，最后按名查。
option(name: string, value: string): string	select 选项的文案，按属性名与选项值。
ruleKind(kind: string): string	校验规则种类名。
linkageAction(action: string): string	联动动作名。
outlineColumn(n: number): string	页面结构里栅格的一列，n 从 1 起。
outlineCell(row: number, column: number): string	页面结构里表格布局的一格，行与列从 1 起。
outlineRegion(n: number): string	页面结构里没有标题的区域，n 从 1 起。
unboundKey(key: string): string	数据键不在宿主数据模型里。
issue(issue: FormSchemaIssue): string	模板结构问题的说明，按问题码与参数；扩展给出的问题码先取扩展的 issueText，都没有时显示问题码本身。

编辑模型

设计器内部的编辑模型也一并导出，不显示界面、只想按操作改模板时可以直接用。创建表单编辑模型。

declare function createFormEditor(options: FormEditorOptions): FormEditor

FormEditorOptions

创建编辑模型的选项。

属性	类型	说明
document	FormDocument	初始文档。
extensions?	readonly FormCoreExtension[]	种类、编辑方式与规则从这组扩展来，内置扩展自动排在最前；与设计器的 extensions 是同一份。
expressionEngine?	ExpressionEngine	校验时检查表达式用的引擎，不给时不检查表达式内容。
identifiers?	readonly string[]	宿主提供给表达式的额外顶层名字。
historyLimit?	number	撤销步数上限，缺省 100。
mergeWithin?	number	同一合并键相隔多少毫秒内并入上一步，缺省 1000。

方法	说明
now(): number	取当前时间（毫秒），合并相邻修改时用；缺省 Date.now。
describe(operations: readonly FormOperation[], before: FormDocument): HistoryLabel | undefined	没写说明的一步按它的操作与应用前的文档生成说明，如 describeFormOperations；不给时这些步没有说明。

FormEditor

表单编辑模型：当前文档、撤销历史与选择，以及各种编辑操作；不碰 DOM。

属性	类型	说明
document	FormDocument	当前文档。
registry	KindRegistry	按扩展合出的种类登记表。
history	History<FormDocument, FormOperation>	撤销历史：能否撤销、重做，是否有未保存的修改。装载时按新的步数上限重建过的话，这里换成新的一份。
selection	FormSelection	当前的选择。

方法	说明
setExtensions(extensions: readonly FormCoreExtension[]): void	换一组扩展：之后新建、放置与校验都按它；冲突时抛 DesignerExtensionError、什么都不变。
load(document: FormDocument, options?: FormEditorLoadOptions): void	装载新文档：清空历史与选择，剪贴板保留；文档变化的 cause 为 reset。给了与此刻不同的 historyLimit 时按它重建撤销历史，之后的 history 是新的一份。
execute(operations: readonly FormOperation[], options?: ExecuteOptions): FormDocument	执行一组操作并记为一步撤销；返回新文档。
undo(): boolean	撤销一步；没有可撤销的时返回 false。
redo(): boolean	重做一步；没有可重做的时返回 false。
seal(): void	封口：此后带同一合并键的修改另起一步；选择变了时自动封口。
transact<T>(run: () => T, label?: HistoryLabel): T	把 run 里的全部修改合为一步撤销。
markSaved(): void	把当前文档记为已保存，此后 history.dirty 为 false，直到再改。
select(selection: Partial<FormSelection>, mode?: FormSelectMode): void	选中节点或区域：给了非空的 regions 就选区域（只留与第一个同一容器的），否则选 nodes。
clearSelection(): void	清空选择。
canDrop(nodeIds: readonly string[], target: FormDropTarget): boolean	节点能否放到目标位置：目标区域存在，不放进自己或自己的后代，目标区域收这种节点（如子表只收字段）。
canAdd(kind: string, target: FormDropTarget): boolean	种类能否新建到目标位置；种类未登记时为 false。
canPasteAt(clipboard: FormClipboard, target: FormDropTarget): boolean	一段剪贴板内容能否粘贴到目标位置：非空、目标区域收这些节点、种类都已登记。
addNode(kind: string, target?: FormDropTarget, options?: ExecuteOptions): FormNode | undefined	按种类新建节点并选中它；目标缺省为选中节点之后，没有选中时为顶层末尾。种类未登记时抛错；目标不收时返回 undefined。
moveNodes(nodeIds: readonly string[], target: FormDropTarget, options?: ExecuteOptions): boolean	移动一组节点到目标位置，保持它们在文档里的先后；放不下时返回 false。
deleteSelection(options?: ExecuteOptions): boolean	删除选中的节点；选中区域时删除这些区域，删完要少于容器的区域下限或容器是表格布局时不删。什么都没删时返回 false。
setProperty(nodeId: string, group: PropertyGroup, name: string, value: JsonValue | undefined, options?: ExecuteOptions): void	写节点的属性；value 为 undefined 时删除该属性。连续写同一属性合为一步，直到 seal。
setRegionProperty(regionId: string, name: string, value: JsonValue | undefined, options?: ExecuteOptions): void	写区域的属性，合并规则同 setProperty。
setSetting(name: string, value: JsonValue | undefined, options?: ExecuteOptions): void	写表单设置，合并规则同 setProperty。
setKey(nodeId: string, key: string, options?: ExecuteOptions): void	改数据键，合并规则同 setProperty。
addRule(nodeId: string, list: RuleList, rule: FormRuleInit | Omit<LinkageRule, 'id'>, index?: number, options?: ExecuteOptions): ValidationRule | LinkageRule	新增一条规则并返回它；index 缺省为末尾。
updateRule(nodeId: string, list: RuleList, rule: ValidationRule | LinkageRule, options?: ExecuteOptions): void	整条替换规则，连续替换同一条规则合为一步。
removeRule(nodeId: string, list: RuleList, ruleId: string, options?: ExecuteOptions): void	删除一条规则。
moveRule(nodeId: string, list: RuleList, ruleId: string, index: number, options?: ExecuteOptions): void	把一条规则移到 index 处。
addRegion(containerId: string, index?: number, props?: Readonly<Record<string, JsonValue>>, options?: ExecuteOptions): Region	给容器新增一个区域并返回它；index 缺省为末尾，props 覆盖区域属性的缺省值。
removeRegion(regionId: string, options?: ExecuteOptions): void	删除一个区域，连同其中的节点。
moveRegion(regionId: string, index: number, options?: ExecuteOptions): void	把一个区域移到容器里的 index 处。
setGridSpan(regionId: string, span: number, options?: ExecuteOptions): void	设栅格区域的跨度：取整并夹在属性描述的上下限之间。
mergeCells(containerId: string, regionIds: readonly string[], options?: ExecuteOptions): void	合并表格布局的单元格，所选单元格须恰好拼成一个矩形。
splitCell(containerId: string, regionId: string, options?: ExecuteOptions): void	拆分表格布局的单元格。
insertTableLine(containerId: string, axis: TableAxis, at: number, options?: ExecuteOptions): void	在表格布局的第 at 行或列之前插入一行或一列。
removeTableLine(containerId: string, axis: TableAxis, at: number, options?: ExecuteOptions): void	删除表格布局的第 at 行或列。
copy(): FormClipboard | undefined	复制选中的节点；没有选中时返回 undefined。
cut(options?: ExecuteOptions): FormClipboard | undefined	复制并删除选中的节点。
paste(clipboard?: FormClipboard, target?: FormDropTarget, options?: ExecuteOptions): FormSelection	粘贴并选中粘贴出的节点：id 全部换新，与目标作用域冲突的数据键改为派生键。内容缺省为最近一次 copy 的，目标缺省为选中节点之后、没有选中时为顶层末尾；目标不收时什么都不做，返回空选择。
duplicate(options?: ExecuteOptions): FormSelection	复制选中节点并紧跟在原节点之后粘贴，不改动剪贴板。
validate(): readonly FormSchemaIssue[]	按当前登记表做 schema 自校验。
subscribe(listener: (change: FormEditorChange) => void): () => void	订阅文档与选择的变化，返回取消函数。

全部导出

clipboard

名称	种类	说明
checkFormClipboard	函数	检查一段剪贴板内容（如拖来的片段）：节点非空、结构合法、种类在内置种类与 extensions 里、id 不重复时原样返回，否则为 undefined。
decodeFormClipboard	函数	解析剪贴板文本：不是表单的剪贴板包、版本不认得时返回 undefined，内容按 checkFormClipboard 检查。
encodeFormClipboard	函数	把剪贴板内容序列化成剪贴板包的 JSON 文本。
readFormClipboard	函数	从剪贴板事件的数据里读出表单的剪贴板内容：先取表单自己的类型，没有再取 text/plain。
writeFormClipboard	函数	把剪贴板内容写进剪贴板事件的数据：表单自己的类型一份，text/plain 一份。

commands

名称	种类	说明
FORM_COMMANDS	常量	内置命令。
FORM_DESIGNER_HELP_URL	常量	表单文档站上设计器的一页，帮助菜单的「帮助」在新窗口打开它。
FORM_DESIGNER_PANELS	常量	设计器的面板 id：宿主写 defaultLayout、settingsPolicy（layout.panels.<面板 id>）时用；每块面板有一条开关命令 panel:<面板 id>。
FORM_MENU_LAYOUTS	常量	右键菜单各主体的缺省排列；commandLayout 没写 menu:<主体> 时用它。
FORM_SELECTION_LAYOUTS	常量	选中工具条（命令落点 selection:<主体>）的缺省排列：选父级、上移、下移，创建副本、删除。
FORM_TOOLBAR_LAYOUT	常量	工具栏的缺省排列；commandLayout 没写 toolbar 时用它，再把 placement 含 toolbar 的扩展命令追加成一组。
FormDesignerCommand	类型	设计器的命令。
FormDesignerContext	接口	命令、面板与扩展装上时拿到的上下文。
FormMenuSubject	类型	右键菜单落在哪类对象上：节点、区域、表格布局的单元格，或空白处。
FormSelectionSubject	类型	选中工具条落在哪类选中上：眼下只有单个节点。

editor

名称	种类	说明
createFormEditor	函数	创建表单编辑模型。
FormClipboard	接口	剪贴板内容：被复制的节点，按文档顺序，不含被选中节点的后代里重复选中的那些。
FormDropTarget	接口	放置位置：区域 id（null 为文档顶层）与放在该区域现有子节点里的第几个之前，缺省放到末尾。
FormEditor	接口	表单编辑模型：当前文档、撤销历史与选择，以及各种编辑操作；不碰 DOM。
FormEditorChange	类型	编辑模型的变化：文档变化带上历史变化的种类与实际应用的操作；选择变化带上新的选择。
FormEditorLoadOptions	接口	装载新文档时的选项。
FormEditorOptions	接口	创建编辑模型的选项。
FormRuleInit	类型	校验规则或联动规则，不带 id；id 由编辑模型分配。
FormSelection	接口	选择：选中的节点，或同一个容器里的区域（栅格的列、标签页、折叠项、表格单元格），二者互斥，按选中的先后。
FormSelectMode	类型	选择方式：替换、追加或切换。

extensions

名称	种类	说明
createFormDesignerModel	函数	合出设计器用的模型；任何一处重名（设置分区与 general 重名、扩展面板与外框的区重名、扩展面板的开关命令与已有命令重名、引导步骤重名或用了 shell. 前缀、物料来源重名、菜单栏的菜单重名也算）都抛 DesignerExtensionError。
FORM_DESIGNER_EXTENSION	常量	设计器的内置扩展：内置命令、页面结构与历史记录两块面板，以及引导里表单自己的几步。
FormDesignerExtension	接口	表单设计器层的扩展：运行时层的全部字段，加上属性编辑器、命令、面板、物料来源、导入导出与 setup。
FormDesignerModel	接口	一组设计器扩展合出的东西：运行时模型、命令表、属性编辑器表与设置分区。

form-designer

名称	种类	说明
defineFormDesigner	函数	注册 <xh-form-designer> 与它用到的全部元素：渲染器（画布与预览共用）及其库内元素、工具栏与菜单等库内元素、设计器零件；重复调用不报错。
FORM_DESIGNER_TAG	常量	设计器的标签名。
FormDesignerEventMap	接口	设计器派发的事件。
FormDesignerMode	类型	设计态或预览态。
FormPreviewWidth	类型	预览宽度：全宽、平板、手机，设计态画布同样生效。
FormSchemaChangeKind	类型	schema-change 的来源。
XhFormDesigner	类	<xh-form-designer>：可视化编辑表单模板，物料、画布、属性与问题列表都在里面；模板的保存与权限交给宿主，经 schema-change、save 事件与 markSaved() 往来。

history-labels

名称	种类	说明
describeFormOperations	函数	表单编辑模型的 describe：按这一步的正向操作与应用前的文档给出说明，文案经 translations 现取。

kind-icons

名称	种类	说明
FORM_KIND_ICONS	常量	内置种类的图标，键是种类名。

palette

名称	种类	说明
FormCanvasDragPayload	接口	从画布上拖动节点时的数据；owner 是发起拖动的设计器，只在同一个设计器里放下。
FormDragSubject	类型	拖来的东西：新建的种类、未经检查的片段，或本设计器画布上的节点。
FormFragmentDragPayload	接口	拖放片段：任意来源（如扩展的模板库面板）经 startDrag 交来的一段节点，松手时按粘贴的规则换 id 插入。
FormPalettePayload	类型	物料随 item-activate 与拖动交出的数据：新建某个种类，或插入一段片段（如模板库里的一组字段）。

properties

名称	种类	说明
FormPropertyEditor	类型	宿主的属性编辑器，经 editors 压在内建编辑器之上。

version

名称	种类	说明
FORM_DESIGNER_VERSION	常量	@xihan-form/designer 的版本号。