github/lowcode-engine
1
0
Fork 0
mirror of https://github.com/alibaba/lowcode-engine.git synced 2026-02-09 15:55:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: material spec add ignoreDefaultValue field to component property description

Browse Source
This commit is contained in:
liujuping 2023-03-15 10:44:16 +08:00 committed by 林熠
parent eeb6719a1f
commit 9597b1c376
3 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/docs/specs/material-spec.md
View File

@ -834,6 +834,7 @@ props 数组下对象字段描述：
| defaultValue | 默认值 | Any(视字段类型而定) | type = 'field' 生效 | | defaultValue | 默认值 | Any(视字段类型而定) | type = 'field' 生效 |
| supportVariable | 是否支持配置变量 | Boolean | type = 'field' 生效 | | supportVariable | 是否支持配置变量 | Boolean | type = 'field' 生效 |
| condition | 配置当前 prop 是否展示 | (target: IPublicModelSettingField) => boolean; | - | | condition | 配置当前 prop 是否展示 | (target: IPublicModelSettingField) => boolean; | - |
| ignoreDefaultValue | 配置当前 prop 是否忽略默认值处理逻辑，如果返回值是 true 引擎不会处理默认值 | (target: IPublicModelSettingField) => boolean; | - |
| setter | 单个控件 (setter) 描述，搭建基础协议组件的描述对象，支持 JSExpression / JSFunction / JSSlot | `String\|Object\|Function` | type = 'field' 生效 | | setter | 单个控件 (setter) 描述，搭建基础协议组件的描述对象，支持 JSExpression / JSFunction / JSSlot | `String\|Object\|Function` | type = 'field' 生效 |
| extraProps | 其他配置属性（不做流通要求） | Object | 其他配置 | | extraProps | 其他配置属性（不做流通要求） | Object | 其他配置 |
| extraProps.getValue | setter 渲染时被调用，setter 会根据该函数的返回值设置 setter 当前值 | Function | (target: IPublicModelSettingField, value: any) => any; | | extraProps.getValue | setter 渲染时被调用，setter 会根据该函数的返回值设置 setter 当前值 | Function | (target: IPublicModelSettingField, value: any) => any; |

13
packages/editor-skeleton/src/components/settings/settings-pane.tsx
View File

@ -88,6 +88,18 @@ class SettingFieldView extends Component<SettingFieldViewProps, SettingFieldView
return true; return true;
} }
get ignoreDefaultValue(): boolean {
const { extraProps } = this.field;
const { ignoreDefaultValue } = extraProps;
try {
return typeof ignoreDefaultValue === 'function' ? ignoreDefaultValue(this.field.internalToShell()) : false;
} catch (error) {
console.error('exception when ignoreDefaultValue is excuted', error);
}
return false;
}
get setterInfo(): { get setterInfo(): {
setterProps: any; setterProps: any;
initialValue: any; initialValue: any;
@ -171,6 +183,7 @@ class SettingFieldView extends Component<SettingFieldViewProps, SettingFieldView
const { initialValue } = this.setterInfo; const { initialValue } = this.setterInfo;
if (this.state?.fromOnChange || if (this.state?.fromOnChange ||
!isInitialValueNotEmpty(initialValue) || !isInitialValueNotEmpty(initialValue) ||
this.ignoreDefaultValue ||
this.value !== undefined this.value !== undefined
) { ) {
return; return;

6
packages/types/src/shell/type/field-extra-props.ts
View File

@ -32,6 +32,12 @@ export interface IPublicTypeFieldExtraProps {
*/ */
condition?: (target: IPublicModelSettingField) => boolean; condition?: (target: IPublicModelSettingField) => boolean;
/**
* 配置当前 prop 是否忽略默认值处理逻辑，如果返回值是 true 引擎不会处理默认值
* @returns boolean
*/
ignoreDefaultValue?: (target: IPublicModelSettingField) => boolean;
/** /**
* autorun when something change * autorun when something change
*/ */