|
|
@@ -1,19 +1,19 @@
|
|
|
---
|
|
|
title: "DatetimePickerComponent"
|
|
|
weight: 10
|
|
|
-date: 2023-07-14T16:57:51.199Z
|
|
|
+date: 2023-07-20T13:56:18.286Z
|
|
|
showtoc: true
|
|
|
generated: true
|
|
|
---
|
|
|
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
|
|
|
+import MemberInfo from '@site/src/components/MemberInfo';
|
|
|
+import GenerationInfo from '@site/src/components/GenerationInfo';
|
|
|
+import MemberDescription from '@site/src/components/MemberDescription';
|
|
|
|
|
|
-# DatetimePickerComponent
|
|
|
-<div class="symbol">
|
|
|
|
|
|
+## DatetimePickerComponent
|
|
|
|
|
|
-# DatetimePickerComponent
|
|
|
-
|
|
|
-{{< generation-info sourceFile="packages/admin-ui/src/lib/core/src/shared/components/datetime-picker/datetime-picker.component.ts" sourceLine="39" packageName="@vendure/admin-ui">}}
|
|
|
+<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/datetime-picker/datetime-picker.component.ts" sourceLine="39" packageName="@vendure/admin-ui" />
|
|
|
|
|
|
A form input for selecting datetime values.
|
|
|
|
|
|
@@ -23,9 +23,7 @@ A form input for selecting datetime values.
|
|
|
<vdr-datetime-picker [(ngModel)]="startDate"></vdr-datetime-picker>
|
|
|
```
|
|
|
|
|
|
-## Signature
|
|
|
-
|
|
|
-```TypeScript
|
|
|
+```ts title="Signature"
|
|
|
class DatetimePickerComponent implements ControlValueAccessor, AfterViewInit, OnInit, OnDestroy {
|
|
|
@Input() @Input() yearRange;
|
|
|
@Input() @Input() weekStartDay: DayOfWeek = 'mon';
|
|
|
@@ -67,7 +65,7 @@ class DatetimePickerComponent implements ControlValueAccessor, AfterViewInit, On
|
|
|
closeDatepicker() => ;
|
|
|
}
|
|
|
```
|
|
|
-## Implements
|
|
|
+Implements
|
|
|
|
|
|
* ControlValueAccessor
|
|
|
* AfterViewInit
|
|
|
@@ -75,237 +73,196 @@ class DatetimePickerComponent implements ControlValueAccessor, AfterViewInit, On
|
|
|
* OnDestroy
|
|
|
|
|
|
|
|
|
-## Members
|
|
|
|
|
|
### yearRange
|
|
|
|
|
|
-{{< member-info kind="property" type="" >}}
|
|
|
+<MemberInfo kind="property" type="" />
|
|
|
|
|
|
-{{< member-description >}}The range above and below the current year which is selectable from
|
|
|
+The range above and below the current year which is selectable from
|
|
|
the year select control. If a min or max value is set, these will
|
|
|
-override the yearRange.{{< /member-description >}}
|
|
|
-
|
|
|
+override the yearRange.
|
|
|
### weekStartDay
|
|
|
|
|
|
-{{< member-info kind="property" type="DayOfWeek" >}}
|
|
|
-
|
|
|
-{{< member-description >}}The day that the week should start with in the calendar view.{{< /member-description >}}
|
|
|
+<MemberInfo kind="property" type="DayOfWeek" />
|
|
|
|
|
|
+The day that the week should start with in the calendar view.
|
|
|
### timeGranularityInterval
|
|
|
|
|
|
-{{< member-info kind="property" type="" >}}
|
|
|
-
|
|
|
-{{< member-description >}}The granularity of the minutes time picker{{< /member-description >}}
|
|
|
+<MemberInfo kind="property" type="" />
|
|
|
|
|
|
+The granularity of the minutes time picker
|
|
|
### min
|
|
|
|
|
|
-{{< member-info kind="property" type="string | null" >}}
|
|
|
-
|
|
|
-{{< member-description >}}The minimum date as an ISO string{{< /member-description >}}
|
|
|
+<MemberInfo kind="property" type="string | null" />
|
|
|
|
|
|
+The minimum date as an ISO string
|
|
|
### max
|
|
|
|
|
|
-{{< member-info kind="property" type="string | null" >}}
|
|
|
-
|
|
|
-{{< member-description >}}The maximum date as an ISO string{{< /member-description >}}
|
|
|
+<MemberInfo kind="property" type="string | null" />
|
|
|
|
|
|
+The maximum date as an ISO string
|
|
|
### readonly
|
|
|
|
|
|
-{{< member-info kind="property" type="" >}}
|
|
|
-
|
|
|
-{{< member-description >}}Sets the readonly state{{< /member-description >}}
|
|
|
+<MemberInfo kind="property" type="" />
|
|
|
|
|
|
+Sets the readonly state
|
|
|
### dropdownComponent
|
|
|
|
|
|
-{{< member-info kind="property" type="<a href='/admin-ui-api/components/dropdown-component#dropdowncomponent'>DropdownComponent</a>" >}}
|
|
|
+<MemberInfo kind="property" type="<a href='/admin-ui-api/components/dropdown-component#dropdowncomponent'>DropdownComponent</a>" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### datetimeInput
|
|
|
|
|
|
-{{< member-info kind="property" type="ElementRef<HTMLInputElement>" >}}
|
|
|
+<MemberInfo kind="property" type="ElementRef<HTMLInputElement>" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### calendarTable
|
|
|
|
|
|
-{{< member-info kind="property" type="ElementRef<HTMLTableElement>" >}}
|
|
|
+<MemberInfo kind="property" type="ElementRef<HTMLTableElement>" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### disabled
|
|
|
|
|
|
-{{< member-info kind="property" type="" >}}
|
|
|
+<MemberInfo kind="property" type="" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### calendarView$
|
|
|
|
|
|
-{{< member-info kind="property" type="Observable<CalendarView>" >}}
|
|
|
+<MemberInfo kind="property" type="Observable<CalendarView>" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### current$
|
|
|
|
|
|
-{{< member-info kind="property" type="Observable<CurrentView>" >}}
|
|
|
+<MemberInfo kind="property" type="Observable<CurrentView>" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### selected$
|
|
|
|
|
|
-{{< member-info kind="property" type="Observable<Date | null>" >}}
|
|
|
+<MemberInfo kind="property" type="Observable<Date | null>" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### selectedHours$
|
|
|
|
|
|
-{{< member-info kind="property" type="Observable<number | null>" >}}
|
|
|
+<MemberInfo kind="property" type="Observable<number | null>" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### selectedMinutes$
|
|
|
|
|
|
-{{< member-info kind="property" type="Observable<number | null>" >}}
|
|
|
+<MemberInfo kind="property" type="Observable<number | null>" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### years
|
|
|
|
|
|
-{{< member-info kind="property" type="number[]" >}}
|
|
|
+<MemberInfo kind="property" type="number[]" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### weekdays
|
|
|
|
|
|
-{{< member-info kind="property" type="string[]" >}}
|
|
|
+<MemberInfo kind="property" type="string[]" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### hours
|
|
|
|
|
|
-{{< member-info kind="property" type="number[]" >}}
|
|
|
+<MemberInfo kind="property" type="number[]" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### minutes
|
|
|
|
|
|
-{{< member-info kind="property" type="number[]" >}}
|
|
|
+<MemberInfo kind="property" type="number[]" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### constructor
|
|
|
|
|
|
-{{< member-info kind="method" type="(changeDetectorRef: ChangeDetectorRef, datetimePickerService: DatetimePickerService) => DatetimePickerComponent" >}}
|
|
|
+<MemberInfo kind="method" type="(changeDetectorRef: ChangeDetectorRef, datetimePickerService: DatetimePickerService) => DatetimePickerComponent" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### ngOnInit
|
|
|
|
|
|
-{{< member-info kind="method" type="() => " >}}
|
|
|
+<MemberInfo kind="method" type="() => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### ngAfterViewInit
|
|
|
|
|
|
-{{< member-info kind="method" type="() => void" >}}
|
|
|
+<MemberInfo kind="method" type="() => void" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### ngOnDestroy
|
|
|
|
|
|
-{{< member-info kind="method" type="() => void" >}}
|
|
|
+<MemberInfo kind="method" type="() => void" />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### registerOnChange
|
|
|
|
|
|
-{{< member-info kind="method" type="(fn: any) => " >}}
|
|
|
+<MemberInfo kind="method" type="(fn: any) => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### registerOnTouched
|
|
|
|
|
|
-{{< member-info kind="method" type="(fn: any) => " >}}
|
|
|
+<MemberInfo kind="method" type="(fn: any) => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### setDisabledState
|
|
|
|
|
|
-{{< member-info kind="method" type="(isDisabled: boolean) => " >}}
|
|
|
+<MemberInfo kind="method" type="(isDisabled: boolean) => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### writeValue
|
|
|
|
|
|
-{{< member-info kind="method" type="(value: string | null) => " >}}
|
|
|
+<MemberInfo kind="method" type="(value: string | null) => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### prevMonth
|
|
|
|
|
|
-{{< member-info kind="method" type="() => " >}}
|
|
|
+<MemberInfo kind="method" type="() => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### nextMonth
|
|
|
|
|
|
-{{< member-info kind="method" type="() => " >}}
|
|
|
+<MemberInfo kind="method" type="() => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### selectToday
|
|
|
|
|
|
-{{< member-info kind="method" type="() => " >}}
|
|
|
+<MemberInfo kind="method" type="() => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### setYear
|
|
|
|
|
|
-{{< member-info kind="method" type="(event: Event) => " >}}
|
|
|
+<MemberInfo kind="method" type="(event: Event) => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### setMonth
|
|
|
|
|
|
-{{< member-info kind="method" type="(event: Event) => " >}}
|
|
|
+<MemberInfo kind="method" type="(event: Event) => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### selectDay
|
|
|
|
|
|
-{{< member-info kind="method" type="(day: DayCell) => " >}}
|
|
|
+<MemberInfo kind="method" type="(day: DayCell) => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### clearValue
|
|
|
|
|
|
-{{< member-info kind="method" type="() => " >}}
|
|
|
+<MemberInfo kind="method" type="() => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### handleCalendarKeydown
|
|
|
|
|
|
-{{< member-info kind="method" type="(event: KeyboardEvent) => " >}}
|
|
|
+<MemberInfo kind="method" type="(event: KeyboardEvent) => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### setHour
|
|
|
|
|
|
-{{< member-info kind="method" type="(event: Event) => " >}}
|
|
|
+<MemberInfo kind="method" type="(event: Event) => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### setMinute
|
|
|
|
|
|
-{{< member-info kind="method" type="(event: Event) => " >}}
|
|
|
+<MemberInfo kind="method" type="(event: Event) => " />
|
|
|
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
|
|
|
### closeDatepicker
|
|
|
|
|
|
-{{< member-info kind="method" type="() => " >}}
|
|
|
-
|
|
|
-{{< member-description >}}{{< /member-description >}}
|
|
|
+<MemberInfo kind="method" type="() => " />
|
|
|
|
|
|
|
|
|
-</div>
|