@redsift/ds-mcp-server 12.5.4-muiv8-alpha.1 → 12.5.4
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/data/docs/components/products/SignalCardAmp.json +8 -0
- package/data/docs/components/products/SignalCardBimi.json +8 -0
- package/data/docs/components/products/SignalCardDkim.json +8 -0
- package/data/docs/components/products/SignalCardDkimDomainAnalyzer.json +8 -0
- package/data/docs/components/products/SignalCardDmarc.json +8 -0
- package/data/docs/components/products/SignalCardDmarcDomain.json +8 -0
- package/data/docs/components/products/SignalCardDnssec.json +8 -0
- package/data/docs/components/products/SignalCardFcrdns.json +8 -0
- package/data/docs/components/products/SignalCardGoogleYahooCompliance.json +8 -0
- package/data/docs/components/products/SignalCardList.json +10 -2
- package/data/docs/components/products/SignalCardMtaSts.json +8 -0
- package/data/docs/components/products/SignalCardSpf.json +8 -0
- package/data/docs/components/products/SignalCardSpfDomain.json +8 -0
- package/data/docs/components/products/SignalCardSpfDomainAnalyzer.json +8 -0
- package/data/docs/components/products/SignalCardSubdo.json +8 -0
- package/data/docs/components/products/SignalCardThreatInv.json +8 -0
- package/data/docs/components/products/SignalCardTls.json +8 -0
- package/data/docs/components/products/SignalCardUrls.json +8 -0
- package/data/docs/components/table-pro/ControlledPagination.json +9 -0
- package/data/docs/components/table-pro/DataGrid.json +101 -0
- package/data/docs/components/table-pro/GridToolbarFilterSemanticField.json +69 -0
- package/data/docs/components/table-pro/ServerSideControlledPagination.json +9 -0
- package/data/docs/components/table-pro/StatefulDataGrid.json +122 -0
- package/data/docs/components/table-pro/TextCell.json +118 -0
- package/data/docs/components/table-pro/Toolbar.json +151 -0
- package/data/docs/components/table-pro/ToolbarWrapper.json +9 -0
- package/data/docs/components-index.json +87 -18
- package/data/docs/components.json +937 -220
- package/data/docs/llms-full.txt +174 -4
- package/data/docs/llms.txt +31 -19
- package/data/metadata.json +2 -2
- package/package.json +2 -2
|
@@ -39,6 +39,14 @@
|
|
|
39
39
|
"defaultValue": null,
|
|
40
40
|
"category": "props"
|
|
41
41
|
},
|
|
42
|
+
{
|
|
43
|
+
"name": "onPromoClick",
|
|
44
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
45
|
+
"type": "() => void",
|
|
46
|
+
"required": false,
|
|
47
|
+
"defaultValue": null,
|
|
48
|
+
"category": "props"
|
|
49
|
+
},
|
|
42
50
|
{
|
|
43
51
|
"name": "renderFooter",
|
|
44
52
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -47,6 +47,14 @@
|
|
|
47
47
|
"defaultValue": null,
|
|
48
48
|
"category": "props"
|
|
49
49
|
},
|
|
50
|
+
{
|
|
51
|
+
"name": "onPromoClick",
|
|
52
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
53
|
+
"type": "() => void",
|
|
54
|
+
"required": false,
|
|
55
|
+
"defaultValue": null,
|
|
56
|
+
"category": "props"
|
|
57
|
+
},
|
|
50
58
|
{
|
|
51
59
|
"name": "renderFooter",
|
|
52
60
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -39,6 +39,14 @@
|
|
|
39
39
|
"defaultValue": null,
|
|
40
40
|
"category": "props"
|
|
41
41
|
},
|
|
42
|
+
{
|
|
43
|
+
"name": "onPromoClick",
|
|
44
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
45
|
+
"type": "() => void",
|
|
46
|
+
"required": false,
|
|
47
|
+
"defaultValue": null,
|
|
48
|
+
"category": "props"
|
|
49
|
+
},
|
|
42
50
|
{
|
|
43
51
|
"name": "renderFooter",
|
|
44
52
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -39,6 +39,14 @@
|
|
|
39
39
|
"defaultValue": null,
|
|
40
40
|
"category": "props"
|
|
41
41
|
},
|
|
42
|
+
{
|
|
43
|
+
"name": "onPromoClick",
|
|
44
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
45
|
+
"type": "() => void",
|
|
46
|
+
"required": false,
|
|
47
|
+
"defaultValue": null,
|
|
48
|
+
"category": "props"
|
|
49
|
+
},
|
|
42
50
|
{
|
|
43
51
|
"name": "renderFooter",
|
|
44
52
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -50,6 +50,14 @@
|
|
|
50
50
|
"defaultValue": null,
|
|
51
51
|
"category": "props"
|
|
52
52
|
},
|
|
53
|
+
{
|
|
54
|
+
"name": "onPromoClick",
|
|
55
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
56
|
+
"type": "() => void",
|
|
57
|
+
"required": false,
|
|
58
|
+
"defaultValue": null,
|
|
59
|
+
"category": "props"
|
|
60
|
+
},
|
|
53
61
|
{
|
|
54
62
|
"name": "renderFooter",
|
|
55
63
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -39,6 +39,14 @@
|
|
|
39
39
|
"defaultValue": null,
|
|
40
40
|
"category": "props"
|
|
41
41
|
},
|
|
42
|
+
{
|
|
43
|
+
"name": "onPromoClick",
|
|
44
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
45
|
+
"type": "() => void",
|
|
46
|
+
"required": false,
|
|
47
|
+
"defaultValue": null,
|
|
48
|
+
"category": "props"
|
|
49
|
+
},
|
|
42
50
|
{
|
|
43
51
|
"name": "renderFooter",
|
|
44
52
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -50,6 +50,14 @@
|
|
|
50
50
|
"defaultValue": null,
|
|
51
51
|
"category": "props"
|
|
52
52
|
},
|
|
53
|
+
{
|
|
54
|
+
"name": "onPromoClick",
|
|
55
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
56
|
+
"type": "() => void",
|
|
57
|
+
"required": false,
|
|
58
|
+
"defaultValue": null,
|
|
59
|
+
"category": "props"
|
|
60
|
+
},
|
|
53
61
|
{
|
|
54
62
|
"name": "renderFooter",
|
|
55
63
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -47,6 +47,14 @@
|
|
|
47
47
|
"defaultValue": null,
|
|
48
48
|
"category": "props"
|
|
49
49
|
},
|
|
50
|
+
{
|
|
51
|
+
"name": "onPromoClick",
|
|
52
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
53
|
+
"type": "() => void",
|
|
54
|
+
"required": false,
|
|
55
|
+
"defaultValue": null,
|
|
56
|
+
"category": "props"
|
|
57
|
+
},
|
|
50
58
|
{
|
|
51
59
|
"name": "renderFooter",
|
|
52
60
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -64,6 +64,14 @@
|
|
|
64
64
|
"defaultValue": null,
|
|
65
65
|
"category": "props"
|
|
66
66
|
},
|
|
67
|
+
{
|
|
68
|
+
"name": "onPromoClick",
|
|
69
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
70
|
+
"type": "() => void",
|
|
71
|
+
"required": false,
|
|
72
|
+
"defaultValue": null,
|
|
73
|
+
"category": "props"
|
|
74
|
+
},
|
|
67
75
|
{
|
|
68
76
|
"name": "renderFooter",
|
|
69
77
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"description": "Map of signal types to enabled/disabled state",
|
|
29
29
|
"type": "CardEnabledOverrides",
|
|
30
30
|
"required": false,
|
|
31
|
-
"defaultValue": "{\n amp: true,\n bimi: true,\n dkim: true,\n dmarc: true,\n dnssec: true,\n
|
|
31
|
+
"defaultValue": "{\n amp: true,\n bimi: true,\n dkim: true,\n dmarc: true,\n dnssec: true,\n fcrdns: true,\n mtaSts: true,\n spf: true,\n subdo: true,\n threatIntelligence: true,\n tls: true,\n urls: true,\n googleYahooCompliance: true,\n}",
|
|
32
32
|
"category": "props"
|
|
33
33
|
},
|
|
34
34
|
{
|
|
@@ -68,12 +68,20 @@
|
|
|
68
68
|
},
|
|
69
69
|
{
|
|
70
70
|
"name": "cardPromoHref",
|
|
71
|
-
"description": "Override the promo banner button href on all cards (e.g. to add UTM parameters).
|
|
71
|
+
"description": "Override the promo banner button href on all cards and the email provider banner CTA link (e.g. to add UTM parameters). For per-card promo banners, only used when renderCardHeader is not provided. Defaults to the OnDMARC signup URL (`https://iam.redsift.cloud/signup?redirectapp=cloud&product=ondmarc`).",
|
|
72
72
|
"type": "string",
|
|
73
73
|
"required": false,
|
|
74
74
|
"defaultValue": null,
|
|
75
75
|
"category": "props"
|
|
76
76
|
},
|
|
77
|
+
{
|
|
78
|
+
"name": "onCardPromoClick",
|
|
79
|
+
"description": "Optional callback fired when the user clicks any CTA link that navigates\nto the promo/signup href. This includes:\n- The \"Protect your domain\" promo banner inside each card (shown when\n `renderCardHeader` is not provided; uses `cardPromoHref` or the default\n OnDMARC signup URL)\n- The \"Set up monitoring\" link in the email provider banner (only rendered\n when `cardPromoHref` is set)\n\nFires alongside the normal navigation (does not prevent default).",
|
|
80
|
+
"type": "() => void",
|
|
81
|
+
"required": false,
|
|
82
|
+
"defaultValue": null,
|
|
83
|
+
"category": "props"
|
|
84
|
+
},
|
|
77
85
|
{
|
|
78
86
|
"name": "renderCardFooter",
|
|
79
87
|
"description": "Custom footer renderer for adding content at the bottom of each card",
|
|
@@ -50,6 +50,14 @@
|
|
|
50
50
|
"defaultValue": null,
|
|
51
51
|
"category": "props"
|
|
52
52
|
},
|
|
53
|
+
{
|
|
54
|
+
"name": "onPromoClick",
|
|
55
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
56
|
+
"type": "() => void",
|
|
57
|
+
"required": false,
|
|
58
|
+
"defaultValue": null,
|
|
59
|
+
"category": "props"
|
|
60
|
+
},
|
|
53
61
|
{
|
|
54
62
|
"name": "renderFooter",
|
|
55
63
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -39,6 +39,14 @@
|
|
|
39
39
|
"defaultValue": null,
|
|
40
40
|
"category": "props"
|
|
41
41
|
},
|
|
42
|
+
{
|
|
43
|
+
"name": "onPromoClick",
|
|
44
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
45
|
+
"type": "() => void",
|
|
46
|
+
"required": false,
|
|
47
|
+
"defaultValue": null,
|
|
48
|
+
"category": "props"
|
|
49
|
+
},
|
|
42
50
|
{
|
|
43
51
|
"name": "renderFooter",
|
|
44
52
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -42,6 +42,14 @@
|
|
|
42
42
|
"defaultValue": null,
|
|
43
43
|
"category": "props"
|
|
44
44
|
},
|
|
45
|
+
{
|
|
46
|
+
"name": "onPromoClick",
|
|
47
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
48
|
+
"type": "() => void",
|
|
49
|
+
"required": false,
|
|
50
|
+
"defaultValue": null,
|
|
51
|
+
"category": "props"
|
|
52
|
+
},
|
|
45
53
|
{
|
|
46
54
|
"name": "renderFooter",
|
|
47
55
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -39,6 +39,14 @@
|
|
|
39
39
|
"defaultValue": null,
|
|
40
40
|
"category": "props"
|
|
41
41
|
},
|
|
42
|
+
{
|
|
43
|
+
"name": "onPromoClick",
|
|
44
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
45
|
+
"type": "() => void",
|
|
46
|
+
"required": false,
|
|
47
|
+
"defaultValue": null,
|
|
48
|
+
"category": "props"
|
|
49
|
+
},
|
|
42
50
|
{
|
|
43
51
|
"name": "renderFooter",
|
|
44
52
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -42,6 +42,14 @@
|
|
|
42
42
|
"defaultValue": null,
|
|
43
43
|
"category": "props"
|
|
44
44
|
},
|
|
45
|
+
{
|
|
46
|
+
"name": "onPromoClick",
|
|
47
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
48
|
+
"type": "() => void",
|
|
49
|
+
"required": false,
|
|
50
|
+
"defaultValue": null,
|
|
51
|
+
"category": "props"
|
|
52
|
+
},
|
|
45
53
|
{
|
|
46
54
|
"name": "renderFooter",
|
|
47
55
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -50,6 +50,14 @@
|
|
|
50
50
|
"defaultValue": null,
|
|
51
51
|
"category": "props"
|
|
52
52
|
},
|
|
53
|
+
{
|
|
54
|
+
"name": "onPromoClick",
|
|
55
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
56
|
+
"type": "() => void",
|
|
57
|
+
"required": false,
|
|
58
|
+
"defaultValue": null,
|
|
59
|
+
"category": "props"
|
|
60
|
+
},
|
|
53
61
|
{
|
|
54
62
|
"name": "renderFooter",
|
|
55
63
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -39,6 +39,14 @@
|
|
|
39
39
|
"defaultValue": null,
|
|
40
40
|
"category": "props"
|
|
41
41
|
},
|
|
42
|
+
{
|
|
43
|
+
"name": "onPromoClick",
|
|
44
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
45
|
+
"type": "() => void",
|
|
46
|
+
"required": false,
|
|
47
|
+
"defaultValue": null,
|
|
48
|
+
"category": "props"
|
|
49
|
+
},
|
|
42
50
|
{
|
|
43
51
|
"name": "renderFooter",
|
|
44
52
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -42,6 +42,14 @@
|
|
|
42
42
|
"defaultValue": null,
|
|
43
43
|
"category": "props"
|
|
44
44
|
},
|
|
45
|
+
{
|
|
46
|
+
"name": "onPromoClick",
|
|
47
|
+
"description": "Optional callback fired when the user clicks the promo banner CTA. Fires alongside the normal navigation.",
|
|
48
|
+
"type": "() => void",
|
|
49
|
+
"required": false,
|
|
50
|
+
"defaultValue": null,
|
|
51
|
+
"category": "props"
|
|
52
|
+
},
|
|
45
53
|
{
|
|
46
54
|
"name": "renderFooter",
|
|
47
55
|
"description": "Custom footer renderer appended below the standard card content.",
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "DataGrid",
|
|
3
|
+
"description": "DataGrid displays tabular data with sorting, filtering, pagination, and row selection.\nBuilt on MUI X DataGrid Pro with Red Sift styling and theming.\n\nRequires MUI X Pro license key (set via `MUI_LICENSE_KEY` env variable).\n\nUse `createColumn()` to get pre-configured column definitions with typed filter operators.\nSupported types: `string`, `number`, `date`, `dateTime`, `singleSelect`, `multiSelect`, `tags`.\nFor `boolean` columns, use `type: 'boolean'` directly (no createColumn wrapper needed).",
|
|
4
|
+
"package": "@redsift/table-pro",
|
|
5
|
+
"filePath": "packages/table-pro/src/components/DataGrid/DataGrid.tsx",
|
|
6
|
+
"props": [
|
|
7
|
+
{
|
|
8
|
+
"name": "license",
|
|
9
|
+
"description": "License key for MUI Datagrid Pro.",
|
|
10
|
+
"type": "string",
|
|
11
|
+
"required": false,
|
|
12
|
+
"defaultValue": null,
|
|
13
|
+
"category": "props"
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"name": "height",
|
|
17
|
+
"description": "Height. A default one is set to prevent rendering all rows.",
|
|
18
|
+
"type": "string",
|
|
19
|
+
"required": false,
|
|
20
|
+
"defaultValue": "'500px'",
|
|
21
|
+
"category": "props"
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"name": "toolbar",
|
|
25
|
+
"description": "Toolbar. A default one is provided but every button from this default Toolbar can be customized and the entire Toolbar can be replaced.",
|
|
26
|
+
"type": "ReactNode",
|
|
27
|
+
"required": false,
|
|
28
|
+
"defaultValue": null,
|
|
29
|
+
"category": "props"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"name": "hideToolbar",
|
|
33
|
+
"description": "Whether the Toolbar is displayed or not.",
|
|
34
|
+
"type": [
|
|
35
|
+
"false",
|
|
36
|
+
"true"
|
|
37
|
+
],
|
|
38
|
+
"required": false,
|
|
39
|
+
"defaultValue": null,
|
|
40
|
+
"category": "props"
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"name": "paginationPlacement",
|
|
44
|
+
"description": "Indicates how to display pagination.",
|
|
45
|
+
"type": [
|
|
46
|
+
"\"top\"",
|
|
47
|
+
"\"bottom\"",
|
|
48
|
+
"\"both\"",
|
|
49
|
+
"\"none\""
|
|
50
|
+
],
|
|
51
|
+
"required": false,
|
|
52
|
+
"defaultValue": "'both'",
|
|
53
|
+
"category": "props"
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
"name": "paginationProps",
|
|
57
|
+
"description": "Props to forward to the pagination component.",
|
|
58
|
+
"type": "Omit<TablePaginationProps, \"paginationMode\" | \"component\" | \"count\" | \"onPageChange\" | \"onRowsPerPageChange\" | \"page\" | \"rowsPerPage\" | \"rowsPerPageOptions\">",
|
|
59
|
+
"required": false,
|
|
60
|
+
"defaultValue": null,
|
|
61
|
+
"category": "props"
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"name": "theme",
|
|
65
|
+
"description": "Theme.",
|
|
66
|
+
"type": [
|
|
67
|
+
"\"light\"",
|
|
68
|
+
"\"dark\""
|
|
69
|
+
],
|
|
70
|
+
"required": false,
|
|
71
|
+
"defaultValue": null,
|
|
72
|
+
"category": "props"
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"name": "getTreeDataPath",
|
|
76
|
+
"description": "Determines the path of a row in the tree data.\nFor instance, a row with the path [\"A\", \"B\"] is the child of the row with the path [\"A\"].\nNote that all paths must contain at least one element.\n@template R\n@param row The row from which we want the path.\n@returns The path to the row.",
|
|
77
|
+
"type": "(row: any) => readonly string[]",
|
|
78
|
+
"required": false,
|
|
79
|
+
"defaultValue": null,
|
|
80
|
+
"category": "props"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"name": "setTreeDataPath",
|
|
84
|
+
"description": "Updates the tree path in a row model.\nUsed when reordering rows across different parents in tree data.\n@template R\n@param path The new path for the row.\n@param row The row model to update.\n@returns The updated row model with the new path.",
|
|
85
|
+
"type": "(path: string[], row: any) => any",
|
|
86
|
+
"required": false,
|
|
87
|
+
"defaultValue": null,
|
|
88
|
+
"category": "props"
|
|
89
|
+
}
|
|
90
|
+
],
|
|
91
|
+
"examples": [],
|
|
92
|
+
"tags": {},
|
|
93
|
+
"keywords": [
|
|
94
|
+
"data grid",
|
|
95
|
+
"data table",
|
|
96
|
+
"table",
|
|
97
|
+
"grid view",
|
|
98
|
+
"list view",
|
|
99
|
+
"spreadsheet"
|
|
100
|
+
]
|
|
101
|
+
}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "GridToolbarFilterSemanticField",
|
|
3
|
+
"description": "The GridToolbarFilterSemanticField component.",
|
|
4
|
+
"package": "@redsift/table-pro",
|
|
5
|
+
"filePath": "packages/table-pro/src/components/GridToolbarFilterSemanticField/GridToolbarFilterSemanticField.tsx",
|
|
6
|
+
"props": [
|
|
7
|
+
{
|
|
8
|
+
"name": "nlpFilterConfig",
|
|
9
|
+
"description": "",
|
|
10
|
+
"type": "FilterConfig",
|
|
11
|
+
"required": true,
|
|
12
|
+
"defaultValue": null,
|
|
13
|
+
"category": "props"
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"name": "onFilterModelChange",
|
|
17
|
+
"description": "",
|
|
18
|
+
"type": "(filterModel: GridFilterModel) => void",
|
|
19
|
+
"required": false,
|
|
20
|
+
"defaultValue": null,
|
|
21
|
+
"category": "props"
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"name": "dateFormat",
|
|
25
|
+
"description": "",
|
|
26
|
+
"type": "string",
|
|
27
|
+
"required": false,
|
|
28
|
+
"defaultValue": null,
|
|
29
|
+
"category": "props"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"name": "defaultModel",
|
|
33
|
+
"description": "",
|
|
34
|
+
"type": "string",
|
|
35
|
+
"required": false,
|
|
36
|
+
"defaultValue": null,
|
|
37
|
+
"category": "props"
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"name": "defaultFilter",
|
|
41
|
+
"description": "",
|
|
42
|
+
"type": "CompletionResponse",
|
|
43
|
+
"required": false,
|
|
44
|
+
"defaultValue": null,
|
|
45
|
+
"category": "props"
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"name": "disablePower",
|
|
49
|
+
"description": "",
|
|
50
|
+
"type": [
|
|
51
|
+
"false",
|
|
52
|
+
"true"
|
|
53
|
+
],
|
|
54
|
+
"required": false,
|
|
55
|
+
"defaultValue": null,
|
|
56
|
+
"category": "props"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "localeText",
|
|
60
|
+
"description": "",
|
|
61
|
+
"type": "LocaleText",
|
|
62
|
+
"required": false,
|
|
63
|
+
"defaultValue": null,
|
|
64
|
+
"category": "props"
|
|
65
|
+
}
|
|
66
|
+
],
|
|
67
|
+
"examples": [],
|
|
68
|
+
"tags": {}
|
|
69
|
+
}
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "StatefulDataGrid",
|
|
3
|
+
"description": "StatefulDataGrid extends DataGrid with automatic state persistence to localStorage.\nPreserves filters, sorting, pagination, column visibility, and column widths\nacross page refreshes.\n\nUse when users need persistent table preferences. Requires unique `localStorageKey`.",
|
|
4
|
+
"package": "@redsift/table-pro",
|
|
5
|
+
"filePath": "packages/table-pro/src/components/StatefulDataGrid/StatefulDataGrid.tsx",
|
|
6
|
+
"props": [
|
|
7
|
+
{
|
|
8
|
+
"name": "useRouter",
|
|
9
|
+
"description": "Hook returning pathname, search params and a method to update query params.",
|
|
10
|
+
"type": "() => { pathname: string; search: string; historyReplace: (newSearch: string) => void; }",
|
|
11
|
+
"required": true,
|
|
12
|
+
"defaultValue": null,
|
|
13
|
+
"category": "props"
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"name": "localStorageVersion",
|
|
17
|
+
"description": "Local Storage version, to upgrade when we want to force a clean out.",
|
|
18
|
+
"type": "number",
|
|
19
|
+
"required": false,
|
|
20
|
+
"defaultValue": null,
|
|
21
|
+
"category": "props"
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"name": "previousLocalStorageVersions",
|
|
25
|
+
"description": "Previous Local Storage versions to clean out when a new one is released.",
|
|
26
|
+
"type": "number[]",
|
|
27
|
+
"required": false,
|
|
28
|
+
"defaultValue": null,
|
|
29
|
+
"category": "props"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"name": "license",
|
|
33
|
+
"description": "License key for MUI Datagrid Pro.",
|
|
34
|
+
"type": "string",
|
|
35
|
+
"required": false,
|
|
36
|
+
"defaultValue": null,
|
|
37
|
+
"category": "props"
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"name": "height",
|
|
41
|
+
"description": "Height. A default one is set to prevent rendering all rows.",
|
|
42
|
+
"type": "string",
|
|
43
|
+
"required": false,
|
|
44
|
+
"defaultValue": "'500px'",
|
|
45
|
+
"category": "props"
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"name": "toolbar",
|
|
49
|
+
"description": "Toolbar. A default one is provided but every button from this default Toolbar can be customized and the entire Toolbar can be replaced.",
|
|
50
|
+
"type": "ReactNode",
|
|
51
|
+
"required": false,
|
|
52
|
+
"defaultValue": null,
|
|
53
|
+
"category": "props"
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
"name": "hideToolbar",
|
|
57
|
+
"description": "Whether the Toolbar is displayed or not.",
|
|
58
|
+
"type": [
|
|
59
|
+
"false",
|
|
60
|
+
"true"
|
|
61
|
+
],
|
|
62
|
+
"required": false,
|
|
63
|
+
"defaultValue": null,
|
|
64
|
+
"category": "props"
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"name": "paginationPlacement",
|
|
68
|
+
"description": "Indicates how to display pagination.",
|
|
69
|
+
"type": [
|
|
70
|
+
"\"top\"",
|
|
71
|
+
"\"bottom\"",
|
|
72
|
+
"\"both\"",
|
|
73
|
+
"\"none\""
|
|
74
|
+
],
|
|
75
|
+
"required": false,
|
|
76
|
+
"defaultValue": "'both'",
|
|
77
|
+
"category": "props"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"name": "paginationProps",
|
|
81
|
+
"description": "Props to forward to the pagination component.",
|
|
82
|
+
"type": "Omit<TablePaginationProps, \"paginationMode\" | \"component\" | \"count\" | \"onPageChange\" | \"onRowsPerPageChange\" | \"page\" | \"rowsPerPage\" | \"rowsPerPageOptions\">",
|
|
83
|
+
"required": false,
|
|
84
|
+
"defaultValue": null,
|
|
85
|
+
"category": "props"
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"name": "theme",
|
|
89
|
+
"description": "Theme.",
|
|
90
|
+
"type": [
|
|
91
|
+
"\"light\"",
|
|
92
|
+
"\"dark\""
|
|
93
|
+
],
|
|
94
|
+
"required": false,
|
|
95
|
+
"defaultValue": null,
|
|
96
|
+
"category": "props"
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"name": "getTreeDataPath",
|
|
100
|
+
"description": "Determines the path of a row in the tree data.\nFor instance, a row with the path [\"A\", \"B\"] is the child of the row with the path [\"A\"].\nNote that all paths must contain at least one element.\n@template R\n@param row The row from which we want the path.\n@returns The path to the row.",
|
|
101
|
+
"type": "(row: any) => readonly string[]",
|
|
102
|
+
"required": false,
|
|
103
|
+
"defaultValue": null,
|
|
104
|
+
"category": "props"
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
"name": "setTreeDataPath",
|
|
108
|
+
"description": "Updates the tree path in a row model.\nUsed when reordering rows across different parents in tree data.\n@template R\n@param path The new path for the row.\n@param row The row model to update.\n@returns The updated row model with the new path.",
|
|
109
|
+
"type": "(path: string[], row: any) => any",
|
|
110
|
+
"required": false,
|
|
111
|
+
"defaultValue": null,
|
|
112
|
+
"category": "props"
|
|
113
|
+
}
|
|
114
|
+
],
|
|
115
|
+
"examples": [],
|
|
116
|
+
"tags": {},
|
|
117
|
+
"keywords": [
|
|
118
|
+
"stateful table",
|
|
119
|
+
"managed grid",
|
|
120
|
+
"server grid"
|
|
121
|
+
]
|
|
122
|
+
}
|