@skyux/datetime 7.5.0 → 7.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/documentation.json +68 -68
  2. package/esm2020/lib/modules/date-range-picker/date-range-picker.component.mjs +6 -6
  3. package/esm2020/lib/modules/date-range-picker/types/date-range-calculation.mjs +1 -1
  4. package/esm2020/lib/modules/date-range-picker/types/date-range-calculator-type.mjs +2 -2
  5. package/esm2020/lib/modules/date-range-picker/types/date-range-calculator.mjs +2 -2
  6. package/esm2020/lib/modules/date-range-picker/types/date-range.mjs +1 -1
  7. package/esm2020/lib/modules/datepicker/datepicker-calendar-change.mjs +1 -1
  8. package/esm2020/lib/modules/datepicker/datepicker-config.service.mjs +2 -2
  9. package/esm2020/lib/modules/datepicker/datepicker-custom-date.mjs +1 -1
  10. package/esm2020/lib/modules/datepicker/datepicker-input-fuzzy.directive.mjs +9 -9
  11. package/esm2020/lib/modules/datepicker/datepicker-input.directive.mjs +8 -8
  12. package/esm2020/lib/modules/datepicker/datepicker.service.mjs +2 -2
  13. package/esm2020/lib/modules/datepicker/daypicker-button.component.mjs +1 -1
  14. package/esm2020/lib/modules/datepicker/daypicker-cell.component.mjs +1 -1
  15. package/esm2020/lib/modules/datepicker/fuzzy-date.mjs +1 -1
  16. package/esm2020/lib/modules/timepicker/timepicker.directive.mjs +3 -3
  17. package/esm2020/lib/modules/timepicker/timepicker.interface.mjs +1 -1
  18. package/fesm2015/skyux-datetime.mjs +26 -26
  19. package/fesm2015/skyux-datetime.mjs.map +1 -1
  20. package/fesm2020/skyux-datetime.mjs +26 -26
  21. package/fesm2020/skyux-datetime.mjs.map +1 -1
  22. package/lib/modules/date-range-picker/date-range-picker.component.d.ts +6 -6
  23. package/lib/modules/date-range-picker/types/date-range-calculation.d.ts +1 -1
  24. package/lib/modules/date-range-picker/types/date-range-calculator-type.d.ts +1 -1
  25. package/lib/modules/date-range-picker/types/date-range-calculator.d.ts +4 -4
  26. package/lib/modules/date-range-picker/types/date-range.d.ts +2 -2
  27. package/lib/modules/datepicker/datepicker-calendar-change.d.ts +1 -1
  28. package/lib/modules/datepicker/datepicker-config.service.d.ts +4 -4
  29. package/lib/modules/datepicker/datepicker-custom-date.d.ts +2 -2
  30. package/lib/modules/datepicker/datepicker-input-fuzzy.directive.d.ts +8 -8
  31. package/lib/modules/datepicker/datepicker-input.directive.d.ts +7 -7
  32. package/lib/modules/datepicker/datepicker.service.d.ts +1 -1
  33. package/lib/modules/datepicker/daypicker-button.component.d.ts +1 -1
  34. package/lib/modules/datepicker/daypicker-cell.component.d.ts +2 -2
  35. package/lib/modules/datepicker/fuzzy-date.d.ts +3 -3
  36. package/lib/modules/timepicker/timepicker.directive.d.ts +3 -3
  37. package/lib/modules/timepicker/timepicker.interface.d.ts +7 -7
  38. package/package.json +8 -8
@@ -20,14 +20,14 @@ import * as i0 from "@angular/core";
20
20
  export declare class SkyDateRangePickerComponent implements OnInit, OnChanges, OnDestroy, ControlValueAccessor, Validator {
21
21
  #private;
22
22
  /**
23
- * Specifies IDs for the date range options to include in the picker's dropdown.
23
+ * IDs for the date range options to include in the picker's dropdown.
24
24
  * The options specify calculator objects that return two `Date` objects to represent date ranges.
25
25
  * By default, this property includes all `SkyDateRangeCalculatorId` values.
26
26
  */
27
27
  set calculatorIds(value: SkyDateRangeCalculatorId[] | undefined);
28
28
  get calculatorIds(): SkyDateRangeCalculatorId[];
29
29
  /**
30
- * Specifies a date format for
30
+ * The date format for
31
31
  * [the `sky-datepicker` components](https://developer.blackbaud.com/skyux/components/datepicker)
32
32
  * that make up the date range picker. The text input is a composite component of
33
33
  * up to two `sky-datepicker` components.
@@ -36,23 +36,23 @@ export declare class SkyDateRangePickerComponent implements OnInit, OnChanges, O
36
36
  set dateFormat(value: string | undefined);
37
37
  get dateFormat(): string | undefined;
38
38
  /**
39
- * Indicates whether to disable the date range picker.
39
+ * Whether to disable the date range picker.
40
40
  * @default false
41
41
  */
42
42
  set disabled(value: boolean | undefined);
43
43
  get disabled(): boolean | undefined;
44
44
  /**
45
- * Specifies a label for the date range picker.
45
+ * The label for the date range picker.
46
46
  * @required
47
47
  */
48
48
  label: string | undefined;
49
49
  /**
50
- * Indicates whether to require users to specify a start date.
50
+ * Whether to require users to specify a start date.
51
51
  * @default false
52
52
  */
53
53
  startDateRequired: boolean | undefined;
54
54
  /**
55
- * Indicates whether to require users to specify a end date.
55
+ * Whether to require users to specify a end date.
56
56
  * @default false
57
57
  */
58
58
  endDateRequired: boolean | undefined;
@@ -5,7 +5,7 @@ import { SkyDateRangeCalculatorId } from './date-range-calculator-id';
5
5
  */
6
6
  export interface SkyDateRangeCalculation extends SkyDateRange {
7
7
  /**
8
- * Specifies the calculator that determines the dates in the date range.
8
+ * The calculator that determines the dates in the date range.
9
9
  */
10
10
  calculatorId: SkyDateRangeCalculatorId;
11
11
  }
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Indicates the types of calculations available for a date range calculator.
2
+ * The types of calculations available for a date range calculator.
3
3
  */
4
4
  export declare enum SkyDateRangeCalculatorType {
5
5
  /**
@@ -10,20 +10,20 @@ import { SkyDateRangeCalculatorType } from './date-range-calculator-type';
10
10
  export declare class SkyDateRangeCalculator {
11
11
  #private;
12
12
  /**
13
- * Provides a calculator ID to specify calculator objects that represent date ranges.
13
+ * The calculator ID that specifies calculator objects that represent date ranges.
14
14
  */
15
15
  readonly calculatorId: SkyDateRangeCalculatorId;
16
16
  /**
17
- * Specifies the text to display in the calculator select menu.
17
+ * The text to display in the calculator select menu.
18
18
  */
19
19
  readonly shortDescription: string;
20
20
  /**
21
- * Specifies the type of calculations available for the date range.
21
+ * The type of calculations available for the date range.
22
22
  */
23
23
  readonly type: SkyDateRangeCalculatorType;
24
24
  constructor(
25
25
  /**
26
- * Provides a calculator ID to specify calculator objects that represent date ranges.
26
+ * The calculator ID that specifies calculator objects that represent date ranges.
27
27
  */
28
28
  calculatorId: SkyDateRangeCalculatorId, config: SkyDateRangeCalculatorConfig);
29
29
  /**
@@ -1,10 +1,10 @@
1
1
  export interface SkyDateRange {
2
2
  /**
3
- * Specifies the last date in the date range.
3
+ * The last date in the date range.
4
4
  */
5
5
  endDate?: Date | null;
6
6
  /**
7
- * Specifies the first date in the date range.
7
+ * The first date in the date range.
8
8
  */
9
9
  startDate?: Date | null;
10
10
  }
@@ -13,7 +13,7 @@ export interface SkyDatepickerCalendarChange {
13
13
  */
14
14
  startDate: Date;
15
15
  /**
16
- * Provides an observable that allows the consumer to push custom dates back to the calendar
16
+ * The observable that allows the consumer to push custom dates back to the calendar
17
17
  * when the `SkyCalendarDateRangeChangeEvent` event fires. This is useful
18
18
  * for displaying key dates or disabled dates each time the calendar changes. If disabled dates
19
19
  * are provided, SKY UX will prevent the user from selecting the date from the calendar.
@@ -1,20 +1,20 @@
1
1
  import * as i0 from "@angular/core";
2
2
  export declare class SkyDatepickerConfigService {
3
3
  /**
4
- * Specifies the date format for the input.
4
+ * The date format for the input.
5
5
  * @default "MM/DD/YYYY"
6
6
  */
7
7
  dateFormat: string | undefined;
8
8
  /**
9
- * Specifies the latest selectable date that is available in the calendar.
9
+ * The latest selectable date that is available in the calendar.
10
10
  */
11
11
  maxDate: Date | undefined;
12
12
  /**
13
- * Specifies the earliest selectable date that is available in the calendar.
13
+ * The earliest selectable date that is available in the calendar.
14
14
  */
15
15
  minDate: Date | undefined;
16
16
  /**
17
- * Specifies the starting day of the week in the calendar,
17
+ * The starting day of the week in the calendar,
18
18
  * where `0` sets the starting day to Sunday.
19
19
  * @default 0
20
20
  */
@@ -7,11 +7,11 @@ export interface SkyDatepickerCustomDate {
7
7
  */
8
8
  date: Date;
9
9
  /**
10
- * Indicates whether to disable the date.
10
+ * Whether to disable the date.
11
11
  */
12
12
  disabled?: boolean;
13
13
  /**
14
- * Indicates whether to display the date as a key date in the calendar.
14
+ * Whether to display the date as a key date in the calendar.
15
15
  */
16
16
  keyDate?: boolean;
17
17
  /**
@@ -9,27 +9,27 @@ import * as i0 from "@angular/core";
9
9
  export declare class SkyFuzzyDatepickerInputDirective implements OnInit, OnDestroy, AfterViewInit, AfterContentInit, ControlValueAccessor, Validator {
10
10
  #private;
11
11
  /**
12
- * Specifies the date format for the input. Place this attribute on the `input` element
12
+ * The date format for the input. Place this attribute on the `input` element
13
13
  * to override the default in `SkyDatepickerConfigService`.
14
14
  * @default "MM/DD/YYYY"
15
15
  */
16
16
  set dateFormat(value: string | undefined);
17
17
  get dateFormat(): string | undefined;
18
18
  /**
19
- * Indicates whether to disable the datepicker.
19
+ * Whether to disable the datepicker.
20
20
  * @default false
21
21
  */
22
22
  set disabled(value: boolean | undefined);
23
23
  get disabled(): boolean | undefined;
24
24
  /**
25
- * Indicates whether to prevent users from specifying dates that are in the future.
25
+ * Whether to prevent users from specifying dates that are in the future.
26
26
  * Place this attribute on the `input` element.
27
27
  * @default false
28
28
  */
29
29
  set futureDisabled(value: boolean | undefined);
30
30
  get futureDisabled(): boolean | undefined;
31
31
  /**
32
- * Specifies the latest fuzzy date allowed. Place this attribute on the `input` element
32
+ * The latest fuzzy date allowed. Place this attribute on the `input` element
33
33
  * to prevent fuzzy dates after a specified date. This property accepts
34
34
  * a `SkyFuzzyDate` value that includes numeric month, day, and year values.
35
35
  * For example: `{ month: 1, day: 1, year: 2027 }`.
@@ -37,7 +37,7 @@ export declare class SkyFuzzyDatepickerInputDirective implements OnInit, OnDestr
37
37
  set maxDate(value: SkyFuzzyDate | undefined);
38
38
  get maxDate(): SkyFuzzyDate | undefined;
39
39
  /**
40
- * Specifies the earliest fuzzy date allowed. Place this attribute on the `input` element
40
+ * The earliest fuzzy date allowed. Place this attribute on the `input` element
41
41
  * to prevent fuzzy dates before a specified date. This property accepts a `SkyFuzzyDate` value
42
42
  * that includes numeric month, day, and year values.
43
43
  * For example: `{ month: 1, day: 1, year: 2007 }`.
@@ -45,12 +45,12 @@ export declare class SkyFuzzyDatepickerInputDirective implements OnInit, OnDestr
45
45
  set minDate(value: SkyFuzzyDate | undefined);
46
46
  get minDate(): SkyFuzzyDate | undefined;
47
47
  /**
48
- * Indicates whether to disable date validation on the fuzzy datepicker input.
48
+ * Whether to disable date validation on the fuzzy datepicker input.
49
49
  * @default false
50
50
  */
51
51
  skyDatepickerNoValidate: boolean | undefined;
52
52
  /**
53
- * Specifies the starting day of the week in the calendar, where `0` sets the starting day
53
+ * The starting day of the week in the calendar, where `0` sets the starting day
54
54
  * to Sunday. Place this attribute on the `input` element to override the default
55
55
  * in `SkyDatepickerConfigService`.
56
56
  * @default 0
@@ -58,7 +58,7 @@ export declare class SkyFuzzyDatepickerInputDirective implements OnInit, OnDestr
58
58
  set startingDay(value: number | undefined);
59
59
  get startingDay(): number;
60
60
  /**
61
- * Indicates whether to require the year in fuzzy dates.
61
+ * Whether to require the year in fuzzy dates.
62
62
  * @default false
63
63
  */
64
64
  set yearRequired(value: boolean | undefined);
@@ -8,26 +8,26 @@ import * as i0 from "@angular/core";
8
8
  export declare class SkyDatepickerInputDirective implements OnInit, OnDestroy, AfterViewInit, AfterContentInit, ControlValueAccessor, Validator {
9
9
  #private;
10
10
  /**
11
- * Specifies the date format for the input. Place this attribute on the `input` element
11
+ * The date format for the input. Place this attribute on the `input` element
12
12
  * to override the default in the `SkyDatepickerConfigService`.
13
13
  * @default "MM/DD/YYYY"
14
14
  */
15
15
  set dateFormat(value: string | undefined);
16
16
  get dateFormat(): string | undefined;
17
17
  /**
18
- * Indicates whether to disable the datepicker.
18
+ * Whether to disable the datepicker.
19
19
  * @default false
20
20
  */
21
21
  set disabled(value: boolean | undefined);
22
22
  get disabled(): boolean;
23
23
  /**
24
- * Specifies the latest date that is available in the calendar. Place this attribute on
24
+ * The latest date that is available in the calendar. Place this attribute on
25
25
  * the `input` element to override the default in `SkyDatepickerConfigService`.
26
26
  */
27
27
  set maxDate(value: Date | undefined);
28
28
  get maxDate(): Date | undefined;
29
29
  /**
30
- * Specifies the earliest date that is available in the calendar. Place this attribute on
30
+ * The earliest date that is available in the calendar. Place this attribute on
31
31
  * the `input` element to override the default in `SkyDatepickerConfigService`. To avoid validation errors, the time associated with the minimum date must be midnight. This is necessary because the datepicker automatically sets the time on the `Date` object for selected dates to midnight in the current user's time zone.
32
32
  */
33
33
  set minDate(value: Date | undefined);
@@ -40,12 +40,12 @@ export declare class SkyDatepickerInputDirective implements OnInit, OnDestroy, A
40
40
  */
41
41
  set skyDatepickerInput(value: SkyDatepickerComponent | undefined | '');
42
42
  /**
43
- * Indicates whether to disable date validation on the datepicker input.
43
+ * Whether to disable date validation on the datepicker input.
44
44
  * @default false
45
45
  */
46
46
  skyDatepickerNoValidate: boolean | undefined;
47
47
  /**
48
- * Specifies the starting day of the week in the calendar, where `0` sets the starting day
48
+ * The starting day of the week in the calendar, where `0` sets the starting day
49
49
  * to Sunday. Place this attribute on the `input` element to override the default
50
50
  * in `SkyDatepickerConfigService`.
51
51
  * @default 0
@@ -53,7 +53,7 @@ export declare class SkyDatepickerInputDirective implements OnInit, OnDestroy, A
53
53
  set startingDay(value: number | undefined);
54
54
  get startingDay(): number;
55
55
  /**
56
- * Indicates whether the format of the date value must match the format from the `dateFormat` value.
56
+ * Whether the format of the date value must match the format from the `dateFormat` value.
57
57
  * If this property is `true` and the datepicker input directive cannot find an exact match, then
58
58
  * the input is marked as invalid.
59
59
  * If this property is `false` and the datepicker input directive cannot find an exact match, then
@@ -6,7 +6,7 @@ import * as i0 from "@angular/core";
6
6
  */
7
7
  export declare class SkyDatepickerService {
8
8
  /**
9
- * Specifies if a key date popover is currently displayed.
9
+ * Whether a key date popover is currently displayed.
10
10
  * Useful for communicating across all daypicker siblings when a popover is displayed.
11
11
  */
12
12
  keyDatePopoverStream: Subject<SkyDatepickerDate | undefined>;
@@ -7,7 +7,7 @@ import * as i0 from "@angular/core";
7
7
  export declare class SkyDayPickerButtonComponent {
8
8
  datepicker: SkyDatepickerCalendarInnerComponent;
9
9
  /**
10
- * Specifies the date this picker button will represent on the calendar.
10
+ * The date this picker button will represent on the calendar.
11
11
  */
12
12
  date: SkyDatepickerDate | undefined;
13
13
  constructor(datepicker: SkyDatepickerCalendarInnerComponent);
@@ -11,11 +11,11 @@ import * as i0 from "@angular/core";
11
11
  export declare class SkyDayPickerCellComponent implements OnInit, OnDestroy {
12
12
  #private;
13
13
  /**
14
- * Specifies if the active date has been changed.
14
+ * Whether the active date has been changed.
15
15
  */
16
16
  activeDateHasChanged: boolean | undefined;
17
17
  /**
18
- * Specifies the date this picker cell will represent on the calendar.
18
+ * The date this picker cell will represent on the calendar.
19
19
  */
20
20
  date: SkyDatepickerDate | undefined;
21
21
  hasTooltip: boolean;
@@ -1,15 +1,15 @@
1
1
  export interface SkyFuzzyDate {
2
2
  /**
3
- * Specifies the day in a fuzzy date, where `1` sets the day
3
+ * The day in a fuzzy date, where `1` sets the day
4
4
  * to the first day of the specified month.
5
5
  */
6
6
  day?: number;
7
7
  /**
8
- * Specifies the month in a fuzzy date, where `1` sets the month to January.
8
+ * The month in a fuzzy date, where `1` sets the month to January.
9
9
  */
10
10
  month?: number;
11
11
  /**
12
- * Specifies the year in a fuzzy date.
12
+ * The year in a fuzzy date.
13
13
  */
14
14
  year?: number;
15
15
  }
@@ -16,18 +16,18 @@ export declare class SkyTimepickerInputDirective implements OnInit, OnDestroy, C
16
16
  get skyTimepickerInput(): SkyTimepickerComponent | undefined;
17
17
  set skyTimepickerInput(value: SkyTimepickerComponent | undefined);
18
18
  /**
19
- * Specifies the 12-hour `hh` or 24-hour `HH` time format for the input.
19
+ * The 12-hour `hh` or 24-hour `HH` time format for the input.
20
20
  * @default "hh"
21
21
  */
22
22
  set timeFormat(value: string | undefined);
23
23
  get timeFormat(): string;
24
24
  /**
25
- * Specifies a custom time format. For examples,
25
+ * The custom time format. For examples,
26
26
  * see the [moment.js](https://momentjs.com/docs/#/displaying/format/) docs.
27
27
  */
28
28
  returnFormat: string | undefined;
29
29
  /**
30
- * Indicates whether to disable the timepicker.
30
+ * Whether to disable the timepicker.
31
31
  * @default false
32
32
  */
33
33
  get disabled(): boolean;
@@ -1,30 +1,30 @@
1
1
  export interface SkyTimepickerTimeOutput {
2
2
  /**
3
- * Specifies the hour.
3
+ * The hour.
4
4
  */
5
5
  hour: number;
6
6
  /**
7
- * Specifies the minute.
7
+ * The minute.
8
8
  */
9
9
  minute: number;
10
10
  /**
11
- * Specifies the meridian (`AM` or `PM`).
11
+ * The meridian (`AM` or `PM`).
12
12
  */
13
13
  meridie: string;
14
14
  /**
15
- * Specifies the time zone.
15
+ * The time zone.
16
16
  */
17
17
  timezone: number;
18
18
  /**
19
- * Specifies the date in [iso8601 format](https://www.iso.org/iso-8601-date-and-time-format.html).
19
+ * The date in [iso8601 format](https://www.iso.org/iso-8601-date-and-time-format.html).
20
20
  */
21
21
  iso8601: Date;
22
22
  /**
23
- * Specifies the date in the current local time format.
23
+ * The date in the current local time format.
24
24
  */
25
25
  local: string;
26
26
  /**
27
- * Specifies the time format string.
27
+ * The time format string.
28
28
  */
29
29
  customFormat: string;
30
30
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/datetime",
3
- "version": "7.5.0",
3
+ "version": "7.6.1",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -44,13 +44,13 @@
44
44
  "@angular/core": "^14.2.11",
45
45
  "@angular/forms": "^14.2.11",
46
46
  "@angular/platform-browser": "^14.2.11",
47
- "@skyux-sdk/testing": "7.5.0",
48
- "@skyux/core": "7.5.0",
49
- "@skyux/forms": "7.5.0",
50
- "@skyux/i18n": "7.5.0",
51
- "@skyux/indicators": "7.5.0",
52
- "@skyux/popovers": "7.5.0",
53
- "@skyux/theme": "7.5.0",
47
+ "@skyux-sdk/testing": "7.6.1",
48
+ "@skyux/core": "7.6.1",
49
+ "@skyux/forms": "7.6.1",
50
+ "@skyux/i18n": "7.6.1",
51
+ "@skyux/indicators": "7.6.1",
52
+ "@skyux/popovers": "7.6.1",
53
+ "@skyux/theme": "7.6.1",
54
54
  "moment": "^2.29.4"
55
55
  },
56
56
  "dependencies": {