@skyux/datetime 7.5.0 → 7.6.0

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
@@ -574,7 +574,7 @@
574
574
  "kindString": "Enumeration",
575
575
  "flags": {},
576
576
  "comment": {
577
- "shortText": "Indicates the types of calculations available for a date range calculator."
577
+ "shortText": "The types of calculations available for a date range calculator."
578
578
  },
579
579
  "children": [
580
580
  {
@@ -1034,7 +1034,7 @@
1034
1034
  "isReadonly": true
1035
1035
  },
1036
1036
  "comment": {
1037
- "shortText": "Specifies the text to display in the calculator select menu."
1037
+ "shortText": "The text to display in the calculator select menu."
1038
1038
  },
1039
1039
  "sources": [
1040
1040
  {
@@ -1058,7 +1058,7 @@
1058
1058
  "isReadonly": true
1059
1059
  },
1060
1060
  "comment": {
1061
- "shortText": "Specifies the type of calculations available for the date range."
1061
+ "shortText": "The type of calculations available for the date range."
1062
1062
  },
1063
1063
  "sources": [
1064
1064
  {
@@ -1559,7 +1559,7 @@
1559
1559
  "isPublic": true
1560
1560
  },
1561
1561
  "comment": {
1562
- "shortText": "Specifies the date format for the input.",
1562
+ "shortText": "The date format for the input.",
1563
1563
  "tags": [
1564
1564
  {
1565
1565
  "tag": "default",
@@ -1588,7 +1588,7 @@
1588
1588
  "isPublic": true
1589
1589
  },
1590
1590
  "comment": {
1591
- "shortText": "Specifies the latest selectable date that is available in the calendar."
1591
+ "shortText": "The latest selectable date that is available in the calendar."
1592
1592
  },
1593
1593
  "sources": [
1594
1594
  {
@@ -1613,7 +1613,7 @@
1613
1613
  "isPublic": true
1614
1614
  },
1615
1615
  "comment": {
1616
- "shortText": "Specifies the earliest selectable date that is available in the calendar."
1616
+ "shortText": "The earliest selectable date that is available in the calendar."
1617
1617
  },
1618
1618
  "sources": [
1619
1619
  {
@@ -1638,7 +1638,7 @@
1638
1638
  "isPublic": true
1639
1639
  },
1640
1640
  "comment": {
1641
- "shortText": "Specifies the starting day of the week in the calendar,\nwhere `0` sets the starting day to Sunday.",
1641
+ "shortText": "The starting day of the week in the calendar,\nwhere `0` sets the starting day to Sunday.",
1642
1642
  "tags": [
1643
1643
  {
1644
1644
  "tag": "default",
@@ -3295,7 +3295,7 @@
3295
3295
  "isPublic": true
3296
3296
  },
3297
3297
  "comment": {
3298
- "shortText": "Indicates whether to disable date validation on the datepicker input.",
3298
+ "shortText": "Whether to disable date validation on the datepicker input.",
3299
3299
  "tags": [
3300
3300
  {
3301
3301
  "tag": "default",
@@ -3363,7 +3363,7 @@
3363
3363
  "kindString": "Get signature",
3364
3364
  "flags": {},
3365
3365
  "comment": {
3366
- "shortText": "Specifies the date format for the input. Place this attribute on the `input` element\nto override the default in the `SkyDatepickerConfigService`.",
3366
+ "shortText": "The date format for the input. Place this attribute on the `input` element\nto override the default in the `SkyDatepickerConfigService`.",
3367
3367
  "tags": [
3368
3368
  {
3369
3369
  "tag": "default",
@@ -3385,7 +3385,7 @@
3385
3385
  "kindString": "Set signature",
3386
3386
  "flags": {},
3387
3387
  "comment": {
3388
- "shortText": "Specifies the date format for the input. Place this attribute on the `input` element\nto override the default in the `SkyDatepickerConfigService`.",
3388
+ "shortText": "The date format for the input. Place this attribute on the `input` element\nto override the default in the `SkyDatepickerConfigService`.",
3389
3389
  "tags": [
3390
3390
  {
3391
3391
  "tag": "default",
@@ -3448,7 +3448,7 @@
3448
3448
  "kindString": "Get signature",
3449
3449
  "flags": {},
3450
3450
  "comment": {
3451
- "shortText": "Indicates whether to disable the datepicker.",
3451
+ "shortText": "Whether to disable the datepicker.",
3452
3452
  "tags": [
3453
3453
  {
3454
3454
  "tag": "default",
@@ -3470,7 +3470,7 @@
3470
3470
  "kindString": "Set signature",
3471
3471
  "flags": {},
3472
3472
  "comment": {
3473
- "shortText": "Indicates whether to disable the datepicker.",
3473
+ "shortText": "Whether to disable the datepicker.",
3474
3474
  "tags": [
3475
3475
  {
3476
3476
  "tag": "default",
@@ -3533,7 +3533,7 @@
3533
3533
  "kindString": "Get signature",
3534
3534
  "flags": {},
3535
3535
  "comment": {
3536
- "shortText": "Specifies the latest date that is available in the calendar. Place this attribute on\nthe `input` element to override the default in `SkyDatepickerConfigService`."
3536
+ "shortText": "The latest date that is available in the calendar. Place this attribute on\nthe `input` element to override the default in `SkyDatepickerConfigService`."
3537
3537
  },
3538
3538
  "type": {
3539
3539
  "type": "reference",
@@ -3551,7 +3551,7 @@
3551
3551
  "kindString": "Set signature",
3552
3552
  "flags": {},
3553
3553
  "comment": {
3554
- "shortText": "Specifies the latest date that is available in the calendar. Place this attribute on\nthe `input` element to override the default in `SkyDatepickerConfigService`."
3554
+ "shortText": "The latest date that is available in the calendar. Place this attribute on\nthe `input` element to override the default in `SkyDatepickerConfigService`."
3555
3555
  },
3556
3556
  "parameters": [
3557
3557
  {
@@ -3610,7 +3610,7 @@
3610
3610
  "kindString": "Get signature",
3611
3611
  "flags": {},
3612
3612
  "comment": {
3613
- "shortText": "Specifies the earliest date that is available in the calendar. Place this attribute on\nthe `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."
3613
+ "shortText": "The earliest date that is available in the calendar. Place this attribute on\nthe `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."
3614
3614
  },
3615
3615
  "type": {
3616
3616
  "type": "reference",
@@ -3628,7 +3628,7 @@
3628
3628
  "kindString": "Set signature",
3629
3629
  "flags": {},
3630
3630
  "comment": {
3631
- "shortText": "Specifies the earliest date that is available in the calendar. Place this attribute on\nthe `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."
3631
+ "shortText": "The earliest date that is available in the calendar. Place this attribute on\nthe `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."
3632
3632
  },
3633
3633
  "parameters": [
3634
3634
  {
@@ -3760,7 +3760,7 @@
3760
3760
  "kindString": "Get signature",
3761
3761
  "flags": {},
3762
3762
  "comment": {
3763
- "shortText": "Specifies the starting day of the week in the calendar, where `0` sets the starting day\nto Sunday. Place this attribute on the `input` element to override the default\nin `SkyDatepickerConfigService`.",
3763
+ "shortText": "The starting day of the week in the calendar, where `0` sets the starting day\nto Sunday. Place this attribute on the `input` element to override the default\nin `SkyDatepickerConfigService`.",
3764
3764
  "tags": [
3765
3765
  {
3766
3766
  "tag": "default",
@@ -3782,7 +3782,7 @@
3782
3782
  "kindString": "Set signature",
3783
3783
  "flags": {},
3784
3784
  "comment": {
3785
- "shortText": "Specifies the starting day of the week in the calendar, where `0` sets the starting day\nto Sunday. Place this attribute on the `input` element to override the default\nin `SkyDatepickerConfigService`.",
3785
+ "shortText": "The starting day of the week in the calendar, where `0` sets the starting day\nto Sunday. Place this attribute on the `input` element to override the default\nin `SkyDatepickerConfigService`.",
3786
3786
  "tags": [
3787
3787
  {
3788
3788
  "tag": "default",
@@ -3845,7 +3845,7 @@
3845
3845
  "kindString": "Get signature",
3846
3846
  "flags": {},
3847
3847
  "comment": {
3848
- "shortText": "Indicates whether the format of the date value must match the format from the `dateFormat` value.\nIf this property is `true` and the datepicker input directive cannot find an exact match, then\nthe input is marked as invalid.\nIf this property is `false` and the datepicker input directive cannot find an exact match, then\nit attempts to format the string based on the [ISO 8601 standard format](https://www.iso.org/iso-8601-date-and-time-format.html).",
3848
+ "shortText": "Whether the format of the date value must match the format from the `dateFormat` value.\nIf this property is `true` and the datepicker input directive cannot find an exact match, then\nthe input is marked as invalid.\nIf this property is `false` and the datepicker input directive cannot find an exact match, then\nit attempts to format the string based on the [ISO 8601 standard format](https://www.iso.org/iso-8601-date-and-time-format.html).",
3849
3849
  "tags": [
3850
3850
  {
3851
3851
  "tag": "default",
@@ -3867,7 +3867,7 @@
3867
3867
  "kindString": "Set signature",
3868
3868
  "flags": {},
3869
3869
  "comment": {
3870
- "shortText": "Indicates whether the format of the date value must match the format from the `dateFormat` value.\nIf this property is `true` and the datepicker input directive cannot find an exact match, then\nthe input is marked as invalid.\nIf this property is `false` and the datepicker input directive cannot find an exact match, then\nit attempts to format the string based on the [ISO 8601 standard format](https://www.iso.org/iso-8601-date-and-time-format.html).",
3870
+ "shortText": "Whether the format of the date value must match the format from the `dateFormat` value.\nIf this property is `true` and the datepicker input directive cannot find an exact match, then\nthe input is marked as invalid.\nIf this property is `false` and the datepicker input directive cannot find an exact match, then\nit attempts to format the string based on the [ISO 8601 standard format](https://www.iso.org/iso-8601-date-and-time-format.html).",
3871
3871
  "tags": [
3872
3872
  {
3873
3873
  "tag": "default",
@@ -4874,7 +4874,7 @@
4874
4874
  "isPublic": true
4875
4875
  },
4876
4876
  "comment": {
4877
- "shortText": "Indicates whether to disable date validation on the fuzzy datepicker input.",
4877
+ "shortText": "Whether to disable date validation on the fuzzy datepicker input.",
4878
4878
  "tags": [
4879
4879
  {
4880
4880
  "tag": "default",
@@ -4942,7 +4942,7 @@
4942
4942
  "kindString": "Get signature",
4943
4943
  "flags": {},
4944
4944
  "comment": {
4945
- "shortText": "Specifies the date format for the input. Place this attribute on the `input` element\nto override the default in `SkyDatepickerConfigService`.",
4945
+ "shortText": "The date format for the input. Place this attribute on the `input` element\nto override the default in `SkyDatepickerConfigService`.",
4946
4946
  "tags": [
4947
4947
  {
4948
4948
  "tag": "default",
@@ -4964,7 +4964,7 @@
4964
4964
  "kindString": "Set signature",
4965
4965
  "flags": {},
4966
4966
  "comment": {
4967
- "shortText": "Specifies the date format for the input. Place this attribute on the `input` element\nto override the default in `SkyDatepickerConfigService`.",
4967
+ "shortText": "The date format for the input. Place this attribute on the `input` element\nto override the default in `SkyDatepickerConfigService`.",
4968
4968
  "tags": [
4969
4969
  {
4970
4970
  "tag": "default",
@@ -5027,7 +5027,7 @@
5027
5027
  "kindString": "Get signature",
5028
5028
  "flags": {},
5029
5029
  "comment": {
5030
- "shortText": "Indicates whether to disable the datepicker.",
5030
+ "shortText": "Whether to disable the datepicker.",
5031
5031
  "tags": [
5032
5032
  {
5033
5033
  "tag": "default",
@@ -5049,7 +5049,7 @@
5049
5049
  "kindString": "Set signature",
5050
5050
  "flags": {},
5051
5051
  "comment": {
5052
- "shortText": "Indicates whether to disable the datepicker.",
5052
+ "shortText": "Whether to disable the datepicker.",
5053
5053
  "tags": [
5054
5054
  {
5055
5055
  "tag": "default",
@@ -5112,7 +5112,7 @@
5112
5112
  "kindString": "Get signature",
5113
5113
  "flags": {},
5114
5114
  "comment": {
5115
- "shortText": "Indicates whether to prevent users from specifying dates that are in the future.\nPlace this attribute on the `input` element.",
5115
+ "shortText": "Whether to prevent users from specifying dates that are in the future.\nPlace this attribute on the `input` element.",
5116
5116
  "tags": [
5117
5117
  {
5118
5118
  "tag": "default",
@@ -5134,7 +5134,7 @@
5134
5134
  "kindString": "Set signature",
5135
5135
  "flags": {},
5136
5136
  "comment": {
5137
- "shortText": "Indicates whether to prevent users from specifying dates that are in the future.\nPlace this attribute on the `input` element.",
5137
+ "shortText": "Whether to prevent users from specifying dates that are in the future.\nPlace this attribute on the `input` element.",
5138
5138
  "tags": [
5139
5139
  {
5140
5140
  "tag": "default",
@@ -5197,7 +5197,7 @@
5197
5197
  "kindString": "Get signature",
5198
5198
  "flags": {},
5199
5199
  "comment": {
5200
- "shortText": "Specifies the latest fuzzy date allowed. Place this attribute on the `input` element\nto prevent fuzzy dates after a specified date. This property accepts\na `SkyFuzzyDate` value that includes numeric month, day, and year values.\nFor example: `{ month: 1, day: 1, year: 2027 }`."
5200
+ "shortText": "The latest fuzzy date allowed. Place this attribute on the `input` element\nto prevent fuzzy dates after a specified date. This property accepts\na `SkyFuzzyDate` value that includes numeric month, day, and year values.\nFor example: `{ month: 1, day: 1, year: 2027 }`."
5201
5201
  },
5202
5202
  "type": {
5203
5203
  "type": "reference",
@@ -5214,7 +5214,7 @@
5214
5214
  "kindString": "Set signature",
5215
5215
  "flags": {},
5216
5216
  "comment": {
5217
- "shortText": "Specifies the latest fuzzy date allowed. Place this attribute on the `input` element\nto prevent fuzzy dates after a specified date. This property accepts\na `SkyFuzzyDate` value that includes numeric month, day, and year values.\nFor example: `{ month: 1, day: 1, year: 2027 }`."
5217
+ "shortText": "The latest fuzzy date allowed. Place this attribute on the `input` element\nto prevent fuzzy dates after a specified date. This property accepts\na `SkyFuzzyDate` value that includes numeric month, day, and year values.\nFor example: `{ month: 1, day: 1, year: 2027 }`."
5218
5218
  },
5219
5219
  "parameters": [
5220
5220
  {
@@ -5272,7 +5272,7 @@
5272
5272
  "kindString": "Get signature",
5273
5273
  "flags": {},
5274
5274
  "comment": {
5275
- "shortText": "Specifies the earliest fuzzy date allowed. Place this attribute on the `input` element\nto prevent fuzzy dates before a specified date. This property accepts a `SkyFuzzyDate` value\nthat includes numeric month, day, and year values.\nFor example: `{ month: 1, day: 1, year: 2007 }`."
5275
+ "shortText": "The earliest fuzzy date allowed. Place this attribute on the `input` element\nto prevent fuzzy dates before a specified date. This property accepts a `SkyFuzzyDate` value\nthat includes numeric month, day, and year values.\nFor example: `{ month: 1, day: 1, year: 2007 }`."
5276
5276
  },
5277
5277
  "type": {
5278
5278
  "type": "reference",
@@ -5289,7 +5289,7 @@
5289
5289
  "kindString": "Set signature",
5290
5290
  "flags": {},
5291
5291
  "comment": {
5292
- "shortText": "Specifies the earliest fuzzy date allowed. Place this attribute on the `input` element\nto prevent fuzzy dates before a specified date. This property accepts a `SkyFuzzyDate` value\nthat includes numeric month, day, and year values.\nFor example: `{ month: 1, day: 1, year: 2007 }`."
5292
+ "shortText": "The earliest fuzzy date allowed. Place this attribute on the `input` element\nto prevent fuzzy dates before a specified date. This property accepts a `SkyFuzzyDate` value\nthat includes numeric month, day, and year values.\nFor example: `{ month: 1, day: 1, year: 2007 }`."
5293
5293
  },
5294
5294
  "parameters": [
5295
5295
  {
@@ -5347,7 +5347,7 @@
5347
5347
  "kindString": "Get signature",
5348
5348
  "flags": {},
5349
5349
  "comment": {
5350
- "shortText": "Specifies the starting day of the week in the calendar, where `0` sets the starting day\nto Sunday. Place this attribute on the `input` element to override the default\nin `SkyDatepickerConfigService`.",
5350
+ "shortText": "The starting day of the week in the calendar, where `0` sets the starting day\nto Sunday. Place this attribute on the `input` element to override the default\nin `SkyDatepickerConfigService`.",
5351
5351
  "tags": [
5352
5352
  {
5353
5353
  "tag": "default",
@@ -5369,7 +5369,7 @@
5369
5369
  "kindString": "Set signature",
5370
5370
  "flags": {},
5371
5371
  "comment": {
5372
- "shortText": "Specifies the starting day of the week in the calendar, where `0` sets the starting day\nto Sunday. Place this attribute on the `input` element to override the default\nin `SkyDatepickerConfigService`.",
5372
+ "shortText": "The starting day of the week in the calendar, where `0` sets the starting day\nto Sunday. Place this attribute on the `input` element to override the default\nin `SkyDatepickerConfigService`.",
5373
5373
  "tags": [
5374
5374
  {
5375
5375
  "tag": "default",
@@ -5432,7 +5432,7 @@
5432
5432
  "kindString": "Get signature",
5433
5433
  "flags": {},
5434
5434
  "comment": {
5435
- "shortText": "Indicates whether to require the year in fuzzy dates.",
5435
+ "shortText": "Whether to require the year in fuzzy dates.",
5436
5436
  "tags": [
5437
5437
  {
5438
5438
  "tag": "default",
@@ -5454,7 +5454,7 @@
5454
5454
  "kindString": "Set signature",
5455
5455
  "flags": {},
5456
5456
  "comment": {
5457
- "shortText": "Indicates whether to require the year in fuzzy dates.",
5457
+ "shortText": "Whether to require the year in fuzzy dates.",
5458
5458
  "tags": [
5459
5459
  {
5460
5460
  "tag": "default",
@@ -6508,7 +6508,7 @@
6508
6508
  "isPublic": true
6509
6509
  },
6510
6510
  "comment": {
6511
- "shortText": "Indicates whether to require users to specify a end date.",
6511
+ "shortText": "Whether to require users to specify a end date.",
6512
6512
  "tags": [
6513
6513
  {
6514
6514
  "tag": "default",
@@ -6593,7 +6593,7 @@
6593
6593
  "isPublic": true
6594
6594
  },
6595
6595
  "comment": {
6596
- "shortText": "Specifies a label for the date range picker.",
6596
+ "shortText": "The label for the date range picker.",
6597
6597
  "tags": [
6598
6598
  {
6599
6599
  "tag": "required",
@@ -6697,7 +6697,7 @@
6697
6697
  "isPublic": true
6698
6698
  },
6699
6699
  "comment": {
6700
- "shortText": "Indicates whether to require users to specify a start date.",
6700
+ "shortText": "Whether to require users to specify a start date.",
6701
6701
  "tags": [
6702
6702
  {
6703
6703
  "tag": "default",
@@ -6765,7 +6765,7 @@
6765
6765
  "kindString": "Get signature",
6766
6766
  "flags": {},
6767
6767
  "comment": {
6768
- "shortText": "Specifies IDs for the date range options to include in the picker's dropdown.\nThe options specify calculator objects that return two `Date` objects to represent date ranges.\nBy default, this property includes all `SkyDateRangeCalculatorId` values."
6768
+ "shortText": "IDs for the date range options to include in the picker's dropdown.\nThe options specify calculator objects that return two `Date` objects to represent date ranges.\nBy default, this property includes all `SkyDateRangeCalculatorId` values."
6769
6769
  },
6770
6770
  "type": {
6771
6771
  "type": "array",
@@ -6785,7 +6785,7 @@
6785
6785
  "kindString": "Set signature",
6786
6786
  "flags": {},
6787
6787
  "comment": {
6788
- "shortText": "Specifies IDs for the date range options to include in the picker's dropdown.\nThe options specify calculator objects that return two `Date` objects to represent date ranges.\nBy default, this property includes all `SkyDateRangeCalculatorId` values."
6788
+ "shortText": "IDs for the date range options to include in the picker's dropdown.\nThe options specify calculator objects that return two `Date` objects to represent date ranges.\nBy default, this property includes all `SkyDateRangeCalculatorId` values."
6789
6789
  },
6790
6790
  "parameters": [
6791
6791
  {
@@ -6846,7 +6846,7 @@
6846
6846
  "kindString": "Get signature",
6847
6847
  "flags": {},
6848
6848
  "comment": {
6849
- "shortText": "Specifies a date format for\n[the `sky-datepicker` components](https://developer.blackbaud.com/skyux/components/datepicker)\nthat make up the date range picker. The text input is a composite component of\nup to two `sky-datepicker` components.",
6849
+ "shortText": "The date format for\n[the `sky-datepicker` components](https://developer.blackbaud.com/skyux/components/datepicker)\nthat make up the date range picker. The text input is a composite component of\nup to two `sky-datepicker` components.",
6850
6850
  "tags": [
6851
6851
  {
6852
6852
  "tag": "default",
@@ -6868,7 +6868,7 @@
6868
6868
  "kindString": "Set signature",
6869
6869
  "flags": {},
6870
6870
  "comment": {
6871
- "shortText": "Specifies a date format for\n[the `sky-datepicker` components](https://developer.blackbaud.com/skyux/components/datepicker)\nthat make up the date range picker. The text input is a composite component of\nup to two `sky-datepicker` components.",
6871
+ "shortText": "The date format for\n[the `sky-datepicker` components](https://developer.blackbaud.com/skyux/components/datepicker)\nthat make up the date range picker. The text input is a composite component of\nup to two `sky-datepicker` components.",
6872
6872
  "tags": [
6873
6873
  {
6874
6874
  "tag": "default",
@@ -6931,7 +6931,7 @@
6931
6931
  "kindString": "Get signature",
6932
6932
  "flags": {},
6933
6933
  "comment": {
6934
- "shortText": "Indicates whether to disable the date range picker.",
6934
+ "shortText": "Whether to disable the date range picker.",
6935
6935
  "tags": [
6936
6936
  {
6937
6937
  "tag": "default",
@@ -6953,7 +6953,7 @@
6953
6953
  "kindString": "Set signature",
6954
6954
  "flags": {},
6955
6955
  "comment": {
6956
- "shortText": "Indicates whether to disable the date range picker.",
6956
+ "shortText": "Whether to disable the date range picker.",
6957
6957
  "tags": [
6958
6958
  {
6959
6959
  "tag": "default",
@@ -8966,7 +8966,7 @@
8966
8966
  "isPublic": true
8967
8967
  },
8968
8968
  "comment": {
8969
- "shortText": "Specifies a custom time format. For examples,\nsee the [moment.js](https://momentjs.com/docs/#/displaying/format/) docs."
8969
+ "shortText": "The custom time format. For examples,\nsee the [moment.js](https://momentjs.com/docs/#/displaying/format/) docs."
8970
8970
  },
8971
8971
  "decorators": [
8972
8972
  {
@@ -9027,7 +9027,7 @@
9027
9027
  "kindString": "Get signature",
9028
9028
  "flags": {},
9029
9029
  "comment": {
9030
- "shortText": "Indicates whether to disable the timepicker.",
9030
+ "shortText": "Whether to disable the timepicker.",
9031
9031
  "tags": [
9032
9032
  {
9033
9033
  "tag": "default",
@@ -9049,7 +9049,7 @@
9049
9049
  "kindString": "Set signature",
9050
9050
  "flags": {},
9051
9051
  "comment": {
9052
- "shortText": "Indicates whether to disable the timepicker.",
9052
+ "shortText": "Whether to disable the timepicker.",
9053
9053
  "tags": [
9054
9054
  {
9055
9055
  "tag": "default",
@@ -9199,7 +9199,7 @@
9199
9199
  "kindString": "Get signature",
9200
9200
  "flags": {},
9201
9201
  "comment": {
9202
- "shortText": "Specifies the 12-hour `hh` or 24-hour `HH` time format for the input.",
9202
+ "shortText": "The 12-hour `hh` or 24-hour `HH` time format for the input.",
9203
9203
  "tags": [
9204
9204
  {
9205
9205
  "tag": "default",
@@ -9221,7 +9221,7 @@
9221
9221
  "kindString": "Set signature",
9222
9222
  "flags": {},
9223
9223
  "comment": {
9224
- "shortText": "Specifies the 12-hour `hh` or 24-hour `HH` time format for the input.",
9224
+ "shortText": "The 12-hour `hh` or 24-hour `HH` time format for the input.",
9225
9225
  "tags": [
9226
9226
  {
9227
9227
  "tag": "default",
@@ -9988,7 +9988,7 @@
9988
9988
  "isOptional": true
9989
9989
  },
9990
9990
  "comment": {
9991
- "shortText": "Specifies the last date in the date range."
9991
+ "shortText": "The last date in the date range."
9992
9992
  },
9993
9993
  "sources": [
9994
9994
  {
@@ -10013,7 +10013,7 @@
10013
10013
  "isOptional": true
10014
10014
  },
10015
10015
  "comment": {
10016
- "shortText": "Specifies the first date in the date range."
10016
+ "shortText": "The first date in the date range."
10017
10017
  },
10018
10018
  "sources": [
10019
10019
  {
@@ -10072,7 +10072,7 @@
10072
10072
  "kindString": "Property",
10073
10073
  "flags": {},
10074
10074
  "comment": {
10075
- "shortText": "Specifies the calculator that determines the dates in the date range."
10075
+ "shortText": "The calculator that determines the dates in the date range."
10076
10076
  },
10077
10077
  "sources": [
10078
10078
  {
@@ -10096,7 +10096,7 @@
10096
10096
  "isOptional": true
10097
10097
  },
10098
10098
  "comment": {
10099
- "shortText": "Specifies the last date in the date range."
10099
+ "shortText": "The last date in the date range."
10100
10100
  },
10101
10101
  "sources": [
10102
10102
  {
@@ -10126,7 +10126,7 @@
10126
10126
  "isOptional": true
10127
10127
  },
10128
10128
  "comment": {
10129
- "shortText": "Specifies the first date in the date range."
10129
+ "shortText": "The first date in the date range."
10130
10130
  },
10131
10131
  "sources": [
10132
10132
  {
@@ -10313,7 +10313,7 @@
10313
10313
  "isOptional": true
10314
10314
  },
10315
10315
  "comment": {
10316
- "shortText": "Provides an observable that allows the consumer to push custom dates back to the calendar\nwhen the `SkyCalendarDateRangeChangeEvent` event fires. This is useful\nfor displaying key dates or disabled dates each time the calendar changes. If disabled dates\nare provided, SKY UX will prevent the user from selecting the date from the calendar.\nHowever, consumers will still need to add a custom validator to prevent users from entering\ndisabled dates in the text input."
10316
+ "shortText": "The observable that allows the consumer to push custom dates back to the calendar\nwhen the `SkyCalendarDateRangeChangeEvent` event fires. This is useful\nfor displaying key dates or disabled dates each time the calendar changes. If disabled dates\nare provided, SKY UX will prevent the user from selecting the date from the calendar.\nHowever, consumers will still need to add a custom validator to prevent users from entering\ndisabled dates in the text input."
10317
10317
  },
10318
10318
  "sources": [
10319
10319
  {
@@ -10447,7 +10447,7 @@
10447
10447
  "isOptional": true
10448
10448
  },
10449
10449
  "comment": {
10450
- "shortText": "Indicates whether to disable the date."
10450
+ "shortText": "Whether to disable the date."
10451
10451
  },
10452
10452
  "sources": [
10453
10453
  {
@@ -10470,7 +10470,7 @@
10470
10470
  "isOptional": true
10471
10471
  },
10472
10472
  "comment": {
10473
- "shortText": "Indicates whether to display the date as a key date in the calendar."
10473
+ "shortText": "Whether to display the date as a key date in the calendar."
10474
10474
  },
10475
10475
  "sources": [
10476
10476
  {
@@ -10547,7 +10547,7 @@
10547
10547
  "isOptional": true
10548
10548
  },
10549
10549
  "comment": {
10550
- "shortText": "Specifies the day in a fuzzy date, where `1` sets the day\nto the first day of the specified month."
10550
+ "shortText": "The day in a fuzzy date, where `1` sets the day\nto the first day of the specified month."
10551
10551
  },
10552
10552
  "sources": [
10553
10553
  {
@@ -10570,7 +10570,7 @@
10570
10570
  "isOptional": true
10571
10571
  },
10572
10572
  "comment": {
10573
- "shortText": "Specifies the month in a fuzzy date, where `1` sets the month to January."
10573
+ "shortText": "The month in a fuzzy date, where `1` sets the month to January."
10574
10574
  },
10575
10575
  "sources": [
10576
10576
  {
@@ -10593,7 +10593,7 @@
10593
10593
  "isOptional": true
10594
10594
  },
10595
10595
  "comment": {
10596
- "shortText": "Specifies the year in a fuzzy date."
10596
+ "shortText": "The year in a fuzzy date."
10597
10597
  },
10598
10598
  "sources": [
10599
10599
  {
@@ -10641,7 +10641,7 @@
10641
10641
  "kindString": "Property",
10642
10642
  "flags": {},
10643
10643
  "comment": {
10644
- "shortText": "Specifies the time format string."
10644
+ "shortText": "The time format string."
10645
10645
  },
10646
10646
  "sources": [
10647
10647
  {
@@ -10662,7 +10662,7 @@
10662
10662
  "kindString": "Property",
10663
10663
  "flags": {},
10664
10664
  "comment": {
10665
- "shortText": "Specifies the hour."
10665
+ "shortText": "The hour."
10666
10666
  },
10667
10667
  "sources": [
10668
10668
  {
@@ -10683,7 +10683,7 @@
10683
10683
  "kindString": "Property",
10684
10684
  "flags": {},
10685
10685
  "comment": {
10686
- "shortText": "Specifies the date in [iso8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)."
10686
+ "shortText": "The date in [iso8601 format](https://www.iso.org/iso-8601-date-and-time-format.html)."
10687
10687
  },
10688
10688
  "sources": [
10689
10689
  {
@@ -10706,7 +10706,7 @@
10706
10706
  "kindString": "Property",
10707
10707
  "flags": {},
10708
10708
  "comment": {
10709
- "shortText": "Specifies the date in the current local time format."
10709
+ "shortText": "The date in the current local time format."
10710
10710
  },
10711
10711
  "sources": [
10712
10712
  {
@@ -10727,7 +10727,7 @@
10727
10727
  "kindString": "Property",
10728
10728
  "flags": {},
10729
10729
  "comment": {
10730
- "shortText": "Specifies the meridian (`AM` or `PM`)."
10730
+ "shortText": "The meridian (`AM` or `PM`)."
10731
10731
  },
10732
10732
  "sources": [
10733
10733
  {
@@ -10748,7 +10748,7 @@
10748
10748
  "kindString": "Property",
10749
10749
  "flags": {},
10750
10750
  "comment": {
10751
- "shortText": "Specifies the minute."
10751
+ "shortText": "The minute."
10752
10752
  },
10753
10753
  "sources": [
10754
10754
  {
@@ -10769,7 +10769,7 @@
10769
10769
  "kindString": "Property",
10770
10770
  "flags": {},
10771
10771
  "comment": {
10772
- "shortText": "Specifies the time zone."
10772
+ "shortText": "The time zone."
10773
10773
  },
10774
10774
  "sources": [
10775
10775
  {
@@ -11039,7 +11039,7 @@
11039
11039
  {
11040
11040
  "fileName": "datepicker-demo.component.ts",
11041
11041
  "filePath": "/projects/datetime/documentation/code-examples/datepicker/custom-dates/datepicker-demo.component.ts",
11042
- "rawContents": "import { Component } from '@angular/core';\nimport { FormBuilder, FormControl, FormGroup } from '@angular/forms';\nimport {\n SkyDatepickerCalendarChange,\n SkyDatepickerCustomDate,\n} from '@skyux/datetime';\n\nimport { Observable, of } from 'rxjs';\nimport { delay } from 'rxjs/operators';\n\n@Component({\n selector: 'app-datepicker-demo',\n templateUrl: './datepicker-demo.component.html',\n})\nexport class DatepickerDemoComponent {\n public myForm: FormGroup;\n\n constructor(formBuilder: FormBuilder) {\n this.myForm = formBuilder.group({\n myDate: new FormControl(new Date(1999, 10, 5)),\n });\n }\n\n public onCalendarDateRangeChange(event: SkyDatepickerCalendarChange): void {\n if (event) {\n // Bind observable to `customDates` argument and simulate delay for async process to finish.\n // Normally, `getCustomDates()` would be replaced by an async call to fetch data.\n event.customDates = this.#getCustomDates(event).pipe(delay(2000));\n }\n }\n\n /**\n * Generate fake custom dates based on the date range returned from the event.\n * This is for demonstration purposes only.\n */\n #getCustomDates(\n event: SkyDatepickerCalendarChange\n ): Observable<SkyDatepickerCustomDate[]> {\n const getNextDate = function (startDate: Date, daystoAdd: number): Date {\n const newDate = new Date(startDate);\n newDate.setDate(newDate.getDate() + daystoAdd);\n return newDate;\n };\n\n const customDates: SkyDatepickerCustomDate[] = [];\n customDates.push({\n date: event.startDate,\n disabled: false,\n keyDate: true,\n keyDateText: ['First date'],\n });\n\n customDates.push({\n date: getNextDate(event.startDate, 8),\n disabled: false,\n keyDate: true,\n keyDateText: ['Important'],\n });\n\n customDates.push({\n date: getNextDate(event.startDate, 9),\n disabled: false,\n keyDate: true,\n keyDateText: ['Also Important'],\n });\n\n customDates.push({\n date: getNextDate(event.startDate, 10),\n disabled: true,\n keyDate: true,\n keyDateText: ['Disabled'],\n });\n\n customDates.push({\n date: getNextDate(event.startDate, 11),\n disabled: true,\n keyDate: false,\n keyDateText: [],\n });\n\n customDates.push({\n date: getNextDate(event.startDate, 12),\n disabled: false,\n keyDate: true,\n keyDateText: [],\n });\n\n customDates.push({\n date: getNextDate(event.startDate, 13),\n disabled: false,\n keyDate: true,\n keyDateText: ['Multiple', 'Messages'],\n });\n\n customDates.push({\n date: event.endDate,\n disabled: false,\n keyDate: true,\n keyDateText: ['Last date'],\n });\n\n return of(customDates);\n }\n}\n"
11042
+ "rawContents": "import { Component } from '@angular/core';\nimport { FormBuilder, FormControl, FormGroup } from '@angular/forms';\nimport {\n SkyDatepickerCalendarChange,\n SkyDatepickerCustomDate,\n} from '@skyux/datetime';\n\nimport { Observable, of } from 'rxjs';\nimport { delay } from 'rxjs/operators';\n\n@Component({\n selector: 'app-datepicker-demo',\n templateUrl: './datepicker-demo.component.html',\n})\nexport class DatepickerDemoComponent {\n public myForm: FormGroup;\n\n constructor(formBuilder: FormBuilder) {\n this.myForm = formBuilder.group({\n myDate: new FormControl(new Date(1999, 10, 5)),\n });\n }\n\n public onCalendarDateRangeChange(event: SkyDatepickerCalendarChange): void {\n if (event) {\n // Bind observable to `customDates` argument and simulate delay for async process to finish.\n // Normally, `getCustomDates()` would be replaced by an async call to fetch data.\n event.customDates = this.#getCustomDates(event).pipe(delay(2000));\n }\n }\n\n /**\n * Generate fake custom dates based on the date range returned from the event.\n * This is for demonstration purposes only.\n */\n #getCustomDates(\n event: SkyDatepickerCalendarChange\n ): Observable<SkyDatepickerCustomDate[]> {\n const getNextDate = function (startDate: Date, daysToAdd: number): Date {\n const newDate = new Date(startDate);\n newDate.setDate(newDate.getDate() + daysToAdd);\n return newDate;\n };\n\n const customDates: SkyDatepickerCustomDate[] = [];\n customDates.push({\n date: event.startDate,\n disabled: false,\n keyDate: true,\n keyDateText: ['First date'],\n });\n\n customDates.push({\n date: getNextDate(event.startDate, 8),\n disabled: false,\n keyDate: true,\n keyDateText: ['Important'],\n });\n\n customDates.push({\n date: getNextDate(event.startDate, 9),\n disabled: false,\n keyDate: true,\n keyDateText: ['Also Important'],\n });\n\n customDates.push({\n date: getNextDate(event.startDate, 10),\n disabled: true,\n keyDate: true,\n keyDateText: ['Disabled'],\n });\n\n customDates.push({\n date: getNextDate(event.startDate, 11),\n disabled: true,\n keyDate: false,\n keyDateText: [],\n });\n\n customDates.push({\n date: getNextDate(event.startDate, 12),\n disabled: false,\n keyDate: true,\n keyDateText: [],\n });\n\n customDates.push({\n date: getNextDate(event.startDate, 13),\n disabled: false,\n keyDate: true,\n keyDateText: ['Multiple', 'Messages'],\n });\n\n customDates.push({\n date: event.endDate,\n disabled: false,\n keyDate: true,\n keyDateText: ['Last date'],\n });\n\n return of(customDates);\n }\n}\n"
11043
11043
  },
11044
11044
  {
11045
11045
  "fileName": "datepicker-demo.module.ts",