@skyux/datetime 7.5.0 → 7.6.0

package/fesm2020/skyux-datetime.mjs

@@ -705,7 +705,7 @@ var _SkyDateRangeCalculator_instances, _SkyDateRangeCalculator_config, _SkyDateR
 class SkyDateRangeCalculator {
     constructor(
     /**
-     * Provides a calculator ID to specify calculator objects that represent date ranges.
+     * The calculator ID that specifies calculator objects that represent date ranges.
      */
     calculatorId, config) {
         this.calculatorId = calculatorId;
@@ -869,7 +869,7 @@ var SkyDateRangeCalculatorId;
 })(SkyDateRangeCalculatorId || (SkyDateRangeCalculatorId = {}));
 
 /**
- * Indicates the types of calculations available for a date range calculator.
+ * The types of calculations available for a date range calculator.
  */
 var SkyDateRangeCalculatorType;
 (function (SkyDateRangeCalculatorType) {
@@ -1281,7 +1281,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
 class SkyDatepickerConfigService {
     constructor() {
         /**
-         * Specifies the starting day of the week in the calendar,
+         * The starting day of the week in the calendar,
          * where `0` sets the starting day to Sunday.
          * @default 0
          */
@@ -1303,7 +1303,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
 class SkyDatepickerService {
     constructor() {
         /**
-         * Specifies if a key date popover is currently displayed.
+         * Whether a key date popover is currently displayed.
          * Useful for communicating across all daypicker siblings when a popover is displayed.
          */
         this.keyDatePopoverStream = new Subject();
@@ -2202,7 +2202,7 @@ class SkyFuzzyDatepickerInputDirective {
     constructor(changeDetector, configService, elementRef, fuzzyDateService, localeProvider, renderer, resourcesService, datepickerComponent) {
         _SkyFuzzyDatepickerInputDirective_instances.add(this);
         /**
-         * Indicates whether to disable date validation on the fuzzy datepicker input.
+         * Whether to disable date validation on the fuzzy datepicker input.
          * @default false
          */
         this.skyDatepickerNoValidate = false;
@@ -2257,7 +2257,7 @@ class SkyFuzzyDatepickerInputDirective {
         });
     }
     /**
-     * Specifies the date format for the input. Place this attribute on the `input` element
+     * The date format for the input. Place this attribute on the `input` element
      * to override the default in `SkyDatepickerConfigService`.
      * @default "MM/DD/YYYY"
      */
@@ -2276,7 +2276,7 @@ class SkyFuzzyDatepickerInputDirective {
             __classPrivateFieldGet(this, _SkyFuzzyDatepickerInputDirective_preferredShortDateFormat, "f"));
     }
     /**
-     * Indicates whether to disable the datepicker.
+     * Whether to disable the datepicker.
      * @default false
      */
     set disabled(value) {
@@ -2288,7 +2288,7 @@ class SkyFuzzyDatepickerInputDirective {
         return __classPrivateFieldGet(this, _SkyFuzzyDatepickerInputDirective__disabled, "f");
     }
     /**
-     * Indicates whether to prevent users from specifying dates that are in the future.
+     * Whether to prevent users from specifying dates that are in the future.
      * Place this attribute on the `input` element.
      * @default false
      */
@@ -2300,7 +2300,7 @@ class SkyFuzzyDatepickerInputDirective {
         return __classPrivateFieldGet(this, _SkyFuzzyDatepickerInputDirective__futureDisabled, "f");
     }
     /**
-     * Specifies the latest fuzzy date allowed. Place this attribute on the `input` element
+     * The latest fuzzy date allowed. Place this attribute on the `input` element
      * to prevent fuzzy dates after a specified date. This property accepts
      * a `SkyFuzzyDate` value that includes numeric month, day, and year values.
      * For example: `{ month: 1, day: 1, year: 2027 }`.
@@ -2314,7 +2314,7 @@ class SkyFuzzyDatepickerInputDirective {
         return __classPrivateFieldGet(this, _SkyFuzzyDatepickerInputDirective__maxDate, "f");
     }
     /**
-     * Specifies the earliest fuzzy date allowed. Place this attribute on the `input` element
+     * The earliest fuzzy date allowed. Place this attribute on the `input` element
      * to prevent fuzzy dates before a specified date. This property accepts a `SkyFuzzyDate` value
      * that includes numeric month, day, and year values.
      * For example: `{ month: 1, day: 1, year: 2007 }`.
@@ -2328,7 +2328,7 @@ class SkyFuzzyDatepickerInputDirective {
         return __classPrivateFieldGet(this, _SkyFuzzyDatepickerInputDirective__minDate, "f");
     }
     /**
-     * Specifies the starting day of the week in the calendar, where `0` sets the starting day
+     * The starting day of the week in the calendar, where `0` sets the starting day
      * to Sunday. Place this attribute on the `input` element to override the default
      * in `SkyDatepickerConfigService`.
      * @default 0
@@ -2343,7 +2343,7 @@ class SkyFuzzyDatepickerInputDirective {
         return __classPrivateFieldGet(this, _SkyFuzzyDatepickerInputDirective__startingDay, "f") || __classPrivateFieldGet(this, _SkyFuzzyDatepickerInputDirective_configService, "f").startingDay;
     }
     /**
-     * Indicates whether to require the year in fuzzy dates.
+     * Whether to require the year in fuzzy dates.
      * @default false
      */
     set yearRequired(value) {
@@ -2652,7 +2652,7 @@ class SkyDatepickerInputDirective {
     constructor(adapter, changeDetector, configService, elementRef, localeProvider, renderer, resourcesService, datepickerComponent) {
         _SkyDatepickerInputDirective_instances.add(this);
         /**
-         * Indicates whether to disable date validation on the datepicker input.
+         * Whether to disable date validation on the datepicker input.
          * @default false
          */
         this.skyDatepickerNoValidate = false;
@@ -2709,7 +2709,7 @@ class SkyDatepickerInputDirective {
         });
     }
     /**
-     * Specifies the date format for the input. Place this attribute on the `input` element
+     * The date format for the input. Place this attribute on the `input` element
      * to override the default in the `SkyDatepickerConfigService`.
      * @default "MM/DD/YYYY"
      */
@@ -2727,7 +2727,7 @@ class SkyDatepickerInputDirective {
             __classPrivateFieldGet(this, _SkyDatepickerInputDirective_preferredShortDateFormat, "f"));
     }
     /**
-     * Indicates whether to disable the datepicker.
+     * Whether to disable the datepicker.
      * @default false
      */
     set disabled(value) {
@@ -2739,7 +2739,7 @@ class SkyDatepickerInputDirective {
         return __classPrivateFieldGet(this, _SkyDatepickerInputDirective__disabled, "f");
     }
     /**
-     * Specifies the latest date that is available in the calendar. Place this attribute on
+     * The latest date that is available in the calendar. Place this attribute on
      * the `input` element to override the default in `SkyDatepickerConfigService`.
      */
     set maxDate(value) {
@@ -2752,7 +2752,7 @@ class SkyDatepickerInputDirective {
         return __classPrivateFieldGet(this, _SkyDatepickerInputDirective__maxDate, "f") || __classPrivateFieldGet(this, _SkyDatepickerInputDirective_configService, "f").maxDate;
     }
     /**
-     * Specifies the earliest date that is available in the calendar. Place this attribute on
+     * The earliest date that is available in the calendar. Place this attribute on
      * 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.
      */
     set minDate(value) {
@@ -2780,7 +2780,7 @@ class SkyDatepickerInputDirective {
         }
     }
     /**
-     * Specifies the starting day of the week in the calendar, where `0` sets the starting day
+     * The starting day of the week in the calendar, where `0` sets the starting day
      * to Sunday. Place this attribute on the `input` element to override the default
      * in `SkyDatepickerConfigService`.
      * @default 0
@@ -2795,7 +2795,7 @@ class SkyDatepickerInputDirective {
         return __classPrivateFieldGet(this, _SkyDatepickerInputDirective__startingDay, "f") || __classPrivateFieldGet(this, _SkyDatepickerInputDirective_configService, "f").startingDay;
     }
     /**
-     * Indicates whether the format of the date value must match the format from the `dateFormat` value.
+     * Whether the format of the date value must match the format from the `dateFormat` value.
      * If this property is `true` and the datepicker input directive cannot find an exact match, then
      * the input is marked as invalid.
      * If this property is `false` and the datepicker input directive cannot find an exact match, then
@@ -3738,12 +3738,12 @@ class SkyDateRangePickerComponent {
     constructor(changeDetector, dateRangeService, formBuilder, localeProvider, ngZone, themeSvc) {
         _SkyDateRangePickerComponent_instances.add(this);
         /**
-         * Indicates whether to require users to specify a start date.
+         * Whether to require users to specify a start date.
          * @default false
          */
         this.startDateRequired = false;
         /**
-         * Indicates whether to require users to specify a end date.
+         * Whether to require users to specify a end date.
          * @default false
          */
         this.endDateRequired = false;
@@ -3818,7 +3818,7 @@ class SkyDateRangePickerComponent {
         });
     }
     /**
-     * Specifies IDs for the date range options to include in the picker's dropdown.
+     * IDs for the date range options to include in the picker's dropdown.
      * The options specify calculator objects that return two `Date` objects to represent date ranges.
      * By default, this property includes all `SkyDateRangeCalculatorId` values.
      */
@@ -3852,7 +3852,7 @@ class SkyDateRangePickerComponent {
         return __classPrivateFieldGet(this, _SkyDateRangePickerComponent__calculatorIds, "f");
     }
     /**
-     * Specifies a date format for
+     * The date format for
      * [the `sky-datepicker` components](https://developer.blackbaud.com/skyux/components/datepicker)
      * that make up the date range picker. The text input is a composite component of
      * up to two `sky-datepicker` components.
@@ -3866,7 +3866,7 @@ class SkyDateRangePickerComponent {
         return __classPrivateFieldGet(this, _SkyDateRangePickerComponent__dateFormat, "f");
     }
     /**
-     * Indicates whether to disable the date range picker.
+     * Whether to disable the date range picker.
      * @default false
      */
     set disabled(value) {
@@ -4641,7 +4641,7 @@ class SkyTimepickerInputDirective {
     }
     // TODO: In a future breaking change - make this more specific than "string"
     /**
-     * Specifies the 12-hour `hh` or 24-hour `HH` time format for the input.
+     * The 12-hour `hh` or 24-hour `HH` time format for the input.
      * @default "hh"
      */
     set timeFormat(value) {
@@ -4651,7 +4651,7 @@ class SkyTimepickerInputDirective {
         return __classPrivateFieldGet(this, _SkyTimepickerInputDirective__timeFormat, "f");
     }
     /**
-     * Indicates whether to disable the timepicker.
+     * Whether to disable the timepicker.
      * @default false
      */
     get disabled() {