API Reference
Quick reference tables for all Property System types.
Property Types
| Class | Type T | Default | Builder Method |
|---|---|---|---|
StringProperty | String | '' | string() |
IntProperty | int | 0 | integer() |
DoubleProperty | double | 0.0 | decimal() |
BoolProperty | bool | false | boolean() |
DateTimeProperty | DateTime | DateTime.now() | dateTime() |
OptionalStringProperty | String? | null | optionalText() |
OptionalIntProperty | int? | null | optionalInteger() |
OptionalDoubleProperty | double? | null | optionalDecimal() |
OptionalBoolProperty | bool? | null | optionalBoolean() |
OptionalDateTimeProperty | DateTime? | null | optionalDateTime() |
EnumProperty<T> | T | First option | enumeration<T>() |
ListProperty<T> | List<T> | [] | list<T>() |
UnionProperty | String | Selected key | (constructor) |
ReadOnlyProperty<T> | T | Required | readonly<T>() |
Conditions
| Class | Dependencies | Builder Shorthand |
|---|---|---|
EqualsCondition<T> | [key] | when<T>(key, value) |
NotEqualsCondition<T> | [key] | whenNot<T>(key, value) |
InCondition<T> | [key] | whenIn<T>(key, values) |
NotInCondition<T> | [key] | whenNotIn<T>(key, values) |
HasValueCondition | [key] | whenHasValue(key) |
ComparisonCondition<T> | [key] | whenGreaterThan<T>() / whenLessThan<T>() |
AndCondition | Union | whenAll(conditions) |
OrCondition | Union | whenAny(conditions) |
NotCondition | Child | (constructor) |
AlwaysTrueCondition | [] | (constructor) |
AlwaysFalseCondition | [] | (constructor) |
CustomCondition | Explicit | whenCustom(deps, fn) |
Validators
| Factory Method | Type T | Error Key |
|---|---|---|
required() | dynamic | required |
min(value) | num | min |
max(value) | num | max |
minLength(length) | String | minLength |
maxLength(length) | String | maxLength |
pattern(regex) | String | pattern |
identifier() | String | pattern |
email() | String | email |
custom(fn) | T | User-defined |
JSON Converters
| Converter | Type | JSON Format |
|---|---|---|
StringJsonConverter | String | "text" |
IntJsonConverter | int | 42 |
DoubleJsonConverter | double | 3.14 |
BoolJsonConverter | bool | true / false |
DateTimeJsonConverter | DateTime | ISO 8601 string |
NullableJsonConverter<T> | T? | Wraps inner converter |
EnumJsonConverter<T> | T extends Enum | "enumName" |
EnumOptionsJsonConverter<T> | T | "valueName" |
ListJsonConverter<T> | List<T> | [...] |
UnionJsonConverter | String | "key" |
Collection & Builder
| Class | Purpose |
|---|---|
PropertyCollection | Container for properties with validation, conditions, serialization |
PropertyGroup | Named group for visual organization |
PropertyCollectionBuilder | Fluent builder for constructing collections |
PropertyCollectionEditor | Widget for rendering editable property forms |
PropertyDerivation | Auto-computed property value definition |
Registry
| Method | Description |
|---|---|
PropertySystem.register<T>(editor:, converter:, key:) | Register editor and/or converter |
PropertySystem.getEditor<T>(customKey) | Look up editor |
PropertySystem.getConverter<T>(customKey) | Look up converter |
PropertySystem.isRegistered<T>(customKey) | Check both editor and converter |
PropertySystem.hasEditor<T>(customKey) | Check editor only |
PropertySystem.hasConverter<T>(customKey) | Check converter only |
PropertySystem.validate() | Return warnings for incomplete registrations |
PropertySystem.clear() | Clear all registrations |