Object Nested Form

WdFormObj

Property Description

External properties received by the component

Property Name	Property Identifier	Type	Description

显示标题	labelVisible	boolean	Default value: true
标题对齐	labelAlign	string	表单场景下默认会跟随表单容器的标题对齐配置
标题换行	labelWrap	boolean	如果标题内容过长关闭时只显示一行、溢出省略；开启时换行展示。表单场景下默认会跟随表单容器的标题换行配置
PC端标题位置	layout	string	设置标题在表单组件的展示位置，表单场景下默认会跟随表单容器的标题的位置配置
标题宽度	labelWidth	string	您可以输入数值 + px、%等单位，示例：200px 表单场景下默认会跟随表单容器的标题宽度配置
标题提示	labelTips	string	PC/H5端生效 配置标题的工具提示内容
状态	status	string	Example: "edit"
绑定字段	name	string	表单字段的Key值，用于提交数据时，匹配数据模型字段标识。表单内需保证唯一。
标题内容	label	string	Example: "标题"
对象嵌套表单值	value		Example: {}
模板	mode	string	Example: "obj"
PC端组件尺寸	size	string	尺寸配置仅对PC端生效，表单场景下默认会跟随表单容器的组件尺寸配置

Event Description

Events exposed by the component. You can listen to component events to trigger external actions

Event Name	Event Code	Event Output Parameters event.detail	Applicable Scenarios	Description

值改变

onDataChange

object data: array

Compatible with all platforms

组件中的数据内容发生改变时触发

Property API

Through the Property API, you can access the internal state and property values of components. You can access internal values using$w.componentId.propertyName, such as $w.input1.value. For details, please refer to Property API

Read-only Property Name	Property Identifier	Type	Description

绑定字段	name	string	表单字段的Key值，用于提交数据时，匹配数据模型字段标识。表单内需保证唯一。
标题内容	label	string
对象嵌套表单值	value
是否展示	visible	boolean	组件是否展示
是否禁用	disabled	boolean	组件是否禁用
是否只读	readOnly	boolean	组件是否只读

Method API

Through the Method API, you can programmatically trigger internal methods of components, such as submitting forms, displaying popups, etc. You can call component methods using $w.componentId.methodName, such as $w.form1.submit()

Method Name	Method Identifier	Parameters	Method Description

值改变

change

object name: string改变值的标识，如果name为空，则会将嵌套表单值直接赋值为进value value: 改变值的value

-

Style API

Through the Style API, you can override the styles of internal elements in components to achieve customization. For example, in the low-code editor, you can write styles for all button components using #wd-page-root .wd-btn, and control individual component styles with :scope. For detailed instructions, please refer toStyle API

Name	Class Name	Description and Examples

根元素	.wd-form-obj-root	组件最外层元素 /* :scope refers to the current component element */ /* For details, refer to the Style API documentation */ :scope.wd-form-obj-root { /* Write CSS styles here */ }
H5 端根元素	.wd-h5-form-obj-root	可设定 H5 端的根元素样式 /* :scope refers to the current component element */ /* For details, refer to the Style API documentation */ :scope.wd-h5-form-obj-root { /* Write CSS styles here */ }
PC 端根元素	.wd-pc-form-obj-root	可设定 PC 端的根元素样式 /* :scope refers to the current component element */ /* For details, refer to the Style API documentation */ :scope.wd-pc-form-obj-root { /* Write CSS styles here */ }
小程序端根元素	.wd-mp-form-obj-root	可设定小程序端的根元素样式 /* :scope refers to the current component element */ /* For details, refer to the Style API documentation */ :scope.wd-mp-form-obj-root { /* Write CSS styles here */ }

Learn about Style API

Usage Example

1. In the data model, create a new object-type field, such as "Product Attributes", and add two sub-properties: "Inventory" and "Price".
2. In the editor, use the "Form Container Component" to see the "Product Attributes" field above automatically mapped to the Object Nested Form component.