@genesislcap/grid-tabulator 14.281.2 → 14.282.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.
- package/dist/custom-elements.json +57 -7
- package/dist/dts/cell-formatters/action.formatter.d.ts +5 -5
- package/dist/dts/cell-formatters/action.formatter.d.ts.map +1 -1
- package/dist/dts/cell-formatters/actions-menu.formatter.d.ts +10 -7
- package/dist/dts/cell-formatters/actions-menu.formatter.d.ts.map +1 -1
- package/dist/dts/cell-formatters/boolean.formatter.d.ts +4 -4
- package/dist/dts/cell-formatters/boolean.formatter.d.ts.map +1 -1
- package/dist/dts/cell-formatters/editable.formatter.d.ts +4 -4
- package/dist/dts/cell-formatters/editable.formatter.d.ts.map +1 -1
- package/dist/dts/cell-formatters/select.formatter.d.ts +14 -8
- package/dist/dts/cell-formatters/select.formatter.d.ts.map +1 -1
- package/dist/dts/cell-formatters/text.formatter.d.ts +3 -3
- package/dist/dts/cell-formatters/text.formatter.d.ts.map +1 -1
- package/dist/dts/types.d.ts +1 -0
- package/dist/dts/types.d.ts.map +1 -1
- package/dist/dts/utils/index.d.ts +1 -0
- package/dist/dts/utils/index.d.ts.map +1 -1
- package/dist/dts/utils/test-id-utils.d.ts +10 -0
- package/dist/dts/utils/test-id-utils.d.ts.map +1 -0
- package/dist/esm/cell-formatters/action.formatter.js +4 -2
- package/dist/esm/cell-formatters/actions-menu.formatter.js +11 -4
- package/dist/esm/cell-formatters/boolean.formatter.js +3 -1
- package/dist/esm/cell-formatters/editable.formatter.js +4 -1
- package/dist/esm/cell-formatters/select.formatter.js +170 -21
- package/dist/esm/cell-formatters/text.formatter.js +4 -1
- package/dist/esm/utils/index.js +1 -0
- package/dist/esm/utils/test-id-utils.js +15 -0
- package/dist/grid-tabulator.api.json +193 -43
- package/dist/grid-tabulator.d.ts +48 -28
- package/docs/api/grid-tabulator.actionformatter.md +2 -2
- package/docs/api/grid-tabulator.actionsmenuformatter.md +2 -2
- package/docs/api/grid-tabulator.booleanformatter.md +2 -2
- package/docs/api/grid-tabulator.editableformatter.md +2 -2
- package/docs/api/grid-tabulator.md +1 -1
- package/docs/api/grid-tabulator.selectformatter.md +4 -4
- package/docs/api/grid-tabulator.textformatter.md +2 -2
- package/docs/api-report.md +32 -24
- package/package.json +13 -13
|
@@ -9,7 +9,7 @@ Formatter that displays a dropdown menu of actions in the cell. Styled to match
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export declare function actionsMenuFormatter(cell: any, formatterParams?: ActionsMenuFormatterParams): string;
|
|
12
|
+
export declare function actionsMenuFormatter<T = any>(cell: any, formatterParams?: ActionsMenuFormatterParams<T>): string;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -17,7 +17,7 @@ export declare function actionsMenuFormatter(cell: any, formatterParams?: Action
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
19
|
| cell | any | The cell component provided by Tabulator |
|
|
20
|
-
| formatterParams | ActionsMenuFormatterParams | _(Optional)_ Actions menu formatter parameters |
|
|
20
|
+
| formatterParams | ActionsMenuFormatterParams<T> | _(Optional)_ Actions menu formatter parameters |
|
|
21
21
|
|
|
22
22
|
**Returns:**
|
|
23
23
|
|
|
@@ -9,7 +9,7 @@ Formatter that displays boolean values using a checkbox component. Styled to mat
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export declare function booleanFormatter(cell: any, formatterParams?: BooleanFormatterParams): string;
|
|
12
|
+
export declare function booleanFormatter<T = any>(cell: any, formatterParams?: BooleanFormatterParams<T>): string;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -17,7 +17,7 @@ export declare function booleanFormatter(cell: any, formatterParams?: BooleanFor
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
19
|
| cell | any | The cell component provided by Tabulator |
|
|
20
|
-
| formatterParams | BooleanFormatterParams | _(Optional)_ Boolean formatter parameters |
|
|
20
|
+
| formatterParams | BooleanFormatterParams<T> | _(Optional)_ Boolean formatter parameters |
|
|
21
21
|
|
|
22
22
|
**Returns:**
|
|
23
23
|
|
|
@@ -9,7 +9,7 @@ Formatter that displays an editable cell with validation state
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export declare function editableFormatter(cell: any, formatterParams?: EditableFormatterParams): string;
|
|
12
|
+
export declare function editableFormatter<T = any>(cell: any, formatterParams?: EditableFormatterParams<T>): string;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -17,7 +17,7 @@ export declare function editableFormatter(cell: any, formatterParams?: EditableF
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
19
|
| cell | any | The cell component provided by Tabulator |
|
|
20
|
-
| formatterParams | EditableFormatterParams | _(Optional)_ Editable formatter parameters |
|
|
20
|
+
| formatterParams | EditableFormatterParams<T> | _(Optional)_ Editable formatter parameters |
|
|
21
21
|
|
|
22
22
|
**Returns:**
|
|
23
23
|
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
| [getColumnType(metadataType)](./grid-tabulator.getcolumntype.md) | Get the column type based on the metadata type. |
|
|
35
35
|
| [getFilterByFieldType(type)](./grid-tabulator.getfilterbyfieldtype.md) | Get the filter type based on the field type. |
|
|
36
36
|
| [getFilterParamsByFieldType(type)](./grid-tabulator.getfilterparamsbyfieldtype.md) | Get the filter params based on the field type. |
|
|
37
|
-
| [selectFormatter(cell, formatterParams)](./grid-tabulator.selectformatter.md) | Formatter that displays a
|
|
37
|
+
| [selectFormatter(cell, formatterParams)](./grid-tabulator.selectformatter.md) | Formatter that displays a select component with options. Returns a wrapped div containing the select, similar to boolean.formatter. |
|
|
38
38
|
| [textFormatter(cell, formatterParams)](./grid-tabulator.textformatter.md) | Text formatter for customized display of values. Styled to match grid-pro text renderer. |
|
|
39
39
|
|
|
40
40
|
## Interfaces
|
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
## selectFormatter() function
|
|
6
6
|
|
|
7
|
-
Formatter that displays a
|
|
7
|
+
Formatter that displays a select component with options. Returns a wrapped div containing the select, similar to boolean.formatter.
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export declare function selectFormatter(cell: any, formatterParams: SelectFormatterParams): string;
|
|
12
|
+
export declare function selectFormatter<T = any>(cell: any, formatterParams: SelectFormatterParams<T>): string;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -17,11 +17,11 @@ export declare function selectFormatter(cell: any, formatterParams: SelectFormat
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
19
|
| cell | any | The cell component provided by Tabulator |
|
|
20
|
-
| formatterParams | SelectFormatterParams | Select formatter parameters |
|
|
20
|
+
| formatterParams | SelectFormatterParams<T> | Select formatter parameters |
|
|
21
21
|
|
|
22
22
|
**Returns:**
|
|
23
23
|
|
|
24
24
|
string
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
An empty string, as the component is added directly to the cell element
|
|
27
27
|
|
|
@@ -9,7 +9,7 @@ Text formatter for customized display of values. Styled to match grid-pro text r
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export declare function textFormatter(cell: any, formatterParams?: TextFormatterParams): string;
|
|
12
|
+
export declare function textFormatter<T = any>(cell: any, formatterParams?: TextFormatterParams<T>): string;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -17,7 +17,7 @@ export declare function textFormatter(cell: any, formatterParams?: TextFormatter
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
19
|
| cell | any | The cell component provided by Tabulator |
|
|
20
|
-
| formatterParams | TextFormatterParams | _(Optional)_ Text formatter parameters |
|
|
20
|
+
| formatterParams | TextFormatterParams<T> | _(Optional)_ Text formatter parameters |
|
|
21
21
|
|
|
22
22
|
**Returns:**
|
|
23
23
|
|
package/docs/api-report.md
CHANGED
|
@@ -34,14 +34,14 @@ import { ViewTemplate } from '@microsoft/fast-element';
|
|
|
34
34
|
// Warning: (ae-incompatible-release-tags) The symbol "actionFormatter" is marked as @public, but its signature references "ActionFormatterParams" which is marked as @alpha
|
|
35
35
|
//
|
|
36
36
|
// @public
|
|
37
|
-
export function actionFormatter(cell: any, formatterParams?: ActionFormatterParams): string;
|
|
37
|
+
export function actionFormatter<T = any>(cell: any, formatterParams?: ActionFormatterParams<T>): string;
|
|
38
38
|
|
|
39
39
|
// @alpha
|
|
40
|
-
export interface ActionFormatterParams {
|
|
40
|
+
export interface ActionFormatterParams<T = any> {
|
|
41
41
|
// (undocumented)
|
|
42
42
|
actionButtonStyle?: string;
|
|
43
43
|
// (undocumented)
|
|
44
|
-
actionClick?: (rowData:
|
|
44
|
+
actionClick?: (rowData: T) => void;
|
|
45
45
|
// (undocumented)
|
|
46
46
|
actionName?: string;
|
|
47
47
|
// (undocumented)
|
|
@@ -49,9 +49,9 @@ export interface ActionFormatterParams {
|
|
|
49
49
|
// (undocumented)
|
|
50
50
|
contentTemplate?: string;
|
|
51
51
|
// (undocumented)
|
|
52
|
-
dataTestId?: string;
|
|
52
|
+
dataTestId?: ((rowData: T) => string) | string;
|
|
53
53
|
// (undocumented)
|
|
54
|
-
isDisabled?: (rowData:
|
|
54
|
+
isDisabled?: (rowData: T) => boolean;
|
|
55
55
|
// (undocumented)
|
|
56
56
|
prefix?: string;
|
|
57
57
|
// (undocumented)
|
|
@@ -61,19 +61,21 @@ export interface ActionFormatterParams {
|
|
|
61
61
|
// Warning: (ae-incompatible-release-tags) The symbol "actionsMenuFormatter" is marked as @public, but its signature references "ActionsMenuFormatterParams" which is marked as @alpha
|
|
62
62
|
//
|
|
63
63
|
// @public
|
|
64
|
-
export function actionsMenuFormatter(cell: any, formatterParams?: ActionsMenuFormatterParams): string;
|
|
64
|
+
export function actionsMenuFormatter<T = any>(cell: any, formatterParams?: ActionsMenuFormatterParams<T>): string;
|
|
65
65
|
|
|
66
66
|
// @alpha
|
|
67
|
-
export interface ActionsMenuFormatterParams {
|
|
67
|
+
export interface ActionsMenuFormatterParams<T = any> {
|
|
68
68
|
// (undocumented)
|
|
69
69
|
actions?: Array<{
|
|
70
70
|
name: string;
|
|
71
|
-
callback: (rowData:
|
|
72
|
-
isDisabled?: (rowData:
|
|
71
|
+
callback: (rowData: T) => void;
|
|
72
|
+
isDisabled?: (rowData: T) => boolean;
|
|
73
73
|
}>;
|
|
74
74
|
// (undocumented)
|
|
75
75
|
buttonAppearance?: string;
|
|
76
76
|
// (undocumented)
|
|
77
|
+
dataTestId?: ((rowData: T) => string) | string;
|
|
78
|
+
// (undocumented)
|
|
77
79
|
isVertical?: boolean;
|
|
78
80
|
// (undocumented)
|
|
79
81
|
menuName?: string;
|
|
@@ -84,14 +86,14 @@ export interface ActionsMenuFormatterParams {
|
|
|
84
86
|
// Warning: (ae-incompatible-release-tags) The symbol "booleanFormatter" is marked as @public, but its signature references "BooleanFormatterParams" which is marked as @alpha
|
|
85
87
|
//
|
|
86
88
|
// @public
|
|
87
|
-
export function booleanFormatter(cell: any, formatterParams?: BooleanFormatterParams): string;
|
|
89
|
+
export function booleanFormatter<T = any>(cell: any, formatterParams?: BooleanFormatterParams<T>): string;
|
|
88
90
|
|
|
89
91
|
// @alpha
|
|
90
|
-
export interface BooleanFormatterParams {
|
|
92
|
+
export interface BooleanFormatterParams<T = any> {
|
|
91
93
|
// (undocumented)
|
|
92
|
-
dataTestId?: string;
|
|
94
|
+
dataTestId?: ((rowData: T) => string) | string;
|
|
93
95
|
// (undocumented)
|
|
94
|
-
isDisabled?: (rowData:
|
|
96
|
+
isDisabled?: (rowData: T) => boolean;
|
|
95
97
|
// (undocumented)
|
|
96
98
|
prefix?: string;
|
|
97
99
|
}
|
|
@@ -142,16 +144,16 @@ export const defaultGridTabulatorConfig: {
|
|
|
142
144
|
// Warning: (ae-incompatible-release-tags) The symbol "editableFormatter" is marked as @public, but its signature references "EditableFormatterParams" which is marked as @alpha
|
|
143
145
|
//
|
|
144
146
|
// @public
|
|
145
|
-
export function editableFormatter(cell: any, formatterParams?: EditableFormatterParams): string;
|
|
147
|
+
export function editableFormatter<T = any>(cell: any, formatterParams?: EditableFormatterParams<T>): string;
|
|
146
148
|
|
|
147
149
|
// @alpha
|
|
148
|
-
export interface EditableFormatterParams {
|
|
150
|
+
export interface EditableFormatterParams<T = any> {
|
|
149
151
|
// (undocumented)
|
|
150
152
|
cssClass?: string;
|
|
151
153
|
// (undocumented)
|
|
152
|
-
data?:
|
|
154
|
+
data?: T;
|
|
153
155
|
// (undocumented)
|
|
154
|
-
dataTestId?: string;
|
|
156
|
+
dataTestId?: ((rowData: T) => string) | string;
|
|
155
157
|
// (undocumented)
|
|
156
158
|
field?: string;
|
|
157
159
|
// (undocumented)
|
|
@@ -283,6 +285,9 @@ export const foundationGridTabulatorComponents: {
|
|
|
283
285
|
// @public
|
|
284
286
|
export function getColumnType(metadataType: string): string;
|
|
285
287
|
|
|
288
|
+
// @alpha
|
|
289
|
+
export function getDataTestId<T = any>(dataTestId: ((rowData: T) => string) | string | undefined, rowData: T): string | undefined;
|
|
290
|
+
|
|
286
291
|
// @public
|
|
287
292
|
export function getFilterByFieldType(type: string): string;
|
|
288
293
|
|
|
@@ -534,6 +539,7 @@ export function mergeAndDedupColDefWithColumnState(colDefs: any[], columnState:
|
|
|
534
539
|
// @alpha
|
|
535
540
|
export type Options = {
|
|
536
541
|
formatters?: Record<string, Formatter>;
|
|
542
|
+
columns?: ColumnDefinition[];
|
|
537
543
|
} & Omit<Options_2, 'formatters'>;
|
|
538
544
|
|
|
539
545
|
// @public
|
|
@@ -547,18 +553,20 @@ export interface RowDataTransaction<TData = any> {
|
|
|
547
553
|
// Warning: (ae-incompatible-release-tags) The symbol "selectFormatter" is marked as @public, but its signature references "SelectFormatterParams" which is marked as @alpha
|
|
548
554
|
//
|
|
549
555
|
// @public
|
|
550
|
-
export function selectFormatter(cell: any, formatterParams: SelectFormatterParams): string;
|
|
556
|
+
export function selectFormatter<T = any>(cell: any, formatterParams: SelectFormatterParams<T>): string;
|
|
551
557
|
|
|
552
558
|
// @alpha
|
|
553
|
-
export interface SelectFormatterParams {
|
|
559
|
+
export interface SelectFormatterParams<T = any> {
|
|
554
560
|
// (undocumented)
|
|
555
|
-
dataTestId?: string;
|
|
561
|
+
dataTestId?: ((rowData: T) => string) | string;
|
|
556
562
|
// (undocumented)
|
|
557
563
|
nullText?: string;
|
|
564
|
+
// (undocumented)
|
|
565
|
+
onChange?: (value: string, rowData: T) => void;
|
|
558
566
|
// Warning: (ae-forgotten-export) The symbol "SelectOption" needs to be exported by the entry point index.d.ts
|
|
559
567
|
//
|
|
560
568
|
// (undocumented)
|
|
561
|
-
options: SelectOption[];
|
|
569
|
+
options: SelectOption<T>[];
|
|
562
570
|
// (undocumented)
|
|
563
571
|
prefix?: string;
|
|
564
572
|
}
|
|
@@ -572,12 +580,12 @@ export const tabulatorThemeSimpleCSS: ElementStyles;
|
|
|
572
580
|
// Warning: (ae-incompatible-release-tags) The symbol "textFormatter" is marked as @public, but its signature references "TextFormatterParams" which is marked as @alpha
|
|
573
581
|
//
|
|
574
582
|
// @public
|
|
575
|
-
export function textFormatter(cell: any, formatterParams?: TextFormatterParams): string;
|
|
583
|
+
export function textFormatter<T = any>(cell: any, formatterParams?: TextFormatterParams<T>): string;
|
|
576
584
|
|
|
577
585
|
// @alpha
|
|
578
|
-
export interface TextFormatterParams {
|
|
586
|
+
export interface TextFormatterParams<T = any> {
|
|
579
587
|
// (undocumented)
|
|
580
|
-
dataTestId?: string;
|
|
588
|
+
dataTestId?: ((rowData: T) => string) | string;
|
|
581
589
|
// (undocumented)
|
|
582
590
|
nullText?: string;
|
|
583
591
|
// (undocumented)
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/grid-tabulator",
|
|
3
3
|
"description": "Genesis Foundation Grid Tabulator",
|
|
4
|
-
"version": "14.
|
|
4
|
+
"version": "14.282.0",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -39,21 +39,21 @@
|
|
|
39
39
|
}
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
|
-
"@genesislcap/foundation-testing": "14.
|
|
43
|
-
"@genesislcap/genx": "14.
|
|
44
|
-
"@genesislcap/rollup-builder": "14.
|
|
45
|
-
"@genesislcap/ts-builder": "14.
|
|
46
|
-
"@genesislcap/uvu-playwright-builder": "14.
|
|
47
|
-
"@genesislcap/vite-builder": "14.
|
|
48
|
-
"@genesislcap/webpack-builder": "14.
|
|
42
|
+
"@genesislcap/foundation-testing": "14.282.0",
|
|
43
|
+
"@genesislcap/genx": "14.282.0",
|
|
44
|
+
"@genesislcap/rollup-builder": "14.282.0",
|
|
45
|
+
"@genesislcap/ts-builder": "14.282.0",
|
|
46
|
+
"@genesislcap/uvu-playwright-builder": "14.282.0",
|
|
47
|
+
"@genesislcap/vite-builder": "14.282.0",
|
|
48
|
+
"@genesislcap/webpack-builder": "14.282.0",
|
|
49
49
|
"@types/tabulator-tables": "6.2.6",
|
|
50
50
|
"rimraf": "^5.0.0"
|
|
51
51
|
},
|
|
52
52
|
"dependencies": {
|
|
53
|
-
"@genesislcap/foundation-comms": "14.
|
|
54
|
-
"@genesislcap/foundation-logger": "14.
|
|
55
|
-
"@genesislcap/foundation-ui": "14.
|
|
56
|
-
"@genesislcap/foundation-utils": "14.
|
|
53
|
+
"@genesislcap/foundation-comms": "14.282.0",
|
|
54
|
+
"@genesislcap/foundation-logger": "14.282.0",
|
|
55
|
+
"@genesislcap/foundation-ui": "14.282.0",
|
|
56
|
+
"@genesislcap/foundation-utils": "14.282.0",
|
|
57
57
|
"@microsoft/fast-colors": "5.3.1",
|
|
58
58
|
"@microsoft/fast-components": "2.30.6",
|
|
59
59
|
"@microsoft/fast-element": "1.14.0",
|
|
@@ -75,5 +75,5 @@
|
|
|
75
75
|
"access": "public"
|
|
76
76
|
},
|
|
77
77
|
"customElements": "dist/custom-elements.json",
|
|
78
|
-
"gitHead": "
|
|
78
|
+
"gitHead": "284663a061f527c6f175e530c3c389bacc346bc9"
|
|
79
79
|
}
|