> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 组件属性

> 本页面介绍了自定义组件的属性定义，包括如何通过添加、编辑和删除属性来丰富组件的功能。同时详细说明了每个属性配置项的作用，例如属性标题、名称、类型等，并提供了相关设置器的使用方法。

## 1. 组件属性简介

自定义组件支持属性定义（ propTypes ）操作，用于对组件进行属性层面的丰富，增加自定义属性可定制性的同时使其更加灵活且贴合业务需求。（如图所示1.1-1 所示）

<Frame>
  ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1645410896402-f6c94f2d-4541-465f-9ab6-70db3583ae2b.png)
</Frame>

图1.1-1 组件属性定义入口

组件属性可以通过「添加一项」按钮来进行增加，也可通过「编辑」按钮进行自定义修改，还可通过「删除」按钮进行删减。点击「编辑」按钮可以看到组件属性的所有配置项。（如图1.1-2 所示）

<Frame>
  ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1645411227060-1421248f-5bbd-4e96-8354-7d7aabcc1184.png)
</Frame>

图1.1-2 自定义组件属性定义配置项

所有自定义组件属性定义都可以在组件预览界面（简单类型的属性调试）或安装到应用（复杂的属性配置：包括涉及代码的调试工作）中进行查看与配置。（如图1.1-3 所示）

<Frame>
  ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1645413982854-0cb81b85-06c6-4a18-993b-bf7e7422efa8.png)
</Frame>

图1.1-3 组件属性的预览调试

各个配置项的详细说明请参见下文。

### 1.1 属性标题

给自定义组件配置的属性名称，属性标题的默认名称为「属性标题」，一个简单易懂的标题有助于使用者更好的理解属性的含义或识别需要填报的内容。

<Frame>
  ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1645598852923-8d4155ac-2ca7-48de-a03a-1badea771513.png)
</Frame>

在页面使用该组件时，对应的如下图：

<Frame>
  ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1645599102327-8fe0122a-1a49-4ae8-ba5c-036b9bf7498d.png)
</Frame>

图1.1-4 组件属性在表单设计器的效果演示

### 1.2 属性名称

组件的属性名称是组件的属性 Key，类似组里的 props.xxx。默认值为 propName 。可以在页面设计中进行变量的绑定，从而实现对组件的控制。如自定义组件的属性值作为自定义组件内某一个组件的标题。（如图1.1-5 所示）

<Frame>
  ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1645428115207-cc68769b-d907-497d-91f5-910c11aa5eb3.png)
</Frame>

图1.1-5 属性名称的使用

<Warning>
  **注意：组件的属性名称不可以为空，否则在进行调用或赋值操作时会报错。**
</Warning>

### 1.3 属性类型

组件的属性类型基本类似于常见的数据类型，分别有：**文本、布尔、数字、对象、数组、函数、元素**七种类型，每个数据类型又对应若干个设置器，以满足用户对数据不同维度的处理需求。（如图1.1-6所示）

<Frame>
  ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1645428690018-acc2e2a6-793a-4c51-bd41-7557f967e5d2.png)
</Frame>

图1.1-6 属性类型定义

### 1.4 设置器

不同属性类型的组件拥有不同的属性设置器，实现不同的组件渲染及数据处理方式。如文本类型对应五种设置器。（如图1.1-7 所示）

<Frame>
  ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1645599284247-b71f0cf7-a131-4d2f-8ef1-ed09cc821f37.png)
</Frame>

图1.1-7 组件的属性设置器

### 1.5 默认值

是指当用户访问表单时，表单内自定义组件默认显示的字段。（效果如图1.1-8 所示）

<Frame>
  ![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1645432631641-ba5f2f19-5c98-47a9-9fd4-07ea14ddd54c.png)
</Frame>

图1.1-8 组件属性默认值

### 1.6 是否支持变量绑定

页面设计中的变量绑定。

### 1.7 是否隐藏

控制该属性是否隐藏，一般情况用不到。

### 1.8 当变化时

可以用来做多个属性之间的联动，一般情况用不到。

### 1.9 布局

分为**块（ block ）**与**行内（ inline ）两种**，用于设置该自定义组件在页面内的排列方式。

### 1.10 帮助说明

* 暂时用不到。

### 1.11 帮助连接

* 暂时用不到。
