@redsift/ds-mcp-server 12.5.13-muiv6 → 12.5.13
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/demos/patterns/_shared/StateDebugPanel.tsx +2 -2
- package/data/demos/patterns/_shared/columns.tsx +12 -3
- package/data/demos/patterns/_shared/defaults.ts +1 -1
- package/data/demos/patterns/_shared/filter-helpers.ts +1 -1
- package/data/demos/patterns/_shared/helpers.tsx +1 -1
- package/data/demos/patterns/_shared/server-logic.ts +1 -1
- package/data/demos/patterns/_shared/story-helpers.ts +106 -22
- package/data/demos/patterns/crossfiltered-datagrid-client-side/CrossfilteredDatagridClientSide.interaction.stories.tsx +1 -18
- package/data/demos/patterns/crossfiltered-datagrid-server-side/CrossfilteredDatagridServerSide.interaction.stories.tsx +1 -1
- package/data/demos/patterns/crossfiltered-datagrid-server-side/example.tsx +10 -10
- package/data/demos/patterns/drilldowned-datagrid-client-side/example.tsx +1 -1
- package/data/demos/patterns/drilldowned-datagrid-server-side/example.tsx +1 -1
- package/data/demos/patterns/single-datagrid-client-side/SingleDatagridClientSide.interaction.stories.tsx +1 -1
- package/data/demos/patterns/single-datagrid-client-side/example.tsx +4 -4
- package/data/demos/patterns/single-datagrid-server-side/SingleDatagridServerSide.interaction.stories.tsx +1 -1
- package/data/demos/patterns/single-datagrid-server-side/example.tsx +4 -4
- package/data/demos/patterns/stateful-single-datagrid-client-side/StatefulSingleDatagridClientSide.interaction.stories.tsx +129 -1
- package/data/demos/patterns/stateful-single-datagrid-client-side/example.tsx +6 -5
- package/data/demos/patterns/stateful-single-datagrid-server-side/StatefulSingleDatagridServerSide.interaction.stories.tsx +134 -1
- package/data/demos/patterns/stateful-single-datagrid-server-side/example.tsx +6 -5
- package/data/demos/patterns/tabbed-datagrid-server-side/example.tsx +1 -1
- package/data/docs/components/dashboard/Dashboard.json +2 -2
- package/data/docs/components/products/DmarcSummaryBoxes.json +1 -1
- package/data/docs/components/table/DataGrid.json +6 -6
- package/data/docs/components/table/GridToolbarFilterSemanticField.json +1 -1
- package/data/docs/components/table/StatefulDataGrid.json +6 -6
- package/data/docs/components/table/Toolbar.json +8 -2
- package/data/docs/components/table-pro/ControlledPagination.json +9 -0
- package/data/docs/components/table-pro/DataGrid.json +114 -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 +135 -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 +69 -0
- package/data/docs/components.json +626 -21
- package/data/docs/llms-full.txt +209 -45
- package/data/docs/llms.txt +17 -5
- package/data/docs/patterns-catalog.md +24 -25
- package/data/docs/patterns.json +4 -4
- package/data/metadata.json +2 -2
- package/data/patterns/crossfiltered-datagrid-server-side.mdx +1 -1
- package/data/patterns/drilldowned-datagrid-client-side.mdx +1 -1
- package/data/patterns/drilldowned-datagrid-server-side.mdx +1 -1
- package/data/patterns/single-datagrid-client-side.mdx +7 -7
- package/data/patterns/single-datagrid-server-side.mdx +4 -4
- package/data/patterns/stateful-single-datagrid-client-side.mdx +36 -21
- package/data/patterns/stateful-single-datagrid-server-side.mdx +46 -18
- package/data/patterns/tabbed-datagrid-server-side.mdx +1 -1
- package/package.json +2 -2
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"name": "Red Sift Design System",
|
|
4
|
-
"version": "12.5.12
|
|
5
|
-
"generated": "2026-09-08T08:
|
|
4
|
+
"version": "12.5.12",
|
|
5
|
+
"generated": "2026-09-08T08:02:04.673Z",
|
|
6
6
|
"repository": "https://github.com/redsift/design-system",
|
|
7
7
|
"documentation": "https://design-system.redsift.io",
|
|
8
8
|
"packages": [
|
|
@@ -41642,17 +41642,17 @@
|
|
|
41642
41642
|
"category": "props"
|
|
41643
41643
|
},
|
|
41644
41644
|
{
|
|
41645
|
-
"name": "
|
|
41646
|
-
"description": "",
|
|
41647
|
-
"type": "string",
|
|
41645
|
+
"name": "getTreeDataPath",
|
|
41646
|
+
"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.",
|
|
41647
|
+
"type": "(row: any) => readonly string[]",
|
|
41648
41648
|
"required": false,
|
|
41649
41649
|
"defaultValue": null,
|
|
41650
41650
|
"category": "props"
|
|
41651
41651
|
},
|
|
41652
41652
|
{
|
|
41653
|
-
"name": "
|
|
41654
|
-
"description": "",
|
|
41655
|
-
"type": "
|
|
41653
|
+
"name": "setTreeDataPath",
|
|
41654
|
+
"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.",
|
|
41655
|
+
"type": "(path: string[], row: any) => any",
|
|
41656
41656
|
"required": false,
|
|
41657
41657
|
"defaultValue": null,
|
|
41658
41658
|
"category": "props"
|
|
@@ -41678,7 +41678,7 @@
|
|
|
41678
41678
|
"name": "onFilterModelChange",
|
|
41679
41679
|
"description": "",
|
|
41680
41680
|
"type": "(filterModel: GridFilterModel) => void",
|
|
41681
|
-
"required":
|
|
41681
|
+
"required": false,
|
|
41682
41682
|
"defaultValue": null,
|
|
41683
41683
|
"category": "props"
|
|
41684
41684
|
},
|
|
@@ -41847,17 +41847,17 @@
|
|
|
41847
41847
|
"category": "props"
|
|
41848
41848
|
},
|
|
41849
41849
|
{
|
|
41850
|
-
"name": "
|
|
41851
|
-
"description": "",
|
|
41852
|
-
"type": "string",
|
|
41850
|
+
"name": "getTreeDataPath",
|
|
41851
|
+
"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.",
|
|
41852
|
+
"type": "(row: any) => readonly string[]",
|
|
41853
41853
|
"required": false,
|
|
41854
41854
|
"defaultValue": null,
|
|
41855
41855
|
"category": "props"
|
|
41856
41856
|
},
|
|
41857
41857
|
{
|
|
41858
|
-
"name": "
|
|
41859
|
-
"description": "",
|
|
41860
|
-
"type": "
|
|
41858
|
+
"name": "setTreeDataPath",
|
|
41859
|
+
"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.",
|
|
41860
|
+
"type": "(path: string[], row: any) => any",
|
|
41861
41861
|
"required": false,
|
|
41862
41862
|
"defaultValue": null,
|
|
41863
41863
|
"category": "props"
|
|
@@ -41991,7 +41991,10 @@
|
|
|
41991
41991
|
{
|
|
41992
41992
|
"name": "columnsButtonProps",
|
|
41993
41993
|
"description": "Props to forward to the column button.",
|
|
41994
|
-
"type":
|
|
41994
|
+
"type": [
|
|
41995
|
+
"GridToolbarColumnsButtonProps",
|
|
41996
|
+
"GridToolbarColumnsButtonProps & RefAttributes<HTMLButtonElement>"
|
|
41997
|
+
],
|
|
41995
41998
|
"required": false,
|
|
41996
41999
|
"defaultValue": null,
|
|
41997
42000
|
"category": "props"
|
|
@@ -42007,7 +42010,10 @@
|
|
|
42007
42010
|
{
|
|
42008
42011
|
"name": "densityButtonProps",
|
|
42009
42012
|
"description": "Props to forward to the density button.",
|
|
42010
|
-
"type":
|
|
42013
|
+
"type": [
|
|
42014
|
+
"GridToolbarDensitySelectorProps",
|
|
42015
|
+
"GridToolbarDensitySelectorProps & RefAttributes<HTMLButtonElement>"
|
|
42016
|
+
],
|
|
42011
42017
|
"required": false,
|
|
42012
42018
|
"defaultValue": null,
|
|
42013
42019
|
"category": "props"
|
|
@@ -42137,6 +42143,604 @@
|
|
|
42137
42143
|
}
|
|
42138
42144
|
]
|
|
42139
42145
|
},
|
|
42146
|
+
{
|
|
42147
|
+
"name": "@redsift/table-pro",
|
|
42148
|
+
"components": [
|
|
42149
|
+
{
|
|
42150
|
+
"name": "ControlledPagination",
|
|
42151
|
+
"description": "",
|
|
42152
|
+
"filePath": "packages/table-pro/src/components/Pagination/ControlledPagination.tsx",
|
|
42153
|
+
"props": [],
|
|
42154
|
+
"examples": [],
|
|
42155
|
+
"tags": {}
|
|
42156
|
+
},
|
|
42157
|
+
{
|
|
42158
|
+
"name": "DataGrid",
|
|
42159
|
+
"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).",
|
|
42160
|
+
"filePath": "packages/table-pro/src/components/DataGrid/DataGrid.tsx",
|
|
42161
|
+
"props": [
|
|
42162
|
+
{
|
|
42163
|
+
"name": "license",
|
|
42164
|
+
"description": "License key for MUI Datagrid Pro.",
|
|
42165
|
+
"type": "string",
|
|
42166
|
+
"required": false,
|
|
42167
|
+
"defaultValue": null,
|
|
42168
|
+
"category": "props"
|
|
42169
|
+
},
|
|
42170
|
+
{
|
|
42171
|
+
"name": "height",
|
|
42172
|
+
"description": "Height. A default one is set to prevent rendering all rows.",
|
|
42173
|
+
"type": "string",
|
|
42174
|
+
"required": false,
|
|
42175
|
+
"defaultValue": "'500px'",
|
|
42176
|
+
"category": "props"
|
|
42177
|
+
},
|
|
42178
|
+
{
|
|
42179
|
+
"name": "toolbar",
|
|
42180
|
+
"description": "Toolbar. A default one is provided but every button from this default Toolbar can be customized and the entire Toolbar can be replaced.",
|
|
42181
|
+
"type": "ReactNode",
|
|
42182
|
+
"required": false,
|
|
42183
|
+
"defaultValue": null,
|
|
42184
|
+
"category": "props"
|
|
42185
|
+
},
|
|
42186
|
+
{
|
|
42187
|
+
"name": "hideToolbar",
|
|
42188
|
+
"description": "Whether the Toolbar is displayed or not.",
|
|
42189
|
+
"type": [
|
|
42190
|
+
"false",
|
|
42191
|
+
"true"
|
|
42192
|
+
],
|
|
42193
|
+
"required": false,
|
|
42194
|
+
"defaultValue": null,
|
|
42195
|
+
"category": "props"
|
|
42196
|
+
},
|
|
42197
|
+
{
|
|
42198
|
+
"name": "paginationPlacement",
|
|
42199
|
+
"description": "Indicates where to render the pagination controls (the \"Rows per page\" + page\nnavigation bar). Independent of `selectionBannerPlacement`.\n\n- `'top'` / `'bottom'` / `'both'` — above / below / both sides of the grid body.\n- `'none'` — no pager controls.\n- `'belowToolbar'` — in a row directly below the toolbar (right-aligned). Pair\n with `selectionBannerPlacement=\"belowToolbar\"` to get the banner on the left\n and the pager on the right in the same row. Only applies when `pagination` is enabled.",
|
|
42200
|
+
"type": [
|
|
42201
|
+
"\"top\"",
|
|
42202
|
+
"\"bottom\"",
|
|
42203
|
+
"\"both\"",
|
|
42204
|
+
"\"none\"",
|
|
42205
|
+
"\"belowToolbar\""
|
|
42206
|
+
],
|
|
42207
|
+
"required": false,
|
|
42208
|
+
"defaultValue": "'both'",
|
|
42209
|
+
"category": "props"
|
|
42210
|
+
},
|
|
42211
|
+
{
|
|
42212
|
+
"name": "selectionBannerPlacement",
|
|
42213
|
+
"description": "Where to render the row-selection banner (the \"All N rows on this page are\nselected…\" line). Independent of `paginationPlacement` — the latter only\ncontrols the pager controls.\n\n- `'top'` — above the toolbar (default, current behaviour).\n- `'bottom'` — in the footer, alongside the bottom pager.\n- `'belowToolbar'` — between the toolbar and the grid body. Rendered via\n the toolbar slot, so the toolbar slot is forced to render even when\n `hideToolbar` is set (the toolbar itself stays hidden, only the banner shows).\n Combine with `paginationPlacement=\"belowToolbar\"` for a banner-left / pager-right\n row. Only applies when `pagination` is enabled.",
|
|
42214
|
+
"type": [
|
|
42215
|
+
"\"top\"",
|
|
42216
|
+
"\"bottom\"",
|
|
42217
|
+
"\"belowToolbar\""
|
|
42218
|
+
],
|
|
42219
|
+
"required": false,
|
|
42220
|
+
"defaultValue": "'top'",
|
|
42221
|
+
"category": "props"
|
|
42222
|
+
},
|
|
42223
|
+
{
|
|
42224
|
+
"name": "paginationProps",
|
|
42225
|
+
"description": "Props to forward to the pagination component.",
|
|
42226
|
+
"type": "Omit<TablePaginationProps, \"paginationMode\" | \"component\" | \"count\" | \"onPageChange\" | \"onRowsPerPageChange\" | \"page\" | \"rowsPerPage\" | \"rowsPerPageOptions\">",
|
|
42227
|
+
"required": false,
|
|
42228
|
+
"defaultValue": null,
|
|
42229
|
+
"category": "props"
|
|
42230
|
+
},
|
|
42231
|
+
{
|
|
42232
|
+
"name": "theme",
|
|
42233
|
+
"description": "Theme.",
|
|
42234
|
+
"type": [
|
|
42235
|
+
"\"light\"",
|
|
42236
|
+
"\"dark\""
|
|
42237
|
+
],
|
|
42238
|
+
"required": false,
|
|
42239
|
+
"defaultValue": null,
|
|
42240
|
+
"category": "props"
|
|
42241
|
+
},
|
|
42242
|
+
{
|
|
42243
|
+
"name": "getTreeDataPath",
|
|
42244
|
+
"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.",
|
|
42245
|
+
"type": "(row: any) => readonly string[]",
|
|
42246
|
+
"required": false,
|
|
42247
|
+
"defaultValue": null,
|
|
42248
|
+
"category": "props"
|
|
42249
|
+
},
|
|
42250
|
+
{
|
|
42251
|
+
"name": "setTreeDataPath",
|
|
42252
|
+
"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.",
|
|
42253
|
+
"type": "(path: string[], row: any) => any",
|
|
42254
|
+
"required": false,
|
|
42255
|
+
"defaultValue": null,
|
|
42256
|
+
"category": "props"
|
|
42257
|
+
}
|
|
42258
|
+
],
|
|
42259
|
+
"examples": [],
|
|
42260
|
+
"tags": {}
|
|
42261
|
+
},
|
|
42262
|
+
{
|
|
42263
|
+
"name": "GridToolbarFilterSemanticField",
|
|
42264
|
+
"description": "The GridToolbarFilterSemanticField component.",
|
|
42265
|
+
"filePath": "packages/table-pro/src/components/GridToolbarFilterSemanticField/GridToolbarFilterSemanticField.tsx",
|
|
42266
|
+
"props": [
|
|
42267
|
+
{
|
|
42268
|
+
"name": "nlpFilterConfig",
|
|
42269
|
+
"description": "",
|
|
42270
|
+
"type": "FilterConfig",
|
|
42271
|
+
"required": true,
|
|
42272
|
+
"defaultValue": null,
|
|
42273
|
+
"category": "props"
|
|
42274
|
+
},
|
|
42275
|
+
{
|
|
42276
|
+
"name": "onFilterModelChange",
|
|
42277
|
+
"description": "",
|
|
42278
|
+
"type": "(filterModel: GridFilterModel) => void",
|
|
42279
|
+
"required": false,
|
|
42280
|
+
"defaultValue": null,
|
|
42281
|
+
"category": "props"
|
|
42282
|
+
},
|
|
42283
|
+
{
|
|
42284
|
+
"name": "dateFormat",
|
|
42285
|
+
"description": "",
|
|
42286
|
+
"type": "string",
|
|
42287
|
+
"required": false,
|
|
42288
|
+
"defaultValue": null,
|
|
42289
|
+
"category": "props"
|
|
42290
|
+
},
|
|
42291
|
+
{
|
|
42292
|
+
"name": "defaultModel",
|
|
42293
|
+
"description": "",
|
|
42294
|
+
"type": "string",
|
|
42295
|
+
"required": false,
|
|
42296
|
+
"defaultValue": null,
|
|
42297
|
+
"category": "props"
|
|
42298
|
+
},
|
|
42299
|
+
{
|
|
42300
|
+
"name": "defaultFilter",
|
|
42301
|
+
"description": "",
|
|
42302
|
+
"type": "CompletionResponse",
|
|
42303
|
+
"required": false,
|
|
42304
|
+
"defaultValue": null,
|
|
42305
|
+
"category": "props"
|
|
42306
|
+
},
|
|
42307
|
+
{
|
|
42308
|
+
"name": "disablePower",
|
|
42309
|
+
"description": "",
|
|
42310
|
+
"type": [
|
|
42311
|
+
"false",
|
|
42312
|
+
"true"
|
|
42313
|
+
],
|
|
42314
|
+
"required": false,
|
|
42315
|
+
"defaultValue": null,
|
|
42316
|
+
"category": "props"
|
|
42317
|
+
},
|
|
42318
|
+
{
|
|
42319
|
+
"name": "localeText",
|
|
42320
|
+
"description": "",
|
|
42321
|
+
"type": "LocaleText",
|
|
42322
|
+
"required": false,
|
|
42323
|
+
"defaultValue": null,
|
|
42324
|
+
"category": "props"
|
|
42325
|
+
}
|
|
42326
|
+
],
|
|
42327
|
+
"examples": [],
|
|
42328
|
+
"tags": {}
|
|
42329
|
+
},
|
|
42330
|
+
{
|
|
42331
|
+
"name": "ServerSideControlledPagination",
|
|
42332
|
+
"description": "",
|
|
42333
|
+
"filePath": "packages/table-pro/src/components/Pagination/ServerSideControlledPagination.tsx",
|
|
42334
|
+
"props": [],
|
|
42335
|
+
"examples": [],
|
|
42336
|
+
"tags": {}
|
|
42337
|
+
},
|
|
42338
|
+
{
|
|
42339
|
+
"name": "StatefulDataGrid",
|
|
42340
|
+
"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`.",
|
|
42341
|
+
"filePath": "packages/table-pro/src/components/StatefulDataGrid/StatefulDataGrid.tsx",
|
|
42342
|
+
"props": [
|
|
42343
|
+
{
|
|
42344
|
+
"name": "useRouter",
|
|
42345
|
+
"description": "Hook returning pathname, search params and a method to update query params.",
|
|
42346
|
+
"type": "() => { pathname: string; search: string; historyReplace: (newSearch: string, options?: { authoritative?: boolean | undefined; } | undefined) => void; }",
|
|
42347
|
+
"required": true,
|
|
42348
|
+
"defaultValue": null,
|
|
42349
|
+
"category": "props"
|
|
42350
|
+
},
|
|
42351
|
+
{
|
|
42352
|
+
"name": "localStorageVersion",
|
|
42353
|
+
"description": "Local Storage version, to upgrade when we want to force a clean out.",
|
|
42354
|
+
"type": "number",
|
|
42355
|
+
"required": false,
|
|
42356
|
+
"defaultValue": null,
|
|
42357
|
+
"category": "props"
|
|
42358
|
+
},
|
|
42359
|
+
{
|
|
42360
|
+
"name": "previousLocalStorageVersions",
|
|
42361
|
+
"description": "Previous Local Storage versions to clean out when a new one is released.",
|
|
42362
|
+
"type": "number[]",
|
|
42363
|
+
"required": false,
|
|
42364
|
+
"defaultValue": null,
|
|
42365
|
+
"category": "props"
|
|
42366
|
+
},
|
|
42367
|
+
{
|
|
42368
|
+
"name": "license",
|
|
42369
|
+
"description": "License key for MUI Datagrid Pro.",
|
|
42370
|
+
"type": "string",
|
|
42371
|
+
"required": false,
|
|
42372
|
+
"defaultValue": null,
|
|
42373
|
+
"category": "props"
|
|
42374
|
+
},
|
|
42375
|
+
{
|
|
42376
|
+
"name": "height",
|
|
42377
|
+
"description": "Height. A default one is set to prevent rendering all rows.",
|
|
42378
|
+
"type": "string",
|
|
42379
|
+
"required": false,
|
|
42380
|
+
"defaultValue": "'500px'",
|
|
42381
|
+
"category": "props"
|
|
42382
|
+
},
|
|
42383
|
+
{
|
|
42384
|
+
"name": "toolbar",
|
|
42385
|
+
"description": "Toolbar. A default one is provided but every button from this default Toolbar can be customized and the entire Toolbar can be replaced.",
|
|
42386
|
+
"type": "ReactNode",
|
|
42387
|
+
"required": false,
|
|
42388
|
+
"defaultValue": null,
|
|
42389
|
+
"category": "props"
|
|
42390
|
+
},
|
|
42391
|
+
{
|
|
42392
|
+
"name": "hideToolbar",
|
|
42393
|
+
"description": "Whether the Toolbar is displayed or not.",
|
|
42394
|
+
"type": [
|
|
42395
|
+
"false",
|
|
42396
|
+
"true"
|
|
42397
|
+
],
|
|
42398
|
+
"required": false,
|
|
42399
|
+
"defaultValue": null,
|
|
42400
|
+
"category": "props"
|
|
42401
|
+
},
|
|
42402
|
+
{
|
|
42403
|
+
"name": "paginationPlacement",
|
|
42404
|
+
"description": "Indicates where to render the pagination controls (the \"Rows per page\" + page\nnavigation bar). Independent of `selectionBannerPlacement`.\n\n- `'top'` / `'bottom'` / `'both'` — above / below / both sides of the grid body.\n- `'none'` — no pager controls.\n- `'belowToolbar'` — in a row directly below the toolbar (right-aligned). Pair\n with `selectionBannerPlacement=\"belowToolbar\"` to get the banner on the left\n and the pager on the right in the same row. Only applies when `pagination` is enabled.",
|
|
42405
|
+
"type": [
|
|
42406
|
+
"\"top\"",
|
|
42407
|
+
"\"bottom\"",
|
|
42408
|
+
"\"both\"",
|
|
42409
|
+
"\"none\"",
|
|
42410
|
+
"\"belowToolbar\""
|
|
42411
|
+
],
|
|
42412
|
+
"required": false,
|
|
42413
|
+
"defaultValue": "'both'",
|
|
42414
|
+
"category": "props"
|
|
42415
|
+
},
|
|
42416
|
+
{
|
|
42417
|
+
"name": "selectionBannerPlacement",
|
|
42418
|
+
"description": "Where to render the row-selection banner (the \"All N rows on this page are\nselected…\" line). Independent of `paginationPlacement` — the latter only\ncontrols the pager controls.\n\n- `'top'` — above the toolbar (default, current behaviour).\n- `'bottom'` — in the footer, alongside the bottom pager.\n- `'belowToolbar'` — between the toolbar and the grid body. Rendered via\n the toolbar slot, so the toolbar slot is forced to render even when\n `hideToolbar` is set (the toolbar itself stays hidden, only the banner shows).\n Combine with `paginationPlacement=\"belowToolbar\"` for a banner-left / pager-right\n row. Only applies when `pagination` is enabled.",
|
|
42419
|
+
"type": [
|
|
42420
|
+
"\"top\"",
|
|
42421
|
+
"\"bottom\"",
|
|
42422
|
+
"\"belowToolbar\""
|
|
42423
|
+
],
|
|
42424
|
+
"required": false,
|
|
42425
|
+
"defaultValue": "'top'",
|
|
42426
|
+
"category": "props"
|
|
42427
|
+
},
|
|
42428
|
+
{
|
|
42429
|
+
"name": "paginationProps",
|
|
42430
|
+
"description": "Props to forward to the pagination component.",
|
|
42431
|
+
"type": "Omit<TablePaginationProps, \"paginationMode\" | \"component\" | \"count\" | \"onPageChange\" | \"onRowsPerPageChange\" | \"page\" | \"rowsPerPage\" | \"rowsPerPageOptions\">",
|
|
42432
|
+
"required": false,
|
|
42433
|
+
"defaultValue": null,
|
|
42434
|
+
"category": "props"
|
|
42435
|
+
},
|
|
42436
|
+
{
|
|
42437
|
+
"name": "theme",
|
|
42438
|
+
"description": "Theme.",
|
|
42439
|
+
"type": [
|
|
42440
|
+
"\"light\"",
|
|
42441
|
+
"\"dark\""
|
|
42442
|
+
],
|
|
42443
|
+
"required": false,
|
|
42444
|
+
"defaultValue": null,
|
|
42445
|
+
"category": "props"
|
|
42446
|
+
},
|
|
42447
|
+
{
|
|
42448
|
+
"name": "getTreeDataPath",
|
|
42449
|
+
"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.",
|
|
42450
|
+
"type": "(row: any) => readonly string[]",
|
|
42451
|
+
"required": false,
|
|
42452
|
+
"defaultValue": null,
|
|
42453
|
+
"category": "props"
|
|
42454
|
+
},
|
|
42455
|
+
{
|
|
42456
|
+
"name": "setTreeDataPath",
|
|
42457
|
+
"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.",
|
|
42458
|
+
"type": "(path: string[], row: any) => any",
|
|
42459
|
+
"required": false,
|
|
42460
|
+
"defaultValue": null,
|
|
42461
|
+
"category": "props"
|
|
42462
|
+
}
|
|
42463
|
+
],
|
|
42464
|
+
"examples": [],
|
|
42465
|
+
"tags": {}
|
|
42466
|
+
},
|
|
42467
|
+
{
|
|
42468
|
+
"name": "TextCell",
|
|
42469
|
+
"description": "The Cell component.",
|
|
42470
|
+
"filePath": "packages/table-pro/src/components/TextCell/TextCell.tsx",
|
|
42471
|
+
"props": [
|
|
42472
|
+
{
|
|
42473
|
+
"name": "badge",
|
|
42474
|
+
"description": "Including Badge Component.",
|
|
42475
|
+
"type": "ReactNode",
|
|
42476
|
+
"required": false,
|
|
42477
|
+
"defaultValue": null,
|
|
42478
|
+
"category": "props"
|
|
42479
|
+
},
|
|
42480
|
+
{
|
|
42481
|
+
"name": "leftIcon",
|
|
42482
|
+
"description": "Can be a string or an array of strings containing `d` property of the `path` SVG element.<br />\nCan also be a ReactElement.",
|
|
42483
|
+
"type": [
|
|
42484
|
+
"string",
|
|
42485
|
+
"string[]",
|
|
42486
|
+
"ReactElement<any, string | JSXElementConstructor<any>>"
|
|
42487
|
+
],
|
|
42488
|
+
"required": false,
|
|
42489
|
+
"defaultValue": null,
|
|
42490
|
+
"category": "props"
|
|
42491
|
+
},
|
|
42492
|
+
{
|
|
42493
|
+
"name": "leftIconColor",
|
|
42494
|
+
"description": "Left Icon Color variant.",
|
|
42495
|
+
"type": [
|
|
42496
|
+
"\"primary\"",
|
|
42497
|
+
"\"secondary\"",
|
|
42498
|
+
"\"error\"",
|
|
42499
|
+
"\"success\"",
|
|
42500
|
+
"\"warning\"",
|
|
42501
|
+
"\"info\"",
|
|
42502
|
+
"\"question\"",
|
|
42503
|
+
"\"no-data\"",
|
|
42504
|
+
"\"asm\"",
|
|
42505
|
+
"\"brand-trust\"",
|
|
42506
|
+
"\"certificates\"",
|
|
42507
|
+
"\"ondmarc\"",
|
|
42508
|
+
"\"pulse\"",
|
|
42509
|
+
"\"radar\"",
|
|
42510
|
+
"\"rojo-ds\"",
|
|
42511
|
+
"\"vendor-secure\"",
|
|
42512
|
+
"\"website\"",
|
|
42513
|
+
"string & {}"
|
|
42514
|
+
],
|
|
42515
|
+
"required": false,
|
|
42516
|
+
"defaultValue": null,
|
|
42517
|
+
"category": "props"
|
|
42518
|
+
},
|
|
42519
|
+
{
|
|
42520
|
+
"name": "rightIcon",
|
|
42521
|
+
"description": "Can be a string or an array of strings containing `d` property of the `path` SVG element.<br />\nCan also be a ReactElement.",
|
|
42522
|
+
"type": [
|
|
42523
|
+
"string",
|
|
42524
|
+
"string[]",
|
|
42525
|
+
"ReactElement<any, string | JSXElementConstructor<any>>"
|
|
42526
|
+
],
|
|
42527
|
+
"required": false,
|
|
42528
|
+
"defaultValue": null,
|
|
42529
|
+
"category": "props"
|
|
42530
|
+
},
|
|
42531
|
+
{
|
|
42532
|
+
"name": "rightIconColor",
|
|
42533
|
+
"description": "Right Icon Color variant.",
|
|
42534
|
+
"type": [
|
|
42535
|
+
"\"primary\"",
|
|
42536
|
+
"\"secondary\"",
|
|
42537
|
+
"\"error\"",
|
|
42538
|
+
"\"success\"",
|
|
42539
|
+
"\"warning\"",
|
|
42540
|
+
"\"info\"",
|
|
42541
|
+
"\"question\"",
|
|
42542
|
+
"\"no-data\"",
|
|
42543
|
+
"\"asm\"",
|
|
42544
|
+
"\"brand-trust\"",
|
|
42545
|
+
"\"certificates\"",
|
|
42546
|
+
"\"ondmarc\"",
|
|
42547
|
+
"\"pulse\"",
|
|
42548
|
+
"\"radar\"",
|
|
42549
|
+
"\"rojo-ds\"",
|
|
42550
|
+
"\"vendor-secure\"",
|
|
42551
|
+
"\"website\"",
|
|
42552
|
+
"string & {}"
|
|
42553
|
+
],
|
|
42554
|
+
"required": false,
|
|
42555
|
+
"defaultValue": null,
|
|
42556
|
+
"category": "props"
|
|
42557
|
+
},
|
|
42558
|
+
{
|
|
42559
|
+
"name": "shieldVariant",
|
|
42560
|
+
"description": "Shield variant.",
|
|
42561
|
+
"type": [
|
|
42562
|
+
"\"success\"",
|
|
42563
|
+
"\"warning\"",
|
|
42564
|
+
"\"question\"",
|
|
42565
|
+
"\"successLocked\"",
|
|
42566
|
+
"\"successUnlocked\"",
|
|
42567
|
+
"\"fail\"",
|
|
42568
|
+
"\"failLocked\"",
|
|
42569
|
+
"\"failUnlocked\"",
|
|
42570
|
+
"\"warningLocked\"",
|
|
42571
|
+
"\"warningUnlocked\"",
|
|
42572
|
+
"\"ignored\"",
|
|
42573
|
+
"\"noData\"",
|
|
42574
|
+
"\"email\""
|
|
42575
|
+
],
|
|
42576
|
+
"required": false,
|
|
42577
|
+
"defaultValue": null,
|
|
42578
|
+
"category": "props"
|
|
42579
|
+
}
|
|
42580
|
+
],
|
|
42581
|
+
"examples": [],
|
|
42582
|
+
"tags": {}
|
|
42583
|
+
},
|
|
42584
|
+
{
|
|
42585
|
+
"name": "Toolbar",
|
|
42586
|
+
"description": "------",
|
|
42587
|
+
"filePath": "packages/table-pro/src/components/Toolbar/Toolbar.tsx",
|
|
42588
|
+
"props": [
|
|
42589
|
+
{
|
|
42590
|
+
"name": "columnsButtonProps",
|
|
42591
|
+
"description": "Props to forward to the column button.",
|
|
42592
|
+
"type": [
|
|
42593
|
+
"GridToolbarColumnsButtonProps",
|
|
42594
|
+
"GridToolbarColumnsButtonProps & RefAttributes<HTMLButtonElement>"
|
|
42595
|
+
],
|
|
42596
|
+
"required": false,
|
|
42597
|
+
"defaultValue": null,
|
|
42598
|
+
"category": "props"
|
|
42599
|
+
},
|
|
42600
|
+
{
|
|
42601
|
+
"name": "columnsButtonRef",
|
|
42602
|
+
"description": "Column button ref.",
|
|
42603
|
+
"type": "RefObject<HTMLButtonElement>",
|
|
42604
|
+
"required": false,
|
|
42605
|
+
"defaultValue": null,
|
|
42606
|
+
"category": "props"
|
|
42607
|
+
},
|
|
42608
|
+
{
|
|
42609
|
+
"name": "densityButtonProps",
|
|
42610
|
+
"description": "Props to forward to the density button.",
|
|
42611
|
+
"type": [
|
|
42612
|
+
"GridToolbarDensitySelectorProps",
|
|
42613
|
+
"GridToolbarDensitySelectorProps & RefAttributes<HTMLButtonElement>"
|
|
42614
|
+
],
|
|
42615
|
+
"required": false,
|
|
42616
|
+
"defaultValue": null,
|
|
42617
|
+
"category": "props"
|
|
42618
|
+
},
|
|
42619
|
+
{
|
|
42620
|
+
"name": "densityButtonRef",
|
|
42621
|
+
"description": "Density button ref.",
|
|
42622
|
+
"type": "RefObject<HTMLButtonElement>",
|
|
42623
|
+
"required": false,
|
|
42624
|
+
"defaultValue": null,
|
|
42625
|
+
"category": "props"
|
|
42626
|
+
},
|
|
42627
|
+
{
|
|
42628
|
+
"name": "exportButtonProps",
|
|
42629
|
+
"description": "Props to forward to the export button.",
|
|
42630
|
+
"type": "GridToolbarExportProps",
|
|
42631
|
+
"required": false,
|
|
42632
|
+
"defaultValue": null,
|
|
42633
|
+
"category": "props"
|
|
42634
|
+
},
|
|
42635
|
+
{
|
|
42636
|
+
"name": "exportButtonRef",
|
|
42637
|
+
"description": "Export button ref.",
|
|
42638
|
+
"type": "RefObject<HTMLButtonElement>",
|
|
42639
|
+
"required": false,
|
|
42640
|
+
"defaultValue": null,
|
|
42641
|
+
"category": "props"
|
|
42642
|
+
},
|
|
42643
|
+
{
|
|
42644
|
+
"name": "filterButtonProps",
|
|
42645
|
+
"description": "Props to forward to the filter button.",
|
|
42646
|
+
"type": "GridToolbarFilterButtonProps",
|
|
42647
|
+
"required": false,
|
|
42648
|
+
"defaultValue": null,
|
|
42649
|
+
"category": "props"
|
|
42650
|
+
},
|
|
42651
|
+
{
|
|
42652
|
+
"name": "filterButtonRef",
|
|
42653
|
+
"description": "Filter button ref.",
|
|
42654
|
+
"type": "RefObject<HTMLButtonElement>",
|
|
42655
|
+
"required": false,
|
|
42656
|
+
"defaultValue": null,
|
|
42657
|
+
"category": "props"
|
|
42658
|
+
},
|
|
42659
|
+
{
|
|
42660
|
+
"name": "hasColumnsButton",
|
|
42661
|
+
"description": "Whether the columns button is displayed or not.",
|
|
42662
|
+
"type": [
|
|
42663
|
+
"false",
|
|
42664
|
+
"true"
|
|
42665
|
+
],
|
|
42666
|
+
"required": false,
|
|
42667
|
+
"defaultValue": null,
|
|
42668
|
+
"category": "props"
|
|
42669
|
+
},
|
|
42670
|
+
{
|
|
42671
|
+
"name": "hasDensityButton",
|
|
42672
|
+
"description": "Whether the density button is displayed or not.",
|
|
42673
|
+
"type": [
|
|
42674
|
+
"false",
|
|
42675
|
+
"true"
|
|
42676
|
+
],
|
|
42677
|
+
"required": false,
|
|
42678
|
+
"defaultValue": null,
|
|
42679
|
+
"category": "props"
|
|
42680
|
+
},
|
|
42681
|
+
{
|
|
42682
|
+
"name": "hasExportButton",
|
|
42683
|
+
"description": "Whether the export button is displayed or not.",
|
|
42684
|
+
"type": [
|
|
42685
|
+
"false",
|
|
42686
|
+
"true"
|
|
42687
|
+
],
|
|
42688
|
+
"required": false,
|
|
42689
|
+
"defaultValue": null,
|
|
42690
|
+
"category": "props"
|
|
42691
|
+
},
|
|
42692
|
+
{
|
|
42693
|
+
"name": "hasFilterButton",
|
|
42694
|
+
"description": "Whether the filter button is displayed or not.",
|
|
42695
|
+
"type": [
|
|
42696
|
+
"false",
|
|
42697
|
+
"true"
|
|
42698
|
+
],
|
|
42699
|
+
"required": false,
|
|
42700
|
+
"defaultValue": null,
|
|
42701
|
+
"category": "props"
|
|
42702
|
+
},
|
|
42703
|
+
{
|
|
42704
|
+
"name": "onFilterModelChange",
|
|
42705
|
+
"description": "Configuration object for NLP filter. undefined if disabled.",
|
|
42706
|
+
"type": "(filterModel: GridFilterModel) => void",
|
|
42707
|
+
"required": false,
|
|
42708
|
+
"defaultValue": null,
|
|
42709
|
+
"category": "props"
|
|
42710
|
+
},
|
|
42711
|
+
{
|
|
42712
|
+
"name": "semanticFilterProps",
|
|
42713
|
+
"description": "",
|
|
42714
|
+
"type": "GridToolbarFilterSemanticProps",
|
|
42715
|
+
"required": false,
|
|
42716
|
+
"defaultValue": null,
|
|
42717
|
+
"category": "props"
|
|
42718
|
+
},
|
|
42719
|
+
{
|
|
42720
|
+
"name": "showQuickFilter",
|
|
42721
|
+
"description": "Whether you want to show the quick filter or not.",
|
|
42722
|
+
"type": [
|
|
42723
|
+
"false",
|
|
42724
|
+
"true"
|
|
42725
|
+
],
|
|
42726
|
+
"required": false,
|
|
42727
|
+
"defaultValue": null,
|
|
42728
|
+
"category": "props"
|
|
42729
|
+
}
|
|
42730
|
+
],
|
|
42731
|
+
"examples": [],
|
|
42732
|
+
"tags": {}
|
|
42733
|
+
},
|
|
42734
|
+
{
|
|
42735
|
+
"name": "ToolbarWrapper",
|
|
42736
|
+
"description": "Renders a toolbar followed by a row that can contain the selection banner (left)\nand/or the pager controls (right), so they sit between the toolbar and the grid body\n(`selectionBannerPlacement=\"belowToolbar\"` and/or `paginationPlacement=\"belowToolbar\"`).\nThe banner/pager visibility is driven by `displaySelection` / `displayPagination`.\nThe row gets a top margin matching the banner's built-in bottom margin so the spacing\nabove and below it is symmetric.",
|
|
42737
|
+
"filePath": "packages/table-pro/src/components/ToolbarWrapper/ToolbarWrapper.tsx",
|
|
42738
|
+
"props": [],
|
|
42739
|
+
"examples": [],
|
|
42740
|
+
"tags": {}
|
|
42741
|
+
}
|
|
42742
|
+
]
|
|
42743
|
+
},
|
|
42140
42744
|
{
|
|
42141
42745
|
"name": "@redsift/dashboard",
|
|
42142
42746
|
"components": [
|
|
@@ -42196,8 +42800,8 @@
|
|
|
42196
42800
|
},
|
|
42197
42801
|
{
|
|
42198
42802
|
"name": "dataGridApiRef",
|
|
42199
|
-
"description": "Datagrid API Ref.",
|
|
42200
|
-
"type": "MutableRefObject<GridApiPro>",
|
|
42803
|
+
"description": "Datagrid API Ref. MUI v8: can be null initially.",
|
|
42804
|
+
"type": "MutableRefObject<GridApiPro | null>",
|
|
42201
42805
|
"required": false,
|
|
42202
42806
|
"defaultValue": null,
|
|
42203
42807
|
"category": "props"
|
|
@@ -48611,14 +49215,15 @@
|
|
|
48611
49215
|
}
|
|
48612
49216
|
],
|
|
48613
49217
|
"summary": {
|
|
48614
|
-
"totalPackages":
|
|
48615
|
-
"totalComponents":
|
|
49218
|
+
"totalPackages": 8,
|
|
49219
|
+
"totalComponents": 164,
|
|
48616
49220
|
"componentsByPackage": {
|
|
48617
49221
|
"design-system": 61,
|
|
48618
49222
|
"popovers": 22,
|
|
48619
49223
|
"pickers": 21,
|
|
48620
49224
|
"charts": 14,
|
|
48621
49225
|
"table": 8,
|
|
49226
|
+
"table-pro": 8,
|
|
48622
49227
|
"dashboard": 10,
|
|
48623
49228
|
"products": 20
|
|
48624
49229
|
}
|