Skip to content
🤷

Forgive us! These docs are a work in progress. Some pages may be incomplete or describe features that aren't quite finished yet. Farkitect is in early development and we don't recommend using it for real work just yet. Feel free to explore — just be aware that things are still being built.

Property Types & Validation

TypeStoresUI ControlExample Values
StringShort textText input”FQ Vessels”, “Active”
IntegerWhole numbersNumber input42, 0, -1
RealDecimal numbersNumber input3.14, 99.99
BooleanTrue/falseCheckboxtrue, false
DateCalendar dateDate picker2026-03-15
DateTimeTimestampDateTime picker2026-03-15T14:30:00
UnlimitedNaturalNon-negative integer or *Text input0, 1, *

A property type with a fixed list of allowed values. Each value has:

  • name — display label shown in UI (e.g., “Active”)
  • value — machine value stored in model (e.g., “active”)

Enumeration properties render as dropdown selects in the Properties panel and catalogs.

HintEffect
multilineRenders as a textarea instead of single-line input
urlRenders as a clickable hyperlink
emailRenders as a clickable mailto link

Format hints don’t change the stored value — it’s always a string.

ValueMeaningBehaviour
[1, 1]RequiredMust have a value; flagged by validation if empty
[0, 1]OptionalMay be empty

Properties can define a default value at M2. When a new M1 instance is created, the property is pre-filled with this value. The default must be a valid value for the property’s data type.

For enumerations, the default is the machine value (e.g., “active”), not the display name.

RuleWhen checkedBehaviour
RequiredOn edit + integrity checkEmpty required properties flagged
Type matchOn editInvalid values rejected (e.g., text in Integer field)
EnumerationOn editOnly defined literal values accepted
FormatOn displayFormat hints affect rendering, not validation