@skyux/grids 7.4.2 → 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.
@@ -10,60 +10,60 @@ import * as i0 from "@angular/core";
10
10
  */
11
11
  export declare class SkyGridColumnComponent implements OnChanges {
12
12
  /**
13
- * Specifies the horizontal alignment of the column's data and header.
13
+ * The horizontal alignment of the column's data and header.
14
14
  * Options include: `"left"`, `"center"`, and `"right"`.
15
15
  * @default "left"
16
16
  */
17
17
  alignment: SkyGridColumnAlignment;
18
18
  /**
19
- * Specifies a description for the column.
19
+ * The description for the column.
20
20
  */
21
21
  description: string;
22
22
  /**
23
- * Indicates whether to disable the highlighting of search text in the column.
23
+ * Whether to disable the highlighting of search text in the column.
24
24
  * @default false
25
25
  */
26
26
  excludeFromHighlighting: boolean;
27
27
  /**
28
- * Specifies the property to retrieve cell information from an entry on the grid `data` array.
28
+ * The property to retrieve cell information from an entry on the grid `data` array.
29
29
  * You must provide either the `id` or `field` property for every column,
30
30
  * but do not provide both. If `id` does not exist on a column, then `field` is the entry
31
31
  * for the grid `selectedColumnIds` array.
32
32
  */
33
33
  field: string;
34
34
  /**
35
- * Specifies text to display in the column header.
35
+ * Text to display in the column header.
36
36
  */
37
37
  heading: string;
38
38
  /**
39
- * Indicates whether the column is initially hidden when grid `selectedColumnIds` are not provided.
39
+ * Whether the column is initially hidden when grid `selectedColumnIds` are not provided.
40
40
  * @default false
41
41
  */
42
42
  hidden: boolean;
43
43
  /**
44
- * Specifies a unique ID for the column. You must provide either the `id` or `field` property
44
+ * The unique ID for the column. You must provide either the `id` or `field` property
45
45
  * for every column, but do not provide both. If `field` does not exist on a column,
46
46
  * then the `id` property retrieves cell information from an entry on the grid `data` array.
47
47
  */
48
48
  id: string;
49
49
  /**
50
- * Specifies a template to display inside an inline help popup for this column.
50
+ * The template to display inside an inline help popup for this column.
51
51
  */
52
52
  inlineHelpPopover: any;
53
53
  /**
54
- * Indicates whether the column sorts the grid when users click the column header.
54
+ * Whether the column sorts the grid when users click the column header.
55
55
  * @default true
56
56
  */
57
57
  isSortable: boolean;
58
58
  /**
59
- * Indicates whether the column is locked. The intent is to display locked columns first
59
+ * Whether the column is locked. The intent is to display locked columns first
60
60
  * on the left side of the grid. If set to `true`, then users cannot drag the column
61
61
  * to another position and or drag other columns before the locked column.
62
62
  * @default false
63
63
  */
64
64
  locked: boolean;
65
65
  /**
66
- * Specifies a search function to apply for the specific column. By default,
66
+ * The search function to apply for the specific column. By default,
67
67
  * the column executes a string compare on the column data.
68
68
  * @default (value, searchText) => value.toString().toLowerCase().indexOf(searchText) !== -1
69
69
  */
@@ -73,7 +73,7 @@ export declare class SkyGridColumnComponent implements OnChanges {
73
73
  */
74
74
  type: string;
75
75
  /**
76
- * Specifies a template for a column. This can be assigned as a reference
76
+ * The template for a column. This can be assigned as a reference
77
77
  * to the `template` attribute, or it can be assigned as a child of the `template` element
78
78
  * inside the `sky-grid-column` component. The template has access to the `value` variable,
79
79
  * which contains the value passed to the column, and the `row` variable, which contains
@@ -81,7 +81,7 @@ export declare class SkyGridColumnComponent implements OnChanges {
81
81
  */
82
82
  templateInput: TemplateRef<unknown>;
83
83
  /**
84
- * Specifies the width of the column in pixels.
84
+ * The width of the column in pixels.
85
85
  * If undefined, the column width is evenly distributed.
86
86
  */
87
87
  width: number;
@@ -27,17 +27,17 @@ export declare class SkyGridComponent implements OnInit, AfterContentInit, After
27
27
  private skyWindow;
28
28
  private uiConfigService;
29
29
  /**
30
- * Specifies columns and column properties for the grid.
30
+ * Columns and column properties for the grid.
31
31
  */
32
32
  set columns(newColumns: Array<SkyGridColumnModel>);
33
33
  get columns(): Array<SkyGridColumnModel>;
34
34
  /**
35
- * Specifies the data for the grid. Each item requires an `id` and a property that maps
35
+ * The data for the grid. Each item requires an `id` and a property that maps
36
36
  * to the `field` or `id` property of each column in the grid.
37
37
  */
38
38
  data: Array<any>;
39
39
  /**
40
- * Indicates whether to enable the multiselect feature to display a column of
40
+ * Whether to enable the multiselect feature to display a column of
41
41
  * checkboxes on the left side of the grid. You can specify a unique ID with
42
42
  * the `multiselectRowId` property, but multiselect defaults to the `id` property on
43
43
  * the `data` object.
@@ -45,7 +45,7 @@ export declare class SkyGridComponent implements OnInit, AfterContentInit, After
45
45
  */
46
46
  enableMultiselect: boolean;
47
47
  /**
48
- * Specifies how the grid fits to its parent. The valid options are `width`,
48
+ * How the grid fits to its parent. The valid options are `width`,
49
49
  * which fits the grid to the parent's full width, and `scroll`, which allows the grid
50
50
  * to exceed the parent's width. If the grid does not have enough columns to fill
51
51
  * the parent's width, it always stretches to the parent's full width.
@@ -53,48 +53,48 @@ export declare class SkyGridComponent implements OnInit, AfterContentInit, After
53
53
  */
54
54
  fit: string;
55
55
  /**
56
- * Indicates whether to display a toolbar with the grid.
56
+ * Whether to display a toolbar with the grid.
57
57
  */
58
58
  hasToolbar: boolean;
59
59
  /**
60
- * Specifies the height of the grid.
60
+ * The height of the grid.
61
61
  */
62
62
  height: number;
63
63
  /**
64
- * Specifies text to highlight within the grid.
64
+ * Text to highlight within the grid.
65
65
  * Typically, this property is used in conjunction with search.
66
66
  */
67
67
  highlightText: string;
68
68
  /**
69
- * Provides an observable to send commands to the grid.
69
+ * The observable to send commands to the grid.
70
70
  */
71
71
  messageStream: Subject<SkyGridMessage>;
72
72
  /**
73
- * Specifies a unique ID that matches a property on the `data` object.
73
+ * The unique ID that matches a property on the `data` object.
74
74
  * By default, this property uses the `id` property.
75
75
  */
76
76
  multiselectRowId: string;
77
77
  /**
78
- * Specifies the ID of the row to highlight. The ID matches the `id` property
78
+ * The ID of the row to highlight. The ID matches the `id` property
79
79
  * of the `data` object. Typically, this property is used in conjunction with
80
80
  * the flyout component to indicate the currently selected row.
81
81
  */
82
82
  rowHighlightedId: string;
83
83
  /**
84
- * Specifies the columns to display in the grid based on the `id` or `field` properties
84
+ * The columns to display in the grid based on the `id` or `field` properties
85
85
  * of the columns. If no columns are specified, then the grid displays all columns.
86
86
  */
87
87
  set selectedColumnIds(value: Array<string>);
88
88
  get selectedColumnIds(): Array<string>;
89
89
  /**
90
- * Specifies a set of IDs for the rows to select in a multiselect grid.
90
+ * The set of IDs for the rows to select in a multiselect grid.
91
91
  * The IDs match the `id` properties of the `data` objects.
92
92
  * Rows with IDs that are not included are de-selected in the grid.
93
93
  */
94
94
  set selectedRowIds(value: Array<string>);
95
95
  get selectedRowIds(): Array<string>;
96
96
  /**
97
- * Specifies a unique key for the UI Config Service to retrieve stored settings from a database.
97
+ * The unique key for the UI Config Service to retrieve stored settings from a database.
98
98
  * The UI Config Service saves configuration settings for users and returns
99
99
  * `selectedColumnIds` to preserve the columns to display and the preferred column order. You must provide `id` values for your `sky-grid-column` elements because the UI Config Service depends on those values to organize columns based on user settings. For more information about the UI Config Service, see [the sticky settings documentation](https://developer.blackbaud.com/skyux/learn/get-started/sticky-settings).
100
100
  */
@@ -110,7 +110,7 @@ export declare class SkyGridComponent implements OnInit, AfterContentInit, After
110
110
  */
111
111
  sortField: ListSortFieldSelectorModel;
112
112
  /**
113
- * Specifies the width of the grid in pixels.
113
+ * The width of the grid in pixels.
114
114
  */
115
115
  width: number;
116
116
  /**
@@ -238,7 +238,7 @@ export declare class SkyGridComponent implements OnInit, AfterContentInit, After
238
238
  private getColumnModelByIndex;
239
239
  private getMaxRangeByIndex;
240
240
  private getLastDisplayedColumn;
241
- private addDelimeter;
241
+ private addDelimiter;
242
242
  private destroyRowDelete;
243
243
  private emitSelectedRows;
244
244
  private getSelectedRows;
@@ -3,15 +3,15 @@
3
3
  */
4
4
  export interface SkyGridColumnWidthModelChange {
5
5
  /**
6
- * Specifies the id of the column.
6
+ * The ID of the column.
7
7
  */
8
8
  id?: string;
9
9
  /**
10
- * Specifies the field of the column.
10
+ * The field of the column.
11
11
  */
12
12
  field?: string;
13
13
  /**
14
- * Specifies the width of the column in pixels.
14
+ * The width of the column in pixels.
15
15
  */
16
16
  width: number;
17
17
  }
@@ -4,7 +4,7 @@ import { SkyGridMessageType } from './grid-message-type';
4
4
  */
5
5
  export interface SkyGridMessage {
6
6
  /**
7
- * Indicates what type of message is being sent.
7
+ * The type of message being sent.
8
8
  */
9
9
  type: SkyGridMessageType;
10
10
  /**
@@ -4,7 +4,7 @@ import { SkyGridSelectedRowsSource } from './grid-selected-rows-source';
4
4
  */
5
5
  export interface SkyGridSelectedRowsModelChange {
6
6
  /**
7
- * Indicates the `id`s of the rows that are selected.
7
+ * The IDs of the rows that are selected.
8
8
  */
9
9
  selectedRowIds?: string[];
10
10
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/grids",
3
- "version": "7.4.2",
3
+ "version": "7.6.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -35,13 +35,13 @@
35
35
  "@angular/common": "^14.2.11",
36
36
  "@angular/core": "^14.2.11",
37
37
  "@angular/forms": "^14.2.11",
38
- "@skyux/core": "7.4.2",
39
- "@skyux/forms": "7.4.2",
40
- "@skyux/i18n": "7.4.2",
41
- "@skyux/indicators": "7.4.2",
42
- "@skyux/layout": "7.4.2",
43
- "@skyux/list-builder-common": "7.4.2",
44
- "@skyux/popovers": "7.4.2"
38
+ "@skyux/core": "7.6.0",
39
+ "@skyux/forms": "7.6.0",
40
+ "@skyux/i18n": "7.6.0",
41
+ "@skyux/indicators": "7.6.0",
42
+ "@skyux/layout": "7.6.0",
43
+ "@skyux/list-builder-common": "7.6.0",
44
+ "@skyux/popovers": "7.6.0"
45
45
  },
46
46
  "dependencies": {
47
47
  "dragula": "3.7.3",