StringPropDefinition

@lowcode/dsl

---

Interface: StringPropDefinition

Defined in: components/types.ts:63

Описание строкового пропа.

Extends

• BasePropDefinition

Properties

allowExpression?

optional allowExpression: boolean

Defined in: components/types.ts:57

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

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

Inherited from

BasePropDefinition.allowExpression

---

defaultValue?

optional defaultValue: StaticValue

Defined in: components/types.ts:50

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

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

Inherited from

BasePropDefinition.defaultValue

---

description?

optional description: string

Defined in: components/types.ts:35

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

Inherited from

BasePropDefinition.description

---

format?

optional format: "singleline" | "multiline"

Defined in: components/types.ts:72

Подсказка для UI-редакторов о том, как лучше отображать поле ввода строки.

На сам DSL не влияет.

---

kind

kind: "string"

Defined in: components/types.ts:64

---

label?

optional label: string

Defined in: components/types.ts:29

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

Inherited from

BasePropDefinition.label

---

name

name: string

Defined in: components/types.ts:23

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

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

Inherited from

BasePropDefinition.name

---

required?

optional required: boolean

Defined in: components/types.ts:43

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

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

Inherited from

BasePropDefinition.required