BasePropDefinition

@lowcode/dsl

---

Interface: BasePropDefinition

Defined in: components/types.ts:17

Базовые поля описания одного пропа компонента.

Эти метаданные используются редакторами, валидаторами и рантаймом, но никак не завязаны на конкретную UI-реализацию.

Extended by

• StringPropDefinition
• NumberPropDefinition
• BooleanPropDefinition
• EnumPropDefinition

Properties

allowExpression?

optional allowExpression: boolean

Defined in: components/types.ts:57

Разрешено ли задавать значение как ExpressionValue.

Если false, проп должен быть только статическим.

---

defaultValue?

optional defaultValue: StaticValue

Defined in: components/types.ts:50

Статическое значение по умолчанию, если проп не задан.

Всегда должно быть JSON-сериализуемым и не может быть ExpressionValue.

---

description?

optional description: string

Defined in: components/types.ts:35

Опциональное описание, которое можно показывать во всплывающих подсказках, документации и т.п.

---

label?

optional label: string

Defined in: components/types.ts:29

Опциональное человекочитаемое название пропа для отображения в редакторе свойств.

---

name

name: string

Defined in: components/types.ts:23

Техническое имя пропа.

Должно совпадать с ключом в ComponentNode.props.

---

required?

optional required: boolean

Defined in: components/types.ts:43

Флаг "обязательности" пропа с точки зрения DSL.

На уровне JSON-схемы проп может отсутствовать, но редактор может подсвечивать такие случаи как предупреждение.