@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
@@ -705,7 +705,7 @@ var _SkyDateRangeCalculator_instances, _SkyDateRangeCalculator_config, _SkyDateR
705
705
  class SkyDateRangeCalculator {
706
706
  constructor(
707
707
  /**
708
- * Provides a calculator ID to specify calculator objects that represent date ranges.
708
+ * The calculator ID that specifies calculator objects that represent date ranges.
709
709
  */
710
710
  calculatorId, config) {
711
711
  this.calculatorId = calculatorId;
@@ -869,7 +869,7 @@ var SkyDateRangeCalculatorId;
869
869
  })(SkyDateRangeCalculatorId || (SkyDateRangeCalculatorId = {}));
870
870
 
871
871
  /**
872
- * Indicates the types of calculations available for a date range calculator.
872
+ * The types of calculations available for a date range calculator.
873
873
  */
874
874
  var SkyDateRangeCalculatorType;
875
875
  (function (SkyDateRangeCalculatorType) {
@@ -1281,7 +1281,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
1281
1281
  class SkyDatepickerConfigService {
1282
1282
  constructor() {
1283
1283
  /**
1284
- * Specifies the starting day of the week in the calendar,
1284
+ * The starting day of the week in the calendar,
1285
1285
  * where `0` sets the starting day to Sunday.
1286
1286
  * @default 0
1287
1287
  */
@@ -1303,7 +1303,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
1303
1303
  class SkyDatepickerService {
1304
1304
  constructor() {
1305
1305
  /**
1306
- * Specifies if a key date popover is currently displayed.
1306
+ * Whether a key date popover is currently displayed.
1307
1307
  * Useful for communicating across all daypicker siblings when a popover is displayed.
1308
1308
  */
1309
1309
  this.keyDatePopoverStream = new Subject();
@@ -2202,7 +2202,7 @@ class SkyFuzzyDatepickerInputDirective {
2202
2202
  constructor(changeDetector, configService, elementRef, fuzzyDateService, localeProvider, renderer, resourcesService, datepickerComponent) {
2203
2203
  _SkyFuzzyDatepickerInputDirective_instances.add(this);
2204
2204
  /**
2205
- * Indicates whether to disable date validation on the fuzzy datepicker input.
2205
+ * Whether to disable date validation on the fuzzy datepicker input.
2206
2206
  * @default false
2207
2207
  */
2208
2208
  this.skyDatepickerNoValidate = false;
@@ -2257,7 +2257,7 @@ class SkyFuzzyDatepickerInputDirective {
2257
2257
  });
2258
2258
  }
2259
2259
  /**
2260
- * Specifies the date format for the input. Place this attribute on the `input` element
2260
+ * The date format for the input. Place this attribute on the `input` element
2261
2261
  * to override the default in `SkyDatepickerConfigService`.
2262
2262
  * @default "MM/DD/YYYY"
2263
2263
  */
@@ -2276,7 +2276,7 @@ class SkyFuzzyDatepickerInputDirective {
2276
2276
  __classPrivateFieldGet(this, _SkyFuzzyDatepickerInputDirective_preferredShortDateFormat, "f"));
2277
2277
  }
2278
2278
  /**
2279
- * Indicates whether to disable the datepicker.
2279
+ * Whether to disable the datepicker.
2280
2280
  * @default false
2281
2281
  */
2282
2282
  set disabled(value) {
@@ -2288,7 +2288,7 @@ class SkyFuzzyDatepickerInputDirective {
2288
2288
  return __classPrivateFieldGet(this, _SkyFuzzyDatepickerInputDirective__disabled, "f");
2289
2289
  }
2290
2290
  /**
2291
- * Indicates whether to prevent users from specifying dates that are in the future.
2291
+ * Whether to prevent users from specifying dates that are in the future.
2292
2292
  * Place this attribute on the `input` element.
2293
2293
  * @default false
2294
2294
  */
@@ -2300,7 +2300,7 @@ class SkyFuzzyDatepickerInputDirective {
2300
2300
  return __classPrivateFieldGet(this, _SkyFuzzyDatepickerInputDirective__futureDisabled, "f");
2301
2301
  }
2302
2302
  /**
2303
- * Specifies the latest fuzzy date allowed. Place this attribute on the `input` element
2303
+ * The latest fuzzy date allowed. Place this attribute on the `input` element
2304
2304
  * to prevent fuzzy dates after a specified date. This property accepts
2305
2305
  * a `SkyFuzzyDate` value that includes numeric month, day, and year values.
2306
2306
  * For example: `{ month: 1, day: 1, year: 2027 }`.
@@ -2314,7 +2314,7 @@ class SkyFuzzyDatepickerInputDirective {
2314
2314
  return __classPrivateFieldGet(this, _SkyFuzzyDatepickerInputDirective__maxDate, "f");
2315
2315
  }
2316
2316
  /**
2317
- * Specifies the earliest fuzzy date allowed. Place this attribute on the `input` element
2317
+ * The earliest fuzzy date allowed. Place this attribute on the `input` element
2318
2318
  * to prevent fuzzy dates before a specified date. This property accepts a `SkyFuzzyDate` value
2319
2319
  * that includes numeric month, day, and year values.
2320
2320
  * For example: `{ month: 1, day: 1, year: 2007 }`.
@@ -2328,7 +2328,7 @@ class SkyFuzzyDatepickerInputDirective {
2328
2328
  return __classPrivateFieldGet(this, _SkyFuzzyDatepickerInputDirective__minDate, "f");
2329
2329
  }
2330
2330
  /**
2331
- * Specifies the starting day of the week in the calendar, where `0` sets the starting day
2331
+ * The starting day of the week in the calendar, where `0` sets the starting day
2332
2332
  * to Sunday. Place this attribute on the `input` element to override the default
2333
2333
  * in `SkyDatepickerConfigService`.
2334
2334
  * @default 0
@@ -2343,7 +2343,7 @@ class SkyFuzzyDatepickerInputDirective {
2343
2343
  return __classPrivateFieldGet(this, _SkyFuzzyDatepickerInputDirective__startingDay, "f") || __classPrivateFieldGet(this, _SkyFuzzyDatepickerInputDirective_configService, "f").startingDay;
2344
2344
  }
2345
2345
  /**
2346
- * Indicates whether to require the year in fuzzy dates.
2346
+ * Whether to require the year in fuzzy dates.
2347
2347
  * @default false
2348
2348
  */
2349
2349
  set yearRequired(value) {
@@ -2652,7 +2652,7 @@ class SkyDatepickerInputDirective {
2652
2652
  constructor(adapter, changeDetector, configService, elementRef, localeProvider, renderer, resourcesService, datepickerComponent) {
2653
2653
  _SkyDatepickerInputDirective_instances.add(this);
2654
2654
  /**
2655
- * Indicates whether to disable date validation on the datepicker input.
2655
+ * Whether to disable date validation on the datepicker input.
2656
2656
  * @default false
2657
2657
  */
2658
2658
  this.skyDatepickerNoValidate = false;
@@ -2709,7 +2709,7 @@ class SkyDatepickerInputDirective {
2709
2709
  });
2710
2710
  }
2711
2711
  /**
2712
- * Specifies the date format for the input. Place this attribute on the `input` element
2712
+ * The date format for the input. Place this attribute on the `input` element
2713
2713
  * to override the default in the `SkyDatepickerConfigService`.
2714
2714
  * @default "MM/DD/YYYY"
2715
2715
  */
@@ -2727,7 +2727,7 @@ class SkyDatepickerInputDirective {
2727
2727
  __classPrivateFieldGet(this, _SkyDatepickerInputDirective_preferredShortDateFormat, "f"));
2728
2728
  }
2729
2729
  /**
2730
- * Indicates whether to disable the datepicker.
2730
+ * Whether to disable the datepicker.
2731
2731
  * @default false
2732
2732
  */
2733
2733
  set disabled(value) {
@@ -2739,7 +2739,7 @@ class SkyDatepickerInputDirective {
2739
2739
  return __classPrivateFieldGet(this, _SkyDatepickerInputDirective__disabled, "f");
2740
2740
  }
2741
2741
  /**
2742
- * Specifies the latest date that is available in the calendar. Place this attribute on
2742
+ * The latest date that is available in the calendar. Place this attribute on
2743
2743
  * the `input` element to override the default in `SkyDatepickerConfigService`.
2744
2744
  */
2745
2745
  set maxDate(value) {
@@ -2752,7 +2752,7 @@ class SkyDatepickerInputDirective {
2752
2752
  return __classPrivateFieldGet(this, _SkyDatepickerInputDirective__maxDate, "f") || __classPrivateFieldGet(this, _SkyDatepickerInputDirective_configService, "f").maxDate;
2753
2753
  }
2754
2754
  /**
2755
- * Specifies the earliest date that is available in the calendar. Place this attribute on
2755
+ * The earliest date that is available in the calendar. Place this attribute on
2756
2756
  * 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.
2757
2757
  */
2758
2758
  set minDate(value) {
@@ -2780,7 +2780,7 @@ class SkyDatepickerInputDirective {
2780
2780
  }
2781
2781
  }
2782
2782
  /**
2783
- * Specifies the starting day of the week in the calendar, where `0` sets the starting day
2783
+ * The starting day of the week in the calendar, where `0` sets the starting day
2784
2784
  * to Sunday. Place this attribute on the `input` element to override the default
2785
2785
  * in `SkyDatepickerConfigService`.
2786
2786
  * @default 0
@@ -2795,7 +2795,7 @@ class SkyDatepickerInputDirective {
2795
2795
  return __classPrivateFieldGet(this, _SkyDatepickerInputDirective__startingDay, "f") || __classPrivateFieldGet(this, _SkyDatepickerInputDirective_configService, "f").startingDay;
2796
2796
  }
2797
2797
  /**
2798
- * Indicates whether the format of the date value must match the format from the `dateFormat` value.
2798
+ * Whether the format of the date value must match the format from the `dateFormat` value.
2799
2799
  * If this property is `true` and the datepicker input directive cannot find an exact match, then
2800
2800
  * the input is marked as invalid.
2801
2801
  * If this property is `false` and the datepicker input directive cannot find an exact match, then
@@ -3738,12 +3738,12 @@ class SkyDateRangePickerComponent {
3738
3738
  constructor(changeDetector, dateRangeService, formBuilder, localeProvider, ngZone, themeSvc) {
3739
3739
  _SkyDateRangePickerComponent_instances.add(this);
3740
3740
  /**
3741
- * Indicates whether to require users to specify a start date.
3741
+ * Whether to require users to specify a start date.
3742
3742
  * @default false
3743
3743
  */
3744
3744
  this.startDateRequired = false;
3745
3745
  /**
3746
- * Indicates whether to require users to specify a end date.
3746
+ * Whether to require users to specify a end date.
3747
3747
  * @default false
3748
3748
  */
3749
3749
  this.endDateRequired = false;
@@ -3818,7 +3818,7 @@ class SkyDateRangePickerComponent {
3818
3818
  });
3819
3819
  }
3820
3820
  /**
3821
- * Specifies IDs for the date range options to include in the picker's dropdown.
3821
+ * IDs for the date range options to include in the picker's dropdown.
3822
3822
  * The options specify calculator objects that return two `Date` objects to represent date ranges.
3823
3823
  * By default, this property includes all `SkyDateRangeCalculatorId` values.
3824
3824
  */
@@ -3852,7 +3852,7 @@ class SkyDateRangePickerComponent {
3852
3852
  return __classPrivateFieldGet(this, _SkyDateRangePickerComponent__calculatorIds, "f");
3853
3853
  }
3854
3854
  /**
3855
- * Specifies a date format for
3855
+ * The date format for
3856
3856
  * [the `sky-datepicker` components](https://developer.blackbaud.com/skyux/components/datepicker)
3857
3857
  * that make up the date range picker. The text input is a composite component of
3858
3858
  * up to two `sky-datepicker` components.
@@ -3866,7 +3866,7 @@ class SkyDateRangePickerComponent {
3866
3866
  return __classPrivateFieldGet(this, _SkyDateRangePickerComponent__dateFormat, "f");
3867
3867
  }
3868
3868
  /**
3869
- * Indicates whether to disable the date range picker.
3869
+ * Whether to disable the date range picker.
3870
3870
  * @default false
3871
3871
  */
3872
3872
  set disabled(value) {
@@ -4641,7 +4641,7 @@ class SkyTimepickerInputDirective {
4641
4641
  }
4642
4642
  // TODO: In a future breaking change - make this more specific than "string"
4643
4643
  /**
4644
- * Specifies the 12-hour `hh` or 24-hour `HH` time format for the input.
4644
+ * The 12-hour `hh` or 24-hour `HH` time format for the input.
4645
4645
  * @default "hh"
4646
4646
  */
4647
4647
  set timeFormat(value) {
@@ -4651,7 +4651,7 @@ class SkyTimepickerInputDirective {
4651
4651
  return __classPrivateFieldGet(this, _SkyTimepickerInputDirective__timeFormat, "f");
4652
4652
  }
4653
4653
  /**
4654
- * Indicates whether to disable the timepicker.
4654
+ * Whether to disable the timepicker.
4655
4655
  * @default false
4656
4656
  */
4657
4657
  get disabled() {