@skyux/lists 7.5.0 → 7.6.0

package/fesm2020/skyux-lists.mjs

@@ -108,23 +108,23 @@ let nextId = 0;
 class SkyFilterButtonComponent {
     constructor() {
         /**
-         * Indicates whether the filtering options are exposed.
+         * Whether the filtering options are exposed.
          * To support [accessibility rules for disclosures](https://www.w3.org/TR/wai-aria-practices-1.1/#disclosure),
          * this property is necessary when using inline filters.
          */
         this.ariaExpanded = false;
         /**
-         * Indicates whether to highlight the filter button to indicate that filters were applied.
+         * Whether to highlight the filter button to indicate that filters were applied.
          * We recommend setting this property to `true` when no indication of filtering is visible
          * to users. For example, set it to `true` if you do not display the filter summary.
          */
         this.active = false;
         /**
-         * Indicates whether to disable the filter button.
+         * Whether to disable the filter button.
          */
         this.disabled = false;
         /**
-         * Indicates whether to display a **Filter** label beside the icon on the filter button.
+         * Whether to display a "Filter" label beside the icon on the filter button.
          */
         this.showButtonText = false;
         /**
@@ -136,7 +136,7 @@ class SkyFilterButtonComponent {
         __classPrivateFieldSet(this, _SkyFilterButtonComponent_filterButtonIdOrDefault, __classPrivateFieldSet(this, _SkyFilterButtonComponent_defaultButtonId, `sky-filter-button-${++nextId}`, "f"), "f");
     }
     /**
-     * Specifies an ID for the filter button.
+     * The ID for the filter button.
      */
     get filterButtonId() {
         return __classPrivateFieldGet(this, _SkyFilterButtonComponent_filterButtonIdOrDefault, "f");
@@ -211,7 +211,7 @@ class SkyFilterSummaryItemComponent {
         _SkyFilterSummaryItemComponent__dismissible.set(this, true);
     }
     /**
-     * Indicates whether the filter summary item has a close button.
+     * Whether the filter summary item has a close button.
      */
     get dismissible() {
         return __classPrivateFieldGet(this, _SkyFilterSummaryItemComponent__dismissible, "f");
@@ -403,7 +403,7 @@ class SkyInfiniteScrollComponent {
         __classPrivateFieldSet(this, _SkyInfiniteScrollComponent_domAdapter, domAdapter, "f");
     }
     /**
-     * Indicates whether to make the infinite scroll component active when more data is available
+     * Whether to make the infinite scroll component active when more data is available
      * to load. By default, infinite scroll is inactive and does not call the load function.
      * @default false
      */
@@ -417,7 +417,7 @@ class SkyInfiniteScrollComponent {
         }
     }
     /**
-     * Indicates whether data is loading because of a `scrollEnd` event. Setting the property
+     * Whether data is loading because of a `scrollEnd` event. Setting the property
      * to `true` disables new `scrollEnd` events from firing until it changes to `false`. If this
      * property is not specified, the infinite scroll component watches the DOM for changes
      * and fires `scrollEnd` events when changes occur on its parent DOM element. Relying
@@ -506,19 +506,19 @@ class SkyPagingComponent {
     constructor() {
         _SkyPagingComponent_instances.add(this);
         /**
-         * Specifies the page number of the current page. Page numbers start at 1 and increment.
+         * The page number of the current page. Page numbers start at 1 and increment.
          */
         this.currentPage = 1;
         /**
-         * Specifies the total number of items across all pages.
+         * The total number of items across all pages.
          */
         this.itemCount = 0;
         /**
-         * Specifies the maximum number of pages to display in the pagination control.
+         * The maximum number of pages to display in the pagination control.
          */
         this.maxPages = 5;
         /**
-         * Specifies the number of items to display per page.
+         * The number of items to display per page.
          */
         this.pageSize = 10;
         /**
@@ -569,12 +569,12 @@ _SkyPagingComponent_instances = new WeakSet(), _SkyPagingComponent_getDisplayedP
     if (maxDisplayedPages % 2 !== 0) {
         upperBound += 1;
     }
-    // Wrap negative values to increase the upperbound
+    // Wrap negative values to increase the upper bound
     if (lowerBound < 0) {
         upperBound -= lowerBound;
         lowerBound = 0;
     }
-    // Wrap overflow to decrease the lowerbound
+    // Wrap overflow to decrease the lower bound
     if (upperBound > pageCount) {
         lowerBound -= upperBound - pageCount;
         upperBound = pageCount;
@@ -843,16 +843,16 @@ class SkyRepeaterItemComponent {
     constructor(repeaterService, changeDetector, adapterService, elementRef, resourceService) {
         _SkyRepeaterItemComponent_instances.add(this);
         /**
-         * Indicates whether users can change the order of the repeater item.
+         * Whether users can change the order of the repeater item.
          * The repeater component's `reorderable` property must also be set to `true`.
          */
         this.reorderable = false;
         /**
-         * Indicates whether to display a checkbox in the left of the repeater item.
+         * Whether to display a checkbox in the left of the repeater item.
          */
         this.selectable = false;
         /**
-         * Indicates whether to display an inline form within the repeater.
+         * Whether to display an inline form within the repeater.
          * Users can toggle between displaying and hiding the inline form.
          */
         this.showInlineForm = false;
@@ -955,7 +955,7 @@ class SkyRepeaterItemComponent {
         return __classPrivateFieldGet(this, _SkyRepeaterItemComponent__isDisabled, "f");
     }
     /**
-     * Indicates whether the repeater item is expanded.
+     * Whether the repeater item is expanded.
      * @default true
      */
     set isExpanded(value) {
@@ -965,7 +965,7 @@ class SkyRepeaterItemComponent {
         return __classPrivateFieldGet(this, _SkyRepeaterItemComponent_isExpanded, "f");
     }
     /**
-     * Indicates whether the repeater item's checkbox is selected.
+     * Whether the repeater item's checkbox is selected.
      * When users select the repeater item, the specified property on your model is updated accordingly.
      * @default false
      */
@@ -1224,7 +1224,7 @@ _SkyRepeaterItemComponent_adapterService = new WeakMap(), _SkyRepeaterItemCompon
         this.reorderState = __classPrivateFieldGet(this, _SkyRepeaterItemComponent_reorderStateDescription, "f");
     }
     else {
-        // TODO: Needs improvement to be localizable
+        // TODO: Needs improvement to be localized
         this.reorderState = `${__classPrivateFieldGet(this, _SkyRepeaterItemComponent_reorderFinishText, "f")} ${__classPrivateFieldGet(this, _SkyRepeaterItemComponent_reorderCurrentIndex, "f") + 1} ${__classPrivateFieldGet(this, _SkyRepeaterItemComponent_reorderInstructions, "f")}`;
         __classPrivateFieldSet(this, _SkyRepeaterItemComponent_reorderCurrentIndex, -1, "f");
     }
@@ -1317,7 +1317,7 @@ class SkyRepeaterComponent {
     constructor(changeDetector, repeaterService, adapterService, dragulaService, elementRef, renderer) {
         _SkyRepeaterComponent_instances.add(this);
         /**
-         * Indicates whether users can change the order of items in the repeater list.
+         * Whether users can change the order of items in the repeater list.
          * Each repeater item also has `reorderable` property to indicate whether
          * users can change its order.
          */
@@ -1376,7 +1376,7 @@ class SkyRepeaterComponent {
         __classPrivateFieldGet(this, _SkyRepeaterComponent_instances, "m", _SkyRepeaterComponent_initializeDragAndDrop).call(this);
     }
     /**
-     * Specifies a layout to determine which repeater items are expanded by default and whether
+     * The layout that determines which repeater items are expanded by default and whether
      * repeater items are expandable and collapsible. Collapsed items display titles only.
      * The valid options are `multiple`, `none`, and `single`.
      * - `multiple` loads repeater items in an expanded state unless `isExpanded` is set to
@@ -1759,7 +1759,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.2.11", ngImpo
 class SkySortComponent {
     constructor() {
         /**
-         * Indicates whether to display a "Sort" label beside the icon on the sort button.
+         * Whether to display a "Sort" label beside the icon on the sort button.
          */
         this.showButtonText = false;
         this.dropdownController = new Subject();