@skyux/list-builder 7.4.2 → 7.6.0

package/lib/modules/list/list-data-request.model.d.ts

@@ -6,31 +6,31 @@ import { ListSortModel } from './state/sort/sort.model';
  */
 export declare class ListDataRequestModel {
     /**
-     * Specifies a function to determine whether items are filtered.
+     * The function that determines whether items are filtered.
      * This property is required when using an in-memory data provider.
      */
     filters: ListFilterModel[];
     /**
-     * Specifies the number of items to display per page.
+     * The number of items to display per page.
      */
     pageSize: number;
     /**
-     * Specifies the current page number.
+     * The current page number.
      */
     pageNumber: number;
     /**
-     * Specifies a function to dynamically manage the data source when users
+     * The function to dynamically manage the data source when users
      * change the text in the list field. The search function must return an
      * array or a promise of an array. The `search` property is particularly useful
      * when the data source does not live in the source code.
      */
     search: ListSearchModel;
     /**
-     * Specifies a set of fields to sort by.
+     * The set of fields to sort by.
      */
     sort: ListSortModel;
     /**
-     * Indicates whether to disable the search bar and filter button.
+     * Whether to disable the search bar and filter button.
      * @default false
      */
     isToolbarDisabled: boolean;

package/lib/modules/list/list-paging.component.d.ts

@@ -2,7 +2,7 @@ import { BehaviorSubject } from 'rxjs';
 import { ListStateDispatcher } from './state/list-state.rxstate';
 import { ListState } from './state/list-state.state-node';
 /**
- * Provides a SKY UX-themed pagination control to display list data across multiple pages.
+ * The SKY UX-themed pagination control that displays list data across multiple pages.
  * @internal
  * @deprecated
  */

package/lib/modules/list/list.component.d.ts

@@ -17,7 +17,7 @@ export declare class SkyListComponent implements AfterContentInit, OnChanges, On
     private dispatcher;
     id: string;
     /**
-     * Specifies the data to display. The list component requires this property or the
+     * The data to display. The list component requires this property or the
      * `dataProvider` property. For checklist or multiselect grids, each row requires an
      * `id` property to manage selected items with the `selectedIds` input and the
      * `selectedIdsChange` event. If you do not provide an `id`, the list automatically
@@ -26,7 +26,7 @@ export declare class SkyListComponent implements AfterContentInit, OnChanges, On
      */
     data?: Array<any> | Observable<Array<any>>;
     /**
-     * Specifies a data provider to obtain the data to display. The list component requires
+     * The data provider that obtains the data to display. The list component requires
      * this property or the `data` property. For lists that use `dataProvider` instead of `data`,
      * consumers are responsible for managing all `ListDataRequestModel` properties.
      * @default SkyListInMemoryDataProvider
@@ -37,25 +37,25 @@ export declare class SkyListComponent implements AfterContentInit, OnChanges, On
      */
     defaultView?: ListViewComponent;
     /**
-     * Specifies the total number of items for the initial data set when initialized. When
+     * The total number of items for the initial data set when initialized. When
      * used in conjunction with `data` and `dataProvider`, it allows an initial data to be
      * set with the need to call the `dataProvider`.
      */
     initialTotal?: number;
     /**
-     * Specifies a set of IDs for the items to select in a checklist or multiselect grid.
+     * The set of IDs for the items to select in a checklist or multiselect grid.
      * The IDs match the `id` properties of the `data` objects. Items with IDs that are not
      * included are de-selected in the checklist or multiselect grid.
      */
     selectedIds?: Array<string> | Observable<Array<string>>;
     /**
-     * Specifies a set of fields to sort by. If array of fields then sorted by order of array.
+     * The set of fields to sort by. If array of fields then sorted by order of array.
      * For information about `ListSortFieldSelectorModel`, see the
      * [shared classes for lists](https://developer.blackbaud.com/skyux-list-builder-common/docs/list-builder-common).
      */
     sortFields?: ListSortFieldSelectorModel | Array<ListSortFieldSelectorModel> | Observable<Array<ListSortFieldSelectorModel>> | Observable<ListSortFieldSelectorModel>;
     /**
-     * Specifies a set of filters to apply to list data.
+     * The set of filters to apply to list data.
      * These filters create a filter summary when the list includes the
      * [`sky-list-filter-summary`](https://developer.blackbaud.com/skyux/components/list/filters)
      * component.
@@ -70,7 +70,7 @@ export declare class SkyListComponent implements AfterContentInit, OnChanges, On
      */
     appliedFiltersChange: EventEmitter<ListFilterModel[]>;
     /**
-     * Specifies a function to apply as a global sort on the list.
+     * The function to apply as a global sort on the list.
      */
     searchFunction: (data: any, searchText: string) => boolean;
     private dataFirstLoad;

package/lib/modules/list/state/search/search.model.d.ts

@@ -7,18 +7,18 @@
  */
 export declare class ListSearchModel {
     /**
-     * Specifies the text to search.
+     * The text to search.
      * @default ""
      */
     searchText: string;
     /**
-     * Specifies an array of functions that returns a `boolean` value of `true` when
+     * The array of functions that returns a `boolean` value of `true` when
      * the search is successful. This property accepts a function of type
      * `(data: any, searchText: string) => boolean>.`
      */
     functions: Array<(data: any, searchText: string) => boolean>;
     /**
-     * Specifies the columns to search. The columns correspond to `field` values that
+     * The columns to search. The columns correspond to `field` values that
      * you specify with the list component's `data` property.
      */
     fieldSelectors: Array<string>;

package/lib/modules/list/state/sort/label.model.d.ts

@@ -4,24 +4,24 @@
  */
 export declare class ListSortLabelModel {
     /**
-     * Specifies the text for the label.
+     * The text for the label.
      */
     text: string;
     /**
-     * Specifies the label type.
+     * The label type.
      */
     fieldType: string;
     /**
-     * Specifies the fields to sort.
+     * The fields to sort.
      */
     fieldSelector: string;
     /**
-     * Indicates whether to sort all fields.
+     * Whether to sort all fields.
      * @default false
      */
     global: boolean;
     /**
-     * Indicates whether to sort in descending order.
+     * Whether to sort in descending order.
      * @default false
      */
     descending: boolean;

package/lib/modules/list/state/sort/sort.model.d.ts

@@ -6,15 +6,15 @@ import { ListSortLabelModel } from './label.model';
  */
 export declare class ListSortModel {
     /**
-     * Specifies the list of available views to sort.
+     * The list of available views to sort.
      */
     available: Array<ListSortLabelModel>;
     /**
-     * Specifies whether the sort applies to all list views.
+     * The list views that the sort applies to.
      */
     global: Array<ListSortLabelModel>;
     /**
-     * Specifies the fields to sort.
+     * The fields to sort.
      * For information about `ListSortFieldSelectorModel`, see the
      * [shared classes for lists](https://developer.blackbaud.com/skyux-list-builder-common/docs/list-builder-common).
      */

package/lib/modules/list-filters/filter.model.d.ts

@@ -1,31 +1,31 @@
 import { ListItemModel } from '@skyux/list-builder-common';
 export declare class ListFilterModel {
     /**
-     * Specifies the name of the filter.
+     * The name of the filter.
      * @required
      */
     name: string;
     /**
-     * Specifies a label for the filter's summary item.
+     * The label for the filter's summary item.
      * The label defaults to the `value` of the filter.
      */
     label: string;
     /**
-     * Indicates whether users can dismiss the filter's summary item.
+     * Whether users can dismiss the filter's summary item.
      * @default true
      */
     dismissible: boolean;
     /**
-     * Specifies the current value of the filter.
+     * The current value of the filter.
      */
     value: any;
     /**
-     * Specifies the default value of the filter. When users do not set the
+     * The default value of the filter. When a filter equals the
      * default value, the filter does not affect the list.
      */
     defaultValue: any;
     /**
-     * Specifies a function to determine whether items are filtered.
+     * The function that determines whether items are filtered.
      * This property is required when using an in-memory data provider.
      * For information about `ListItemModel`, see the
      * [shared classes for lists](https://developer.blackbaud.com/skyux-list-builder-common/docs/list-builder-common).

package/lib/modules/list-filters/list-filter-inline-item.component.d.ts

@@ -7,28 +7,28 @@ import * as i0 from "@angular/core";
  */
 export declare class SkyListFilterInlineItemComponent implements OnInit {
     /**
-     * Specifies the name of the filter.
+     * The name of the filter.
      * @required
      */
     name: string;
     /**
-     * Specifies the current value of the filter.
+     * The current value of the filter.
      */
     value: any;
     /**
-     * Specifies the default value of the filter. If the value of the filter
+     * The default value of the filter. If the value of the filter
      * is set to the default value, then the filter is not applied.
      */
     defaultValue: any;
     /**
-     * Specifies the function to apply to determine whether an item is filtered.
+     * The function that determines whether an item is filtered.
      * This property is required when using an in-memory data provider. For information
      * about `ListItemModel`, see the
      * [shared classes for lists](https://developer.blackbaud.com/skyux-list-builder-common/docs/list-builder-common).
      */
     filterFunction: (item: ListItemModel, filter: any) => boolean;
     /**
-     * Specifies the template for the filter. The template can access the `filter`
+     * The template for the filter. The template can access the `filter`
      * variable that contains the `value` of the filter control, which should be bound to
      * `ngModel`, and the `changed` function, which should be called when the model changes.
      * @required

package/lib/modules/list-paging/list-paging.component.d.ts

@@ -11,17 +11,17 @@ import * as i0 from "@angular/core";
  */
 export declare class SkyListPagingComponent extends ListPagingComponent implements OnInit {
     /**
-     * Specifies the number of list items per page.
+     * The number of list items per page.
      * @default 10
      */
     pageSize: Observable<number> | number;
     /**
-     * Specifies the maximum pages to display.
+     * The maximum pages to display.
      * @default 5
      */
     maxPages: Observable<number> | number;
     /**
-     * Specifies the current page number.
+     * The current page number.
      * @default 1
      */
     pageNumber: Observable<number> | number;

package/lib/modules/list-toolbar/list-toolbar-item.component.d.ts

@@ -6,16 +6,16 @@ import * as i0 from "@angular/core";
  */
 export declare class SkyListToolbarItemComponent {
     /**
-     * Specifies the ID of the item.
+     * The ID of the item.
      */
     id: string;
     /**
-     * Specifies the index of the item at the given item location.
+     * The index of the item at the given item location.
      * @default -1
      */
     index: number;
     /**
-     * Specifies the toolbar location of the item. The valid options are `"left"`,
+     * The toolbar location of the item. The valid options are `"left"`,
      * `"center"`, and `"right"`.
      * @default "left"
      */

package/lib/modules/list-toolbar/list-toolbar-sort.component.d.ts

@@ -5,22 +5,22 @@ import * as i0 from "@angular/core";
  */
 export declare class SkyListToolbarSortComponent {
     /**
-     * Specifies a label for a sort option.
+     * The label for a sort option.
      * @required
      */
     label: string;
     /**
-     * Specifies the data field to sort the list on.
+     * The data field to sort the list on.
      * @required
      */
     field: string;
     /**
-     * Specifies the data type of the data field to sort the list on.
+     * The data type of the data field to sort the list on.
      * @required
      */
     type: string;
     /**
-     * Indicates whether to sort data in descending order.
+     * Whether to sort data in descending order.
      * @default false
      */
     descending: boolean;

package/lib/modules/list-toolbar/list-toolbar.component.d.ts

@@ -21,7 +21,7 @@ export declare class SkyListToolbarComponent implements OnInit, AfterContentInit
     private toolbarState;
     toolbarDispatcher: ListToolbarStateDispatcher;
     /**
-     * Indicates whether to use the in-memory search.
+     * Whether to use the in-memory search.
      * Setting this to `false` will allow consumers to run their own searches remotely,
      * and push new values to the list component by updating the `data` property.
      * @default true
@@ -30,19 +30,19 @@ export declare class SkyListToolbarComponent implements OnInit, AfterContentInit
     set inMemorySearchEnabled(value: boolean);
     get inMemorySearchEnabled(): boolean;
     /**
-     * Specifies placeholder text for the search bar that the list toolbar creates with
+     * Placeholder text for the search bar that the list toolbar creates with
      * a [search component](https://developer.blackbaud.com/skyux/components/search).
      * @default "Find in this list"
      */
     placeholder: string;
     /**
-     * Indicates whether to enable the search bar.
+     * Whether to enable the search bar.
      * @default true
      */
     searchEnabled: boolean | Observable<boolean>;
     searchComponent: SkySearchComponent;
     /**
-     * Indicates whether to enable the sort selector.
+     * Whether to enable the sort selector.
      * @default false
      */
     sortSelectorEnabled: boolean | Observable<boolean>;
@@ -54,7 +54,7 @@ export declare class SkyListToolbarComponent implements OnInit, AfterContentInit
      */
     toolbarType: string;
     /**
-     * Specifies a text string to search with.
+     * The text string to search with.
      */
     searchText: string | Observable<string>;
     get isFilterBarDisplayed(): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/list-builder",
-  "version": "7.4.2",
+  "version": "7.6.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -34,15 +34,15 @@
   "peerDependencies": {
     "@angular/common": "^14.2.11",
     "@angular/core": "^14.2.11",
-    "@skyux/core": "7.4.2",
-    "@skyux/forms": "7.4.2",
-    "@skyux/i18n": "7.4.2",
-    "@skyux/indicators": "7.4.2",
-    "@skyux/layout": "7.4.2",
-    "@skyux/list-builder-common": "7.4.2",
-    "@skyux/lists": "7.4.2",
-    "@skyux/lookup": "7.4.2",
-    "@skyux/popovers": "7.4.2"
+    "@skyux/core": "7.6.0",
+    "@skyux/forms": "7.6.0",
+    "@skyux/i18n": "7.6.0",
+    "@skyux/indicators": "7.6.0",
+    "@skyux/layout": "7.6.0",
+    "@skyux/list-builder-common": "7.6.0",
+    "@skyux/lists": "7.6.0",
+    "@skyux/lookup": "7.6.0",
+    "@skyux/popovers": "7.6.0"
   },
   "dependencies": {
     "tslib": "^2.3.1"