Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListFieldComponent

Hierarchy

Implemented by

Index

Properties

Optional allowAdd

allowAdd?: boolean

Can the list add more items?

Optional allowRemove

allowRemove?: boolean

Can the list remove items?

allowSimple

allowSimple: boolean

Allow simple display for fields in the list.

For complex fields it is better to not allow the simple view since it makes the list crowded and hard to read. (ex: media field)

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.

length

length: number

Number of items in the list.

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

handleAddItem

handleDeleteItem

  • handleDeleteItem(evt: Event, index: number): void
  • Event handler for deleting items.

    Parameters

    • evt: Event

      Click event from delete action.

    • index: number

      Item index being deleted.

    Returns void

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

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

updateOriginal

Generated using TypeDoc