@skyux/lists 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.
@@ -108,23 +108,23 @@ let nextId = 0;
108
108
  class SkyFilterButtonComponent {
109
109
  constructor() {
110
110
  /**
111
- * Indicates whether the filtering options are exposed.
111
+ * Whether the filtering options are exposed.
112
112
  * To support [accessibility rules for disclosures](https://www.w3.org/TR/wai-aria-practices-1.1/#disclosure),
113
113
  * this property is necessary when using inline filters.
114
114
  */
115
115
  this.ariaExpanded = false;
116
116
  /**
117
- * Indicates whether to highlight the filter button to indicate that filters were applied.
117
+ * Whether to highlight the filter button to indicate that filters were applied.
118
118
  * We recommend setting this property to `true` when no indication of filtering is visible
119
119
  * to users. For example, set it to `true` if you do not display the filter summary.
120
120
  */
121
121
  this.active = false;
122
122
  /**
123
- * Indicates whether to disable the filter button.
123
+ * Whether to disable the filter button.
124
124
  */
125
125
  this.disabled = false;
126
126
  /**
127
- * Indicates whether to display a **Filter** label beside the icon on the filter button.
127
+ * Whether to display a "Filter" label beside the icon on the filter button.
128
128
  */
129
129
  this.showButtonText = false;
130
130
  /**
@@ -136,7 +136,7 @@ class SkyFilterButtonComponent {
136
136
  __classPrivateFieldSet(this, _SkyFilterButtonComponent_filterButtonIdOrDefault, __classPrivateFieldSet(this, _SkyFilterButtonComponent_defaultButtonId, `sky-filter-button-${++nextId}`, "f"), "f");
137
137
  }
138
138
  /**
139
- * Specifies an ID for the filter button.
139
+ * The ID for the filter button.
140
140
  */
141
141
  get filterButtonId() {
142
142
  return __classPrivateFieldGet(this, _SkyFilterButtonComponent_filterButtonIdOrDefault, "f");
@@ -211,7 +211,7 @@ class SkyFilterSummaryItemComponent {
211
211
  _SkyFilterSummaryItemComponent__dismissible.set(this, true);
212
212
  }
213
213
  /**
214
- * Indicates whether the filter summary item has a close button.
214
+ * Whether the filter summary item has a close button.
215
215
  */
216
216
  get dismissible() {
217
217
  return __classPrivateFieldGet(this, _SkyFilterSummaryItemComponent__dismissible, "f");
@@ -403,7 +403,7 @@ class SkyInfiniteScrollComponent {
403
403
  __classPrivateFieldSet(this, _SkyInfiniteScrollComponent_domAdapter, domAdapter, "f");
404
404
  }
405
405
  /**
406
- * Indicates whether to make the infinite scroll component active when more data is available
406
+ * Whether to make the infinite scroll component active when more data is available
407
407
  * to load. By default, infinite scroll is inactive and does not call the load function.
408
408
  * @default false
409
409
  */
@@ -417,7 +417,7 @@ class SkyInfiniteScrollComponent {
417
417
  }
418
418
  }
419
419
  /**
420
- * Indicates whether data is loading because of a `scrollEnd` event. Setting the property
420
+ * Whether data is loading because of a `scrollEnd` event. Setting the property
421
421
  * to `true` disables new `scrollEnd` events from firing until it changes to `false`. If this
422
422
  * property is not specified, the infinite scroll component watches the DOM for changes
423
423
  * and fires `scrollEnd` events when changes occur on its parent DOM element. Relying
@@ -506,19 +506,19 @@ class SkyPagingComponent {
506
506
  constructor() {
507
507
  _SkyPagingComponent_instances.add(this);
508
508
  /**
509
- * Specifies the page number of the current page. Page numbers start at 1 and increment.
509
+ * The page number of the current page. Page numbers start at 1 and increment.
510
510
  */
511
511
  this.currentPage = 1;
512
512
  /**
513
- * Specifies the total number of items across all pages.
513
+ * The total number of items across all pages.
514
514
  */
515
515
  this.itemCount = 0;
516
516
  /**
517
- * Specifies the maximum number of pages to display in the pagination control.
517
+ * The maximum number of pages to display in the pagination control.
518
518
  */
519
519
  this.maxPages = 5;
520
520
  /**
521
- * Specifies the number of items to display per page.
521
+ * The number of items to display per page.
522
522
  */
523
523
  this.pageSize = 10;
524
524
  /**
@@ -569,12 +569,12 @@ _SkyPagingComponent_instances = new WeakSet(), _SkyPagingComponent_getDisplayedP
569
569
  if (maxDisplayedPages % 2 !== 0) {
570
570
  upperBound += 1;
571
571
  }
572
- // Wrap negative values to increase the upperbound
572
+ // Wrap negative values to increase the upper bound
573
573
  if (lowerBound < 0) {
574
574
  upperBound -= lowerBound;
575
575
  lowerBound = 0;
576
576
  }
577
- // Wrap overflow to decrease the lowerbound
577
+ // Wrap overflow to decrease the lower bound
578
578
  if (upperBound > pageCount) {
579
579
  lowerBound -= upperBound - pageCount;
580
580
  upperBound = pageCount;
@@ -844,16 +844,16 @@ class SkyRepeaterItemComponent {
844
844
  constructor(repeaterService, changeDetector, adapterService, elementRef, resourceService) {
845
845
  _SkyRepeaterItemComponent_instances.add(this);
846
846
  /**
847
- * Indicates whether users can change the order of the repeater item.
847
+ * Whether users can change the order of the repeater item.
848
848
  * The repeater component's `reorderable` property must also be set to `true`.
849
849
  */
850
850
  this.reorderable = false;
851
851
  /**
852
- * Indicates whether to display a checkbox in the left of the repeater item.
852
+ * Whether to display a checkbox in the left of the repeater item.
853
853
  */
854
854
  this.selectable = false;
855
855
  /**
856
- * Indicates whether to display an inline form within the repeater.
856
+ * Whether to display an inline form within the repeater.
857
857
  * Users can toggle between displaying and hiding the inline form.
858
858
  */
859
859
  this.showInlineForm = false;
@@ -956,7 +956,7 @@ class SkyRepeaterItemComponent {
956
956
  return __classPrivateFieldGet(this, _SkyRepeaterItemComponent__isDisabled, "f");
957
957
  }
958
958
  /**
959
- * Indicates whether the repeater item is expanded.
959
+ * Whether the repeater item is expanded.
960
960
  * @default true
961
961
  */
962
962
  set isExpanded(value) {
@@ -966,7 +966,7 @@ class SkyRepeaterItemComponent {
966
966
  return __classPrivateFieldGet(this, _SkyRepeaterItemComponent_isExpanded, "f");
967
967
  }
968
968
  /**
969
- * Indicates whether the repeater item's checkbox is selected.
969
+ * Whether the repeater item's checkbox is selected.
970
970
  * When users select the repeater item, the specified property on your model is updated accordingly.
971
971
  * @default false
972
972
  */
@@ -1228,7 +1228,7 @@ _SkyRepeaterItemComponent_adapterService = new WeakMap(), _SkyRepeaterItemCompon
1228
1228
  this.reorderState = __classPrivateFieldGet(this, _SkyRepeaterItemComponent_reorderStateDescription, "f");
1229
1229
  }
1230
1230
  else {
1231
- // TODO: Needs improvement to be localizable
1231
+ // TODO: Needs improvement to be localized
1232
1232
  this.reorderState = `${__classPrivateFieldGet(this, _SkyRepeaterItemComponent_reorderFinishText, "f")} ${__classPrivateFieldGet(this, _SkyRepeaterItemComponent_reorderCurrentIndex, "f") + 1} ${__classPrivateFieldGet(this, _SkyRepeaterItemComponent_reorderInstructions, "f")}`;
1233
1233
  __classPrivateFieldSet(this, _SkyRepeaterItemComponent_reorderCurrentIndex, -1, "f");
1234
1234
  }
@@ -1321,7 +1321,7 @@ class SkyRepeaterComponent {
1321
1321
  constructor(changeDetector, repeaterService, adapterService, dragulaService, elementRef, renderer) {
1322
1322
  _SkyRepeaterComponent_instances.add(this);
1323
1323
  /**
1324
- * Indicates whether users can change the order of items in the repeater list.
1324
+ * Whether users can change the order of items in the repeater list.
1325
1325
  * Each repeater item also has `reorderable` property to indicate whether
1326
1326
  * users can change its order.
1327
1327
  */
@@ -1381,7 +1381,7 @@ class SkyRepeaterComponent {
1381
1381
  __classPrivateFieldGet(this, _SkyRepeaterComponent_instances, "m", _SkyRepeaterComponent_initializeDragAndDrop).call(this);
1382
1382
  }
1383
1383
  /**
1384
- * Specifies a layout to determine which repeater items are expanded by default and whether
1384
+ * The layout that determines which repeater items are expanded by default and whether
1385
1385
  * repeater items are expandable and collapsible. Collapsed items display titles only.
1386
1386
  * The valid options are `multiple`, `none`, and `single`.
1387
1387
  * - `multiple` loads repeater items in an expanded state unless `isExpanded` is set to
@@ -1766,7 +1766,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
1766
1766
  class SkySortComponent {
1767
1767
  constructor() {
1768
1768
  /**
1769
- * Indicates whether to display a "Sort" label beside the icon on the sort button.
1769
+ * Whether to display a "Sort" label beside the icon on the sort button.
1770
1770
  */
1771
1771
  this.showButtonText = false;
1772
1772
  this.dropdownController = new Subject();