Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FieldComponent

Selective Generic Field

Hierarchy

Implemented by

Index

Properties

isClean

isClean: boolean

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.

isDataFormatValid

isDataFormatValid: boolean

Is the data provided to the field in the correct format?

If a field recieves data that is not in the format expected the field will show a message instead of the normal inputs.

isSimple

isSimple: boolean

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.

isValid

isValid: boolean

Has the field passed all relative validation rules.

key

key: string

Key to use to retrieve and save the value in the data.

template

template: Template

Template for rendering the field.

uid

uid: string

Unique id value for the field. Usually a shortened form of the UUID.

uuid

uuid: string

UUID value for the field.

value

value: any

Current value of the field.

Methods

hasLostFocus

  • hasLostFocus(zoneKey?: string): boolean
  • Track when an input has lost focus.

    This allows for the UI to only show an error message after the user has attempted to change the value.

    Parameters

    • Optional zoneKey: string

    Returns boolean

lock

  • lock(): void
  • Internal lock for fields that can get messed up. For example list fields.

    Returns void

lostFocus

  • lostFocus(zoneKey?: string): void
  • Mark the zone as having lost focus.

    This allows for the UI to only show an error message after the user has attempted to change the value.

    Parameters

    • Optional zoneKey: string

    Returns void

render

  • render(): void

unlock

  • unlock(): void
  • Internal unlock for fields that can get messed up. For example list fields.

    Returns void

updateOriginal

Generated using TypeDoc