基本概念

基本概念

说明

自定义页面组件

对于魔笔来说，自定义页面组件就是一个react组件+配置文件。在运行时和普通的react组件使用是一样的。

prop

自定义页面组件接受的props字段，是自定义页面组件和魔笔平台交互的边界。

开发自定义页面组件的工作，除了实现组件的UI和功能，主要工作就是设计组件有哪些prop。

prop的类型包括：

1. 基础数据类型： 如boolean/number/string等。

2. 实体字段：指魔笔实体模型的某个字段。设计时只能通过API获取这个字段的描述，运行时可以通过API获取这个字段对应的数据值。 形式上是一个对象，通过API获取数据值。

3. 数据源：描述组件绑定的数据源，如从上下文中获取实体对象、从数据库读取实体对象、从逻辑流获取实体对象。 形式上是一个对象，通过API执行数据源的加载。

4. 事件：如保存当前的实体对象、删除当前的实体对象、跳转页面、触发某个逻辑流。 形式上是一个对象。通过API触发相关的事件。

如果不清楚react组件的props设计，请参见Passing Props to a Component。

自定义页面组件配置文件

在魔笔平台搭建页面时，选中页面的某个组件，可以在右侧的属性设置区域，设置组件的prop。

而配置文件主要就是为了说明组件有哪个prop，并且需要什么样的属性设置器（setter）进行设置。

关于配置文件的详细说明，请参见config配置说明。

属性设置器（setter）

在页面搭建时，设置组件prop具体值的组件，由魔笔控制台管理，根据组件的配置文件创建。

常见的setter有：

1. text文本数据类型数据的设置器。

2. number数字类型数据的设置器。

3. data-field实体字段的设置器。

4. ……

关于全部setter的详细说明，请参见配置setter-configure。