Is the field clean?
The field is considered clean if there are no changes from the original.
This is used by the editor to determine if there are changes pending.
Check if the data format is invalid for what the field expects to edit.
Is the field simple?
Complex fields usually have multiple inputs. This is used to determine how the field is shown in non-trivial view. For example, lists will not show a 'simple' view of list items if it uses a complex field.
Has the field passed all relative validation rules.
Key to use to retrieve and save the value in the data.
Unique id value for the field. Usually a shortened form of the UUID.
UUID value for the field.
Current value of the field.
Generates a list of classes to apply to the field element.
Generates a list of classes to apply to the input element.
Generates a list of classes to apply to the label element.
The format of the original value may need to be cleaned up to be used by the editor in a consistent format.
Original value from the source.
Handle when the input loses focus.
Handle when the input changes value.
Input event from changing value.
Determines if the field has lost focus before for a zone.
This is used for UI to determine when to display validation messsages for a better UX when they have not interacted with the field.
Certain cases require the field to be locked while updating to prevent bad data mixing. This allows for manually locking the fields.
Mark that the field has lost focus for a zone.
This is used for UI to determine when to display validation messsages for a better UX when they have not interacted with the field.
Signal for the editor to re-render.
Template for determining how to render the field.
The default field template has several levels of templates to make it easier for individual fields to override parts of template without needing to replicate a lot of internal template features.
Base field template structure:
template
└── templateWrapper
└── templateStructure
├── templateHeaderStructure
│ ├── templateHeader
│ └── templateLabel
├── templateInputStructure
│ └── templateInput
└── templateFooterStructure
└── templateFooter
Selective editor used to render the template.
Data provided to render the template.
Template for showing the invalid data format messaging.
Selective editor used to render the template.
Data provided to render the template.
Template for rendering the errors.
Selective editor used to render the template.
Data provided to render the template.
Zone to provide the error messages for.
Template for rendering the field footer.
Selective editor used to render the template.
Data provided to render the template.
Template for rendering the field footer structure.
Selective editor used to render the template.
Data provided to render the template.
Template for rendering the field header.
Selective editor used to render the template.
Data provided to render the template.
Template for rendering the field header structure.
Selective editor used to render the template.
Data provided to render the template.
Template for rendering the field help.
Selective editor used to render the template.
Data provided to render the template.
Zone to provide the error messages for.
Template for rendering the icon for deep linking.
Selective editor used to render the template.
Data provided to render the template.
Template for rendering the icon for validation.
Selective editor used to render the template.
Data provided to render the template.
Template for rendering the field input.
The help text is part of the input template so complex inputs can use zones for the help text.
Selective editor used to render the template.
Data provided to render the template.
Template for rendering the field input structure.
Selective editor used to render the template.
Data provided to render the template.
Template for rendering the field label.
Selective editor used to render the template.
Data provided to render the template.
Template for rendering the field structure.
Used for controlling the order that parts of the field are rendered.
Selective editor used to render the template.
Data provided to render the template.
Template for rendering the field wrapper.
Selective editor used to render the template.
Data provided to render the template.
Certain cases require the field to be locked while updating to prevent bad data mixing. This allows for manually unlocking the fields.
Use the data passed to render to update the original value. Also update the clean value when applicable.
Selective editor used to render the template.
Data provided to render the template.
Generated using TypeDoc
Selective Generic Field