DateField defines "date" type field to store a single [types.DateTime] value.

The respective zero record field value is the zero [types.DateTime].

Hierarchy

Implements

Constructors

Methods

  • SetHidden implements [Field.SetHidden] interface method.

    Parameters

    • hidden: boolean

    Returns void

  • SetId implements [Field.SetId] interface method.

    Parameters

    • id: string

    Returns void

  • SetName implements [Field.SetName] interface method.

    Parameters

    • name: string

    Returns void

  • SetSystem implements [Field.SetSystem] interface method.

    Parameters

    • system: boolean

    Returns void

Properties

hidden: boolean

Hidden hides the field from the API response.

id: string

Id is the unique stable field identifier.

It is automatically generated from the name when adding to a collection FieldsList.

Max specifies the max allowed field value.

Leave it empty to skip the validator.

Min specifies the min allowed field value.

Leave it empty to skip the validator.

name: string

Name (required) is the unique name of the field.

presentable: boolean

Presentable hints the Dashboard UI to use the underlying field record value in the relation preview label.

required: boolean

Required will require the field value to be non-zero [types.DateTime].

system: boolean

System prevents the renaming and removal of the field.

Generated using TypeDoc