Skip to content

Type Alias: RDateTimeFieldProps

ts
type RDateTimeFieldProps = ExtractPublicPropTypes<
  ReturnType<typeof makeRDateTimeFieldProps>
>;

Type definition for RDateTimeField component props.

Extracted from the props factory to provide type safety for component usage. Includes all VTextField props (except incompatible ones), VDatePicker/VTimePicker options, and custom datetime formatting/display properties with full timezone support.

Key prop categories:

  • VTextField Props: Standard text field properties (label, variant, etc.)
  • VDatePicker Props: Calendar-specific options (min, max, firstDayOfWeek, etc.)
  • VTimePicker Props: Time selection options (format, useSeconds, etc.)
  • Timezone Props: TimezonePicker integration and timezone selection
  • Display Options: displayFormat for Luxon-based datetime formatting
  • Common Field Props: Shared resourceful field properties (multiple, renderMode, etc.)

Example

typescript
const props: RDateTimeFieldProps = {
  modelValue: "2024-01-15T10:30:00-05:00[America/New_York]",
  label: "Meeting Time",
  displayFormat: "fullWithSeconds",
  timePickerFormat: "24hr",
  min: "2024-01-01T00:00:00Z",
  max: "2024-12-31T23:59:59Z",
  showWeek: true,
};