Date time picker interface.

Hierarchy

Properties

Classes: string[]

Additional CSS classes to add to the control.

Enabled: boolean

Enabled state of the UI element. When the type supports this, the UI element will be disabled when set to false.

EnabledWeekDays: WeekDayConfiguration

Restrict the date time picker to specific days of the week.

Format: string

The format option for the date. Defaults to 'dd MMMM yyyy' if not specified. Supported format:

  • yyyy: 4 digit year
  • yy: 2 digit year
  • MMMM: full month name
  • MMM: short month name
  • MM: 2 digit month
  • M: 1 or 2 digit month
  • dd: 2 digit day
  • d: 1 or 2 digit day
  • EEEE: full day name
  • EEE: short day name
  • Z: timezone offset
  • ww: 2 digit week number
  • w: 1 or 2 digit week number
  • G: era
  • GGGG: full era

In addition it supports template literals between single quotes.

Id: string

The id of the UI element.

MaxDate?: Date

If set, the date time picker will not allow dates after this date.

MinDate?: Date

If set, the date time picker will not allow dates before this date.

Name: string

Name of the UI element. For form fields that would be the name otherwise used for reference only.

OnChange: ((data) => void)

Type declaration

    • (data): void
    • Register a change event handler.

      Parameters

      Returns void

ParentClasses: string[]

Additional CSS classes to add to the parent control when supported.

ReadOnly: boolean

Flag indicating if the input control is readonly (aka cannot be typed directly).

StandardClasses: string[]

The standard classes of the control. Modify this property only if you know what you are doing.

Tags: string[]

Tags for the UI element. Used for reference only.

TextDirection: TextFieldTextDirection

The text direction of the UI element. Defaults to Inherit, meaning it will use the editor default.

ToolTip?: string

Tooltip text of the UI element.

Type: "DateTimePicker"

The type of the UI element. Always "DateTimePicker".

Value: Date

The current value of the date time picker as a Date object.

Visible: boolean

Visibility flag of the UI element. When not visible it will be hidden from the UI.

Generated using TypeDoc