Skip to main content
Version: 2.0.0-alpha

Interface: DateProperty

Hierarchy

Properties

Field

Optional Field: ComponentType<FieldProps<Date, any, any>>

If you need to render a custom field, you can create a component that takes FieldProps as props. You receive the value, a function to update the value and additional utility props such as if there is an error. You can customize it by passing custom props that are received in the component.

Inherited from

BaseProperty.Field

Defined in

lib/src/models/properties.ts:127


Preview

Optional Preview: ComponentType<PropertyPreviewProps<Date, any>>

Configure how a property is displayed as a preview, e.g. in the collection view. You can customize it by passing custom props that are received in the component.

Inherited from

BaseProperty.Preview

Defined in

lib/src/models/properties.ts:134


autoValue

Optional autoValue: "on_create" | "on_update"

If this flag is set to on_create or on_update this timestamp is updated automatically on creation of the entity only or on every update (including creation). Useful for creating created_on or updated_on fields

Defined in

lib/src/models/properties.ts:529


columnWidth

Optional columnWidth: number

Width in pixels of this column in the collection view. If not set the width is inferred based on the other configurations

Inherited from

BaseProperty.columnWidth

Defined in

lib/src/models/properties.ts:93


customProps

Optional customProps: any

Additional props that are passed to the components defined in field or in preview.

Inherited from

BaseProperty.customProps

Defined in

lib/src/models/properties.ts:140


dataType

dataType: "date"

Datatype of the property

Overrides

BaseProperty.dataType

Defined in

lib/src/models/properties.ts:509


defaultValue

Optional defaultValue: Date

This value will be set by default for new entities.

Inherited from

BaseProperty.defaultValue

Defined in

lib/src/models/properties.ts:145


description

Optional description: string

Property description, always displayed under the field

Inherited from

BaseProperty.description

Defined in

lib/src/models/properties.ts:82


disabled

Optional disabled: boolean | PropertyDisabledConfig

Is this field disabled. When set to true, it gets rendered as a disabled field. You can also specify a configuration for defining the behaviour of disabled properties (including custom messages, clear value on disabled or hide the field completely)

Inherited from

BaseProperty.disabled

Defined in

lib/src/models/properties.ts:113


editable

Optional editable: boolean

Should this property be editable in the collection editor. If the property has been defined in code, it defaults to false otherwise, it defaults to true.

Inherited from

BaseProperty.editable

Defined in

lib/src/models/properties.ts:152


hideFromCollection

Optional hideFromCollection: boolean

Do not show this property in the collection view

Inherited from

BaseProperty.hideFromCollection

Defined in

lib/src/models/properties.ts:98


longDescription

Optional longDescription: string

Longer description of a field, displayed under a popover

Inherited from

BaseProperty.longDescription

Defined in

lib/src/models/properties.ts:87


mode

Optional mode: "date" | "date_time"

Set the granularity of the field to a date or date + time. Defaults to date_time.

Defined in

lib/src/models/properties.ts:516


name

Optional name: string

Property name (e.g. Product)

Inherited from

BaseProperty.name

Defined in

lib/src/models/properties.ts:77


readOnly

Optional readOnly: boolean

Is this a read only property. When set to true, it gets rendered as a preview.

Inherited from

BaseProperty.readOnly

Defined in

lib/src/models/properties.ts:104


validation

Optional validation: DatePropertyValidationSchema

Rules for validating this property

Overrides

BaseProperty.validation

Defined in

lib/src/models/properties.ts:521