ArcaneFieldMetadata class
Metadata class holding descriptive information for an ArcaneField, used to customize
its appearance and behavior in forms. This class provides keys, labels, icons, and placeholders
that integrate with FieldWrapper for labeled, iconified inputs in the Arcane UI system.
Key features:
- Generates effective keys from name if not provided.
- Supports dynamic placeholders for input hints.
- Immutable design for safe reuse across fields.
Constructors
- ArcaneFieldMetadata({String? name, String? key, IconData? icon, String? description, dynamic placeholder})
-
Constructs metadata with optional parameters for flexible field description.
const
Properties
- description → String?
-
Descriptive text explaining the field's purpose, shown as help text or tooltips.
final
- effectiveKey → String
-
Computes an effective key for the field, prioritizing key, then transforming name
(lowercase, spaces to underscores, slashes to dots), defaulting to "no_key".
Used for identification in forms or data serialization.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- icon → IconData?
-
Icon to visually represent the field type, enhancing UX in form layouts.
final
- key → String?
-
Unique identifier for the field, used in form processing or storage.
If null, derived from name via lowercase, space-to-underscore replacement.
final
- name → String?
-
Human-readable name for the field, displayed as a label in UI components like
FieldWrapper.final - placeholder → dynamic
-
Placeholder value or widget for empty input states, guiding user entry.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited