@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.
@@ -3,35 +3,35 @@ import * as i0 from "@angular/core";
3
3
  export declare class SkyFilterButtonComponent {
4
4
  #private;
5
5
  /**
6
- * Specifies an ID for the filter button.
6
+ * The ID for the filter button.
7
7
  */
8
8
  get filterButtonId(): string;
9
9
  set filterButtonId(value: string | undefined);
10
10
  /**
11
- * Specifies an ID to identify the element that contains
11
+ * The ID to identify the element that contains
12
12
  * the filtering options that the filter button exposes.
13
13
  * To support [accessibility rules for disclosures](https://www.w3.org/TR/wai-aria-practices-1.1/#disclosure),
14
14
  * this property is necessary when using inline filters.
15
15
  */
16
16
  ariaControls: string | undefined;
17
17
  /**
18
- * Indicates whether the filtering options are exposed.
18
+ * Whether the filtering options are exposed.
19
19
  * To support [accessibility rules for disclosures](https://www.w3.org/TR/wai-aria-practices-1.1/#disclosure),
20
20
  * this property is necessary when using inline filters.
21
21
  */
22
22
  ariaExpanded: boolean | undefined;
23
23
  /**
24
- * Indicates whether to highlight the filter button to indicate that filters were applied.
24
+ * Whether to highlight the filter button to indicate that filters were applied.
25
25
  * We recommend setting this property to `true` when no indication of filtering is visible
26
26
  * to users. For example, set it to `true` if you do not display the filter summary.
27
27
  */
28
28
  active: boolean | undefined;
29
29
  /**
30
- * Indicates whether to disable the filter button.
30
+ * Whether to disable the filter button.
31
31
  */
32
32
  disabled: boolean | undefined;
33
33
  /**
34
- * Indicates whether to display a **Filter** label beside the icon on the filter button.
34
+ * Whether to display a "Filter" label beside the icon on the filter button.
35
35
  */
36
36
  showButtonText: boolean | undefined;
37
37
  /**
@@ -6,7 +6,7 @@ import * as i0 from "@angular/core";
6
6
  export declare class SkyFilterSummaryItemComponent {
7
7
  #private;
8
8
  /**
9
- * Indicates whether the filter summary item has a close button.
9
+ * Whether the filter summary item has a close button.
10
10
  */
11
11
  get dismissible(): boolean;
12
12
  set dismissible(value: boolean | undefined);
@@ -4,14 +4,14 @@ import * as i0 from "@angular/core";
4
4
  export declare class SkyInfiniteScrollComponent implements OnDestroy {
5
5
  #private;
6
6
  /**
7
- * Indicates whether to make the infinite scroll component active when more data is available
7
+ * Whether to make the infinite scroll component active when more data is available
8
8
  * to load. By default, infinite scroll is inactive and does not call the load function.
9
9
  * @default false
10
10
  */
11
11
  get enabled(): boolean | undefined;
12
12
  set enabled(value: boolean | undefined);
13
13
  /**
14
- * Indicates whether data is loading because of a `scrollEnd` event. Setting the property
14
+ * Whether data is loading because of a `scrollEnd` event. Setting the property
15
15
  * to `true` disables new `scrollEnd` events from firing until it changes to `false`. If this
16
16
  * property is not specified, the infinite scroll component watches the DOM for changes
17
17
  * and fires `scrollEnd` events when changes occur on its parent DOM element. Relying
@@ -3,23 +3,23 @@ import * as i0 from "@angular/core";
3
3
  export declare class SkyPagingComponent implements OnChanges {
4
4
  #private;
5
5
  /**
6
- * Specifies the page number of the current page. Page numbers start at 1 and increment.
6
+ * The page number of the current page. Page numbers start at 1 and increment.
7
7
  */
8
8
  currentPage: number;
9
9
  /**
10
- * Specifies the total number of items across all pages.
10
+ * The total number of items across all pages.
11
11
  */
12
12
  itemCount: number;
13
13
  /**
14
- * Specifies the maximum number of pages to display in the pagination control.
14
+ * The maximum number of pages to display in the pagination control.
15
15
  */
16
16
  maxPages: number;
17
17
  /**
18
- * Specifies the number of items to display per page.
18
+ * The number of items to display per page.
19
19
  */
20
20
  pageSize: number;
21
21
  /**
22
- * Specifies a label for the pagination control when an application includes
22
+ * The label for the pagination control when an application includes
23
23
  * multiple paging components on the same page. The label should be unique and descriptive
24
24
  * to help users of assistive technology differentiate pagination controls
25
25
  * and understand what each one does.
@@ -25,14 +25,14 @@ export declare class SkyRepeaterItemComponent implements OnDestroy, OnInit, Afte
25
25
  set disabled(value: boolean | undefined);
26
26
  get disabled(): boolean | undefined;
27
27
  /**
28
- * Specifies a human-readable name for the repeater item that is available for multiple purposes,
28
+ * The human-readable name for the repeater item that is available for multiple purposes,
29
29
  * such as accessibility and instrumentation. For example, the component uses the name to
30
30
  * construct ARIA labels for the repeater item controls
31
31
  * to [support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
32
32
  */
33
33
  itemName: string | undefined;
34
34
  /**
35
- * Specifies configuration options for the buttons to display on an inline form
35
+ * Configuration options for the buttons to display on an inline form
36
36
  * within the repeater. This property accepts
37
37
  * [a `SkyInlineFormConfig` object](https://developer.blackbaud.com/skyux/components/inline-form#skyinlineformconfig-properties).
38
38
  */
@@ -43,34 +43,34 @@ export declare class SkyRepeaterItemComponent implements OnDestroy, OnInit, Afte
43
43
  */
44
44
  inlineFormTemplate: TemplateRef<unknown> | undefined;
45
45
  /**
46
- * Indicates whether the repeater item is expanded.
46
+ * Whether the repeater item is expanded.
47
47
  * @default true
48
48
  */
49
49
  set isExpanded(value: boolean | undefined);
50
50
  get isExpanded(): boolean;
51
51
  /**
52
- * Indicates whether the repeater item's checkbox is selected.
52
+ * Whether the repeater item's checkbox is selected.
53
53
  * When users select the repeater item, the specified property on your model is updated accordingly.
54
54
  * @default false
55
55
  */
56
56
  set isSelected(value: boolean | undefined);
57
57
  get isSelected(): boolean | undefined;
58
58
  /**
59
- * Indicates whether users can change the order of the repeater item.
59
+ * Whether users can change the order of the repeater item.
60
60
  * The repeater component's `reorderable` property must also be set to `true`.
61
61
  */
62
62
  reorderable: boolean | undefined;
63
63
  /**
64
- * Indicates whether to display a checkbox in the left of the repeater item.
64
+ * Whether to display a checkbox in the left of the repeater item.
65
65
  */
66
66
  selectable: boolean | undefined;
67
67
  /**
68
- * Indicates whether to display an inline form within the repeater.
68
+ * Whether to display an inline form within the repeater.
69
69
  * Users can toggle between displaying and hiding the inline form.
70
70
  */
71
71
  showInlineForm: boolean | undefined;
72
72
  /**
73
- * Specifies an object that the repeater component returns for this repeater item
73
+ * The object that the repeater component returns for this repeater item
74
74
  * when the `orderChange` event fires. This is required
75
75
  * if you set the `reorderable` property to `true`.
76
76
  */
@@ -12,27 +12,27 @@ import * as i0 from "@angular/core";
12
12
  export declare class SkyRepeaterComponent implements AfterContentInit, OnChanges, OnDestroy, OnInit {
13
13
  #private;
14
14
  /**
15
- * Specifies the index of the repeater item to visually highlight as active.
15
+ * The index of the repeater item to visually highlight as active.
16
16
  * For example, use this property in conjunction with the
17
17
  * [split view component](https://developer.blackbaud.com/skyux/components/split-view)
18
18
  * to highlight a repeater item while users edit it. Only one item can be active at a time.
19
19
  */
20
20
  activeIndex: number | undefined;
21
21
  /**
22
- * Specifies an ARIA label for the repeater list.
22
+ * The ARIA label for the repeater list.
23
23
  * This sets the repeater list's `aria-label` attribute
24
24
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
25
25
  * @default "List of items"
26
26
  */
27
27
  ariaLabel: string | undefined;
28
28
  /**
29
- * Indicates whether users can change the order of items in the repeater list.
29
+ * Whether users can change the order of items in the repeater list.
30
30
  * Each repeater item also has `reorderable` property to indicate whether
31
31
  * users can change its order.
32
32
  */
33
33
  reorderable: boolean | undefined;
34
34
  /**
35
- * Specifies a layout to determine which repeater items are expanded by default and whether
35
+ * The layout that determines which repeater items are expanded by default and whether
36
36
  * repeater items are expandable and collapsible. Collapsed items display titles only.
37
37
  * The valid options are `multiple`, `none`, and `single`.
38
38
  * - `multiple` loads repeater items in an expanded state unless `isExpanded` is set to
@@ -5,7 +5,7 @@ import * as i0 from "@angular/core";
5
5
  export declare class SkySortItemComponent implements OnInit, OnChanges, OnDestroy {
6
6
  #private;
7
7
  /**
8
- * Indicates whether the sorting option is active.
8
+ * Whether the sorting option is active.
9
9
  */
10
10
  active: boolean | undefined;
11
11
  /**
@@ -3,7 +3,7 @@ import { Subject } from 'rxjs';
3
3
  import * as i0 from "@angular/core";
4
4
  export declare class SkySortComponent {
5
5
  /**
6
- * Indicates whether to display a "Sort" label beside the icon on the sort button.
6
+ * Whether to display a "Sort" label beside the icon on the sort button.
7
7
  */
8
8
  showButtonText: boolean | undefined;
9
9
  dropdownController: Subject<SkyDropdownMessage>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/lists",
3
- "version": "7.5.0",
3
+ "version": "7.6.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -44,15 +44,15 @@
44
44
  "@angular/common": "^14.2.11",
45
45
  "@angular/core": "^14.2.11",
46
46
  "@angular/platform-browser": "^14.2.11",
47
- "@skyux-sdk/testing": "7.5.0",
48
- "@skyux/animations": "7.5.0",
49
- "@skyux/core": "7.5.0",
50
- "@skyux/forms": "7.5.0",
51
- "@skyux/i18n": "7.5.0",
52
- "@skyux/indicators": "7.5.0",
53
- "@skyux/inline-form": "7.5.0",
54
- "@skyux/popovers": "7.5.0",
55
- "@skyux/theme": "7.5.0"
47
+ "@skyux-sdk/testing": "7.6.0",
48
+ "@skyux/animations": "7.6.0",
49
+ "@skyux/core": "7.6.0",
50
+ "@skyux/forms": "7.6.0",
51
+ "@skyux/i18n": "7.6.0",
52
+ "@skyux/indicators": "7.6.0",
53
+ "@skyux/inline-form": "7.6.0",
54
+ "@skyux/popovers": "7.6.0",
55
+ "@skyux/theme": "7.6.0"
56
56
  },
57
57
  "dependencies": {
58
58
  "dragula": "3.7.3",