@cloud-ru/ds-table 1.0.8-preview-61ab169d.0 → 1.0.8-preview-4074f7f8.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/README.md +89 -23
- package/dist/cjs/components/types.d.ts +5 -0
- package/dist/cjs/helperComponents/Cells/HeaderCell/ResizeHandle.js +15 -1
- package/dist/esm/components/types.d.ts +5 -0
- package/dist/esm/helperComponents/Cells/HeaderCell/ResizeHandle.js +15 -1
- package/dist/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/tsconfig.esm.tsbuildinfo +1 -1
- package/package.json +13 -13
- package/src/components/types.ts +6 -2
- package/src/helperComponents/Cells/HeaderCell/ResizeHandle.tsx +19 -0
package/README.md
CHANGED
|
@@ -927,26 +927,26 @@ export function FullWidth() {
|
|
|
927
927
|
| `cardColumns` | `number` | — | Желаемое число колонок карточного вида (`view='cards'`). <br/> На широком контейнере рисуется ровно столько колонок; при сужении сетка <br/> схлопывается до меньшего числа (порог — `cardMinWidth`). Без пропа число <br/> колонок определяется только шириной контейнера и `cardMinWidth` (auto-fill). |
|
|
928
928
|
| `cardMinWidth` | `number` | `320` | Минимальная ширина карточки в `view='cards'`, px. Порог, ниже которого <br/> колонки схлопываются. Карточка ужимается до ширины контейнера, если он уже. |
|
|
929
929
|
| `className` | `string` | — | CSS-класс |
|
|
930
|
-
| `columnDefinitions` | `ColumnDefinition` \| `Except`
|
|
931
|
-
| `columnFilters` | `FilterRow`
|
|
930
|
+
| `columnDefinitions` | `ColumnDefinition` \| `Except` | — | Определение внешнего вида и функционала колонок |
|
|
931
|
+
| `columnFilters` | `FilterRow` | — | Фильтры |
|
|
932
932
|
| `columnVirtualizerInstanceRef` | `ColumnVirtualizer` | — | Ref на инстанс column-virtualizer'а для управления прокруткой снаружи |
|
|
933
933
|
| `columnVirtualizerOptions` | `Partial<VirtualizerOptions<HTMLElement, Element>>` | — | Дополнительные параметры column-virtualizer'а (`@tanstack/react-virtual`). <br/> Переопределяют дефолты (overscan=3). |
|
|
934
934
|
| `columnsSettings` | `{ enableDrag?: boolean; enableSettingsMenu?: boolean; } \| undefined` | — | Настройки колонок: `enableDrag` — переупорядочивание (заголовки таблицы и строки в меню настроек); <br/> `enableSettingsMenu` — меню показа колонок. |
|
|
935
935
|
| `copyPinnedRows` | `boolean` | `false` | Параметр отвечает за сохранение закрепленных строк в теле таблицы |
|
|
936
|
-
| `data` | `TData` | — | Данные для отрисовки |
|
|
936
|
+
| `data` | `TData[]` | — | Данные для отрисовки |
|
|
937
937
|
| `data-test-id` | `string` | — | |
|
|
938
938
|
| `dataError` | `boolean` | — | Флаг, показывающий что произошла ошибка запроса при пустых данных |
|
|
939
939
|
| `dataFiltered` | `boolean` | — | Флаг, показывающий что данные были отфильтрованы при пустых данных |
|
|
940
940
|
| `defaultView` | `"cards"` \| `"table"` | `'table' (на mobile — `cards`)` | Начальный режим отображения (uncontrolled). <br/> Если не задан — дефолт по раскладке: `table` на desktop, `cards` на mobile (`TABLE_LAYOUT_PRESETS`). |
|
|
941
941
|
| `enableColumnVirtualization` | `boolean` | `false` | Включает виртуализацию колонок (windowing по горизонтали). <br/> Рекомендуется при > 30 видимых колонок. Несовместимо с `view='cards'`. <br/> Pinned-колонки (left/right) всегда отрисовываются вне зависимости от настройки. |
|
|
942
942
|
| `enableFuzzySearch` | `boolean` | — | Включить нечеткий поиск |
|
|
943
|
-
| `enableRowVirtualization` | `boolean` | `false` | Включает виртуализацию строк (windowing по вертикали). <br/> Рекомендуется при > 200 строк. Несовместимо с `view='cards'` — при картах игнорируется. |
|
|
943
|
+
| `enableRowVirtualization` | `boolean` | `false` | Включает виртуализацию строк (windowing по вертикали). <br/> Рекомендуется при > 200 строк. Несовместимо с `view='cards'` — при картах игнорируется. <br/> 🔴 Требует `size` у колонок: виртуализованные строки позиционируются абсолютно и не участвуют в <br/> расчёте внутренней ширины, поэтому колонка без `size` делит ширину контейнера поровну с <br/> остальными вместо растягивания по содержимому. |
|
|
944
944
|
| `enableSelectPinned` | `boolean` | `false` | Параметр отвечает за чекбокс выбора закрепленных строк |
|
|
945
945
|
| `errorDataState` | `EmptyStateProps` | — | Экран при ошибке запроса |
|
|
946
|
-
| `expanding` | `
|
|
946
|
+
| `expanding` | `TreeColumnDefinitionProps` | — | Общие настройки раскрывающихся (tree) строк: `getSubRows`, `expandingColumnDefinition`, <br/> `initialState`, `state`, `onChange`. |
|
|
947
947
|
| `fullWidth` | `boolean` | `true` | Растягивать таблицу на всю ширину контейнера. <br/> При `false` ширина определяется суммой колонок (лучше всего, когда у всех колонок задан `size` / `width`). <br/> Явный проп = desktop-значение; на mobile всегда `true` (`TABLE_LAYOUT_PRESETS`). |
|
|
948
|
-
| `getRowBackgroundColor` | `
|
|
949
|
-
| `getRowId` | `TData` | — | Функция получения уникального идентификатора строки |
|
|
948
|
+
| `getRowBackgroundColor` | `TableRowColor` | — | Функция определения цвета фона строки по её данным. <br/> Работает только в `view='table'` — карточки (`view='cards'`) не тонируются. <br/> @param data данные строки <br/> @returns цвет фона строки или `undefined` |
|
|
949
|
+
| `getRowId` | `((originalRow: TData, index: number, parent?: Row<TData>) => string)` | — | Функция получения уникального идентификатора строки |
|
|
950
950
|
| `hasMore` | `boolean` | — | Есть ли ещё данные для загрузки. Управляет видимостью кнопки / активностью observer-а. |
|
|
951
951
|
| `headerRowBackgroundColor` | `"blue"` \| `"green"` \| `"neutral"` \| `"orange"` \| `"pink"` \| `"red"` \| `"violet"` \| `"yellow"` | — | Accent-тон фона строки заголовков колонок (`tableHeadLine`). <br/> Работает только в `view='table'`. |
|
|
952
952
|
| `headlineId` | `string` | — | Id колонки, чей рендер используется как заголовок карточки в режиме `view='cards'`. <br/> Имеет смысл только при `view='cards'`. |
|
|
@@ -958,13 +958,13 @@ export function FullWidth() {
|
|
|
958
958
|
| `manualFiltering` | `boolean` | `false` | |
|
|
959
959
|
| `manualPagination` | `boolean` | `false` | |
|
|
960
960
|
| `manualSorting` | `boolean` | `false` | |
|
|
961
|
-
| `moreActions` | `
|
|
961
|
+
| `moreActions` | `ToolbarProps` | — | Элементы выпадающего списка кнопки с действиями |
|
|
962
962
|
| `noDataState` | `EmptyStateProps` | — | Экран при отсутствии данных |
|
|
963
963
|
| `noResultsState` | `EmptyStateProps` | — | Экран при отсутствии результатов поиска или фильтров |
|
|
964
964
|
| `onExport` | `(() => void)` | — | Колбэк экспорта данных. Рендерит иконку в тулбаре перед настройками колонок. |
|
|
965
965
|
| `onLoadMore` | `(() => void)` | — | Колбэк дозагрузки следующей порции данных. <br/> В режиме `loadMoreTrigger='scroll'` вызывается автоматически при достижении конца списка; <br/> в режиме `loadMoreTrigger='button'` — по нажатию кнопки «Загрузить ещё». |
|
|
966
966
|
| `onRefresh` | `(() => void)` | — | Колбэк обновления данных |
|
|
967
|
-
| `onRowClick` | `RowClickHandler`
|
|
967
|
+
| `onRowClick` | `RowClickHandler` | — | Колбэк клика по строке |
|
|
968
968
|
| `onViewChange` | `((view: View) => void)` | — | Колбэк на смену режима отображения |
|
|
969
969
|
| `outline` | `boolean` | `false` | Внешний бордер для тулбара и таблицы |
|
|
970
970
|
| `pageCount` | `number` | — | Кол-во страниц (для внешнего управления) |
|
|
@@ -973,10 +973,10 @@ export function FullWidth() {
|
|
|
973
973
|
| `renderCard` | `((context: RenderCardContext<TData>) => ReactNode)` | — | Кастомный рендер карточки в `view='cards'`. Получает контекст с tanstack <br/> `row` / `table` и `defaultRender` (готовый элемент дефолтной карточки — <br/> можно обернуть). Возврат заменяет дефолтную карточку. |
|
|
974
974
|
| `rowAutoHeight` | `boolean` | — | |
|
|
975
975
|
| `rowPinning` | `Pick<RowPinningState, "top">` | `{ top: [], }` | Определение, какие строки должны быть закреплены в таблице |
|
|
976
|
-
| `rowSelection` | `RowAppearance`
|
|
976
|
+
| `rowSelection` | `RowAppearance` | — | Параметры выбора строк: `initialState`, `state`, `enable`, `appearance`, `multiRow`, `onChange`. |
|
|
977
977
|
| `rowVirtualizerInstanceRef` | `RowVirtualizer` | — | Ref на инстанс row-virtualizer'а для управления прокруткой снаружи |
|
|
978
978
|
| `rowVirtualizerOptions` | `Partial<VirtualizerOptions<HTMLElement, Element>>` | — | Дополнительные параметры row-virtualizer'а (`@tanstack/react-virtual`). <br/> Переопределяют дефолты (overscan=10, estimateSize=40). |
|
|
979
|
-
| `savedState` | `
|
|
979
|
+
| `savedState` | `ToolbarPersistConfig` | — | Конфиг сохранения состояния в localStorage и queryParams. <br/> `id` должен быть уникальным для разных таблиц в рамках приложения. |
|
|
980
980
|
| `scrollContainerRef` | `RefObject<HTMLElement>` | — | Ссылка на контейнер, который скроллится |
|
|
981
981
|
| `scrollRef` | `Ref<HTMLElement>` | — | Ссылка на элемент, обозначающий самый конец прокручиваемого списка |
|
|
982
982
|
| `search` | `{ initialState?: string; state?: string; placeholder?: string \| undefined; loading?: boolean \| undefined; onChange?(value: string): void; } \| undefined` | — | Параметры глобального поиска: `initialState`, `state`, `placeholder`, `loading`, `onChange`. |
|
|
@@ -993,8 +993,21 @@ export function FullWidth() {
|
|
|
993
993
|
|
|
994
994
|
##### Related types
|
|
995
995
|
|
|
996
|
+
**BulkAction**
|
|
997
|
+
|
|
998
|
+
| Prop | Type | Default | Description |
|
|
999
|
+
|------|------|---------|-------------|
|
|
1000
|
+
| `data-test-id` | `string \| undefined` | — | |
|
|
1001
|
+
| `disabled` | `boolean \| undefined` | — | |
|
|
1002
|
+
| `icon` | `((props: { className?: string; }, deprecatedLegacyContext?: any) => ReactNode) \| (new (props: { className?: string; }, deprecatedLegacyContext?: any) => Component<any, any>)` | — | |
|
|
1003
|
+
| `label` | `string` | — | |
|
|
1004
|
+
| `onClick` | `((selectionState: RowSelectionState, resetRowSelection: (defaultState?: boolean) => void) => void) \| undefined` | — | |
|
|
1005
|
+
| `tooltip` | `TooltipProps` | — | |
|
|
1006
|
+
|
|
996
1007
|
- `ColumnDefinition` = `NormalColumnDefinition<TData> | PinnedColumnDefinition<TData> | FilterableColumnDefinition<TData>`
|
|
997
1008
|
|
|
1009
|
+
- `ColumnVirtualizer` = `Virtualizer<HTMLElement, Element> | null`
|
|
1010
|
+
|
|
998
1011
|
**EmptyStateProps**
|
|
999
1012
|
|
|
1000
1013
|
| Prop | Type | Default | Description |
|
|
@@ -1007,8 +1020,33 @@ export function FullWidth() {
|
|
|
1007
1020
|
|
|
1008
1021
|
- `Except` = `{ [KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType]; }`
|
|
1009
1022
|
|
|
1023
|
+
- `LoadMoreTrigger` = `"button"` \| `"scroll"`
|
|
1024
|
+
|
|
1025
|
+
- `RowAppearance` = `"disabled"` \| `"hide-toggler"`
|
|
1026
|
+
|
|
1010
1027
|
- `RowClickHandler` = `(e: MouseEvent<HTMLDivElement>, row: RowInfo<TData>) => void`
|
|
1011
1028
|
|
|
1029
|
+
- `RowVirtualizer` = `Virtualizer<HTMLElement, Element> | null`
|
|
1030
|
+
|
|
1031
|
+
**StickyControls**
|
|
1032
|
+
|
|
1033
|
+
| Prop | Type | Default | Description |
|
|
1034
|
+
|------|------|---------|-------------|
|
|
1035
|
+
| `backgroundPredefined` | `"blueBackground"` \| `"greenBackground"` \| `"neutralBackground"` \| `"neutralBackground1Level"` \| `"orangeBackground"` \| `"pinkBackground"` \| `"primaryBackground"` \| `"redBackground"` \| `"violetBackground"` \| `"yellowBackground"` | — | Подложка chrome-контролов (тулбар, header колонок, пагинация, плита table-view): <br/> слой backgroundPredefined + acrylic (см. `BACKGROUND_PREDEFINED_FILL` в `@cloud-ru/ds-materials`). |
|
|
1036
|
+
| `enabled` | `boolean \| undefined` | — | Включить sticky-хром при скролле страницы. |
|
|
1037
|
+
| `offsetBottom` | `number \| undefined` | — | Отступ снизу (px): высота внешнего sticky UI под таблицей (mobile tab bar). <br/> Только при `enabled: true`. |
|
|
1038
|
+
| `offsetTop` | `number \| undefined` | — | Отступ сверху (px): высота внешнего sticky UI над таблицей (app header, tabs). <br/> Только при `enabled: true`. |
|
|
1039
|
+
|
|
1040
|
+
**TableLayoutDefaults**
|
|
1041
|
+
|
|
1042
|
+
| Prop | Type | Default | Description |
|
|
1043
|
+
|------|------|---------|-------------|
|
|
1044
|
+
| `defaultView` | `"cards"` \| `"table"` | — | Начальный вид (uncontrolled). |
|
|
1045
|
+
| `fullWidth` | `boolean` | — | |
|
|
1046
|
+
| `stickyControls` | `StickyControlsLayoutDefaults` | — | |
|
|
1047
|
+
|
|
1048
|
+
- `TableRowColor` = `"blue"` \| `"green"` \| `"neutral"` \| `"orange"` \| `"pink"` \| `"red"` \| `"violet"` \| `"yellow"`
|
|
1049
|
+
|
|
1012
1050
|
- `TreeColumnDefinitionProps` = `TreeColumnDef | TreeColumnDefWithDescription<TData>`
|
|
1013
1051
|
|
|
1014
1052
|
- `View` = `"cards"` \| `"table"`
|
|
@@ -1310,8 +1348,8 @@ export function ServerDriven() {
|
|
|
1310
1348
|
| `cardColumns` | `number` | — | Желаемое число колонок карточного вида (`view='cards'`). <br/> На широком контейнере рисуется ровно столько колонок; при сужении сетка <br/> схлопывается до меньшего числа (порог — `cardMinWidth`). Без пропа число <br/> колонок определяется только шириной контейнера и `cardMinWidth` (auto-fill). |
|
|
1311
1349
|
| `cardMinWidth` | `number` | `320` | Минимальная ширина карточки в `view='cards'`, px. Порог, ниже которого <br/> колонки схлопываются. Карточка ужимается до ширины контейнера, если он уже. |
|
|
1312
1350
|
| `className` | `string` | — | CSS-класс |
|
|
1313
|
-
| `columnDefinitions` | `ColumnDefinition` \| `Except`
|
|
1314
|
-
| `columnFilters` | `FilterRow`
|
|
1351
|
+
| `columnDefinitions` | `ColumnDefinition` \| `Except` | — | Определение внешнего вида и функционала колонок |
|
|
1352
|
+
| `columnFilters` | `FilterRow` | — | Фильтры |
|
|
1315
1353
|
| `columnVirtualizerInstanceRef` | `ColumnVirtualizer` | — | Ref на инстанс column-virtualizer'а для управления прокруткой снаружи |
|
|
1316
1354
|
| `columnVirtualizerOptions` | `Partial<VirtualizerOptions<HTMLElement, Element>>` | — | Дополнительные параметры column-virtualizer'а (`@tanstack/react-virtual`). <br/> Переопределяют дефолты (overscan=3). |
|
|
1317
1355
|
| `columnsSettings` | `{ enableDrag?: boolean; enableSettingsMenu?: boolean; } \| undefined` | — | Настройки колонок: `enableDrag` — переупорядочивание (заголовки таблицы и строки в меню настроек); <br/> `enableSettingsMenu` — меню показа колонок. |
|
|
@@ -1322,18 +1360,18 @@ export function ServerDriven() {
|
|
|
1322
1360
|
| `defaultView` | `"cards"` \| `"table"` | `'table' (на mobile — `cards`)` | Начальный режим отображения (uncontrolled). <br/> Если не задан — дефолт по раскладке: `table` на desktop, `cards` на mobile (`TABLE_LAYOUT_PRESETS`). |
|
|
1323
1361
|
| `enableColumnVirtualization` | `boolean` | `false` | Включает виртуализацию колонок (windowing по горизонтали). <br/> Рекомендуется при > 30 видимых колонок. Несовместимо с `view='cards'`. <br/> Pinned-колонки (left/right) всегда отрисовываются вне зависимости от настройки. |
|
|
1324
1362
|
| `enableFuzzySearch` | `boolean` | — | Включить нечеткий поиск |
|
|
1325
|
-
| `enableRowVirtualization` | `boolean` | `false` | Включает виртуализацию строк (windowing по вертикали). <br/> Рекомендуется при > 200 строк. Несовместимо с `view='cards'` — при картах игнорируется. |
|
|
1363
|
+
| `enableRowVirtualization` | `boolean` | `false` | Включает виртуализацию строк (windowing по вертикали). <br/> Рекомендуется при > 200 строк. Несовместимо с `view='cards'` — при картах игнорируется. <br/> 🔴 Требует `size` у колонок: виртуализованные строки позиционируются абсолютно и не участвуют в <br/> расчёте внутренней ширины, поэтому колонка без `size` делит ширину контейнера поровну с <br/> остальными вместо растягивания по содержимому. |
|
|
1326
1364
|
| `enableSelectPinned` | `boolean` | — | Параметр отвечает за чекбокс выбора закрепленных строк |
|
|
1327
1365
|
| `errorDataState` | `EmptyStateProps` | — | Экран при ошибке запроса |
|
|
1328
|
-
| `expanding` | `
|
|
1366
|
+
| `expanding` | `TreeColumnDefinitionProps` | — | Общие настройки раскрывающихся (tree) строк: `getSubRows`, `expandingColumnDefinition`, <br/> `initialState`, `state`, `onChange`. |
|
|
1329
1367
|
| `fullWidth` | `boolean` | `true` | Растягивать таблицу на всю ширину контейнера. <br/> При `false` ширина определяется суммой колонок (лучше всего, когда у всех колонок задан `size` / `width`). <br/> Явный проп = desktop-значение; на mobile всегда `true` (`TABLE_LAYOUT_PRESETS`). |
|
|
1330
|
-
| `getRowBackgroundColor` | `
|
|
1331
|
-
| `getRowId` | `TData` | — | Функция получения уникального идентификатора строки |
|
|
1368
|
+
| `getRowBackgroundColor` | `TableRowColor` | — | Функция определения цвета фона строки по её данным. <br/> Работает только в `view='table'` — карточки (`view='cards'`) не тонируются. <br/> @param data данные строки <br/> @returns цвет фона строки или `undefined` |
|
|
1369
|
+
| `getRowId` | `((originalRow: TData, index: number, parent?: Row<TData>) => string)` | — | Функция получения уникального идентификатора строки |
|
|
1332
1370
|
| `hasMore` | `undefined` | — | |
|
|
1333
1371
|
| `headerRowBackgroundColor` | `"blue"` \| `"green"` \| `"neutral"` \| `"orange"` \| `"pink"` \| `"red"` \| `"violet"` \| `"yellow"` | — | Accent-тон фона строки заголовков колонок (`tableHeadLine`). <br/> Работает только в `view='table'`. |
|
|
1334
1372
|
| `headlineId` | `string` | — | Id колонки, чей рендер используется как заголовок карточки в режиме `view='cards'`. <br/> Имеет смысл только при `view='cards'`. |
|
|
1335
1373
|
| `infiniteLoading` | `undefined` | — | |
|
|
1336
|
-
| `items` | `TData` | — | Данные для отрисовки |
|
|
1374
|
+
| `items` | `TData[]` | — | Данные для отрисовки |
|
|
1337
1375
|
| `keepPinnedRows` | `boolean` | `false` | Параметр отвечает за отображение закрепленных строк на всех страницах таблицы |
|
|
1338
1376
|
| `layoutPresets` | `LayoutPresets` \| `TableLayoutDefaults` | — | Override дефолтов адаптива для этого инстанса (`mergePresets` поверх `TABLE_LAYOUT_PRESETS`). <br/> `stickyControls` в пресете tier'а заменяет DS-объект целиком — указывайте все нужные поля. <br/> Escape-hatch: обычно не нужен — DS-пресет применяется автоматически по `AdaptiveProvider`. |
|
|
1339
1377
|
| `limit` | `number` | `10` | Кол-во строк на страницу |
|
|
@@ -1342,7 +1380,7 @@ export function ServerDriven() {
|
|
|
1342
1380
|
| `manualFiltering` | `boolean` | `true` | |
|
|
1343
1381
|
| `manualPagination` | `boolean` | `true` | |
|
|
1344
1382
|
| `manualSorting` | `boolean` | `true` | |
|
|
1345
|
-
| `moreActions` | `
|
|
1383
|
+
| `moreActions` | `ToolbarProps` | — | Элементы выпадающего списка кнопки с действиями |
|
|
1346
1384
|
| `noDataState` | `EmptyStateProps` | — | Экран при отсутствии данных |
|
|
1347
1385
|
| `noResultsState` | `EmptyStateProps` | — | Экран при отсутствии результатов поиска или фильтров |
|
|
1348
1386
|
| `offset` | `number` | `0` | Смещение |
|
|
@@ -1350,17 +1388,17 @@ export function ServerDriven() {
|
|
|
1350
1388
|
| `onExport` | `(() => void)` | — | Колбэк экспорта данных. Рендерит иконку в тулбаре перед настройками колонок. |
|
|
1351
1389
|
| `onLoadMore` | `undefined` | — | |
|
|
1352
1390
|
| `onRefresh` | `(() => void)` | — | Колбэк обновления данных |
|
|
1353
|
-
| `onRowClick` | `RowClickHandler`
|
|
1391
|
+
| `onRowClick` | `RowClickHandler` | — | Колбэк клика по строке |
|
|
1354
1392
|
| `onViewChange` | `((view: View) => void)` | — | Колбэк на смену режима отображения |
|
|
1355
1393
|
| `outline` | `boolean` | — | Внешний бордер для тулбара и таблицы |
|
|
1356
1394
|
| `pagination` | `{ options?: number[]; optionsLabel?: string; } \| undefined` | — | Параметры пагинации: `options`, `optionsLabel` |
|
|
1357
1395
|
| `renderCard` | `((context: RenderCardContext<TData>) => ReactNode)` | — | Кастомный рендер карточки в `view='cards'`. Получает контекст с tanstack <br/> `row` / `table` и `defaultRender` (готовый элемент дефолтной карточки — <br/> можно обернуть). Возврат заменяет дефолтную карточку. |
|
|
1358
1396
|
| `rowAutoHeight` | `boolean` | — | |
|
|
1359
1397
|
| `rowPinning` | `Pick<RowPinningState, "top">` | — | Определение, какие строки должны быть закреплены в таблице |
|
|
1360
|
-
| `rowSelection` | `RowAppearance`
|
|
1398
|
+
| `rowSelection` | `RowAppearance` | — | Параметры выбора строк: `initialState`, `state`, `enable`, `appearance`, `multiRow`, `onChange`. |
|
|
1361
1399
|
| `rowVirtualizerInstanceRef` | `RowVirtualizer` | — | Ref на инстанс row-virtualizer'а для управления прокруткой снаружи |
|
|
1362
1400
|
| `rowVirtualizerOptions` | `Partial<VirtualizerOptions<HTMLElement, Element>>` | — | Дополнительные параметры row-virtualizer'а (`@tanstack/react-virtual`). <br/> Переопределяют дефолты (overscan=10, estimateSize=40). |
|
|
1363
|
-
| `savedState` | `
|
|
1401
|
+
| `savedState` | `ToolbarPersistConfig` | — | Конфиг сохранения состояния в localStorage и queryParams. <br/> `id` должен быть уникальным для разных таблиц в рамках приложения. |
|
|
1364
1402
|
| `scrollContainerRef` | `RefObject<HTMLElement>` | — | Ссылка на контейнер, который скроллится |
|
|
1365
1403
|
| `scrollRef` | `Ref<HTMLElement>` | — | Ссылка на элемент, обозначающий самый конец прокручиваемого списка |
|
|
1366
1404
|
| `search` | `{ initialState?: string; state: string; placeholder?: string; loading?: boolean \| undefined; onChange(value: string): void; } \| undefined` | — | Параметры глобального поиска: `initialState`, `state`, `placeholder`, `loading`, `onChange`. |
|
|
@@ -1377,8 +1415,21 @@ export function ServerDriven() {
|
|
|
1377
1415
|
|
|
1378
1416
|
##### Related types
|
|
1379
1417
|
|
|
1418
|
+
**BulkAction**
|
|
1419
|
+
|
|
1420
|
+
| Prop | Type | Default | Description |
|
|
1421
|
+
|------|------|---------|-------------|
|
|
1422
|
+
| `data-test-id` | `string \| undefined` | — | |
|
|
1423
|
+
| `disabled` | `boolean \| undefined` | — | |
|
|
1424
|
+
| `icon` | `((props: { className?: string; }, deprecatedLegacyContext?: any) => ReactNode) \| (new (props: { className?: string; }, deprecatedLegacyContext?: any) => Component<any, any>)` | — | |
|
|
1425
|
+
| `label` | `string` | — | |
|
|
1426
|
+
| `onClick` | `((selectionState: RowSelectionState, resetRowSelection: (defaultState?: boolean) => void) => void) \| undefined` | — | |
|
|
1427
|
+
| `tooltip` | `TooltipProps` | — | |
|
|
1428
|
+
|
|
1380
1429
|
- `ColumnDefinition` = `NormalColumnDefinition<TData> | PinnedColumnDefinition<TData> | FilterableColumnDefinition<TData>`
|
|
1381
1430
|
|
|
1431
|
+
- `ColumnVirtualizer` = `Virtualizer<HTMLElement, Element> | null`
|
|
1432
|
+
|
|
1382
1433
|
**EmptyStateProps**
|
|
1383
1434
|
|
|
1384
1435
|
| Prop | Type | Default | Description |
|
|
@@ -1391,8 +1442,21 @@ export function ServerDriven() {
|
|
|
1391
1442
|
|
|
1392
1443
|
- `Except` = `{ [KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType]; }`
|
|
1393
1444
|
|
|
1445
|
+
- `RowAppearance` = `"disabled"` \| `"hide-toggler"`
|
|
1446
|
+
|
|
1394
1447
|
- `RowClickHandler` = `(e: MouseEvent<HTMLDivElement>, row: RowInfo<TData>) => void`
|
|
1395
1448
|
|
|
1449
|
+
- `RowVirtualizer` = `Virtualizer<HTMLElement, Element> | null`
|
|
1450
|
+
|
|
1451
|
+
**StickyControls**
|
|
1452
|
+
|
|
1453
|
+
| Prop | Type | Default | Description |
|
|
1454
|
+
|------|------|---------|-------------|
|
|
1455
|
+
| `backgroundPredefined` | `"blueBackground"` \| `"greenBackground"` \| `"neutralBackground"` \| `"neutralBackground1Level"` \| `"orangeBackground"` \| `"pinkBackground"` \| `"primaryBackground"` \| `"redBackground"` \| `"violetBackground"` \| `"yellowBackground"` | — | Подложка chrome-контролов (тулбар, header колонок, пагинация, плита table-view): <br/> слой backgroundPredefined + acrylic (см. `BACKGROUND_PREDEFINED_FILL` в `@cloud-ru/ds-materials`). |
|
|
1456
|
+
| `enabled` | `boolean \| undefined` | — | Включить sticky-хром при скролле страницы. |
|
|
1457
|
+
| `offsetBottom` | `number \| undefined` | — | Отступ снизу (px): высота внешнего sticky UI под таблицей (mobile tab bar). <br/> Только при `enabled: true`. |
|
|
1458
|
+
| `offsetTop` | `number \| undefined` | — | Отступ сверху (px): высота внешнего sticky UI над таблицей (app header, tabs). <br/> Только при `enabled: true`. |
|
|
1459
|
+
|
|
1396
1460
|
**StickyControlsLayoutDefaults**
|
|
1397
1461
|
|
|
1398
1462
|
| Prop | Type | Default | Description |
|
|
@@ -1409,6 +1473,8 @@ export function ServerDriven() {
|
|
|
1409
1473
|
| `fullWidth` | `boolean` | — | |
|
|
1410
1474
|
| `stickyControls` | `StickyControlsLayoutDefaults` | — | |
|
|
1411
1475
|
|
|
1476
|
+
- `TableRowColor` = `"blue"` \| `"green"` \| `"neutral"` \| `"orange"` \| `"pink"` \| `"red"` \| `"violet"` \| `"yellow"`
|
|
1477
|
+
|
|
1412
1478
|
- `TreeColumnDefinitionProps` = `TreeColumnDef | TreeColumnDefWithDescription<TData>`
|
|
1413
1479
|
|
|
1414
1480
|
- `View` = `"cards"` \| `"table"`
|
|
@@ -2417,7 +2483,7 @@ export function EntitiesTableWithFilters() {
|
|
|
2417
2483
|
| `defaultView` | `"cards"` \| `"table"` | `'table' (на mobile — `cards`)` | Начальный режим отображения (uncontrolled). <br/> Если не задан — дефолт по раскладке: `table` на desktop, `cards` на mobile (`TABLE_LAYOUT_PRESETS`). |
|
|
2418
2484
|
| `enableColumnVirtualization` | `boolean` | `false` | Включает виртуализацию колонок (windowing по горизонтали). <br/> Рекомендуется при > 30 видимых колонок. Несовместимо с `view='cards'`. <br/> Pinned-колонки (left/right) всегда отрисовываются вне зависимости от настройки. |
|
|
2419
2485
|
| `enableFuzzySearch` | `boolean` | — | Включить нечеткий поиск |
|
|
2420
|
-
| `enableRowVirtualization` | `boolean` | `false` | Включает виртуализацию строк (windowing по вертикали). <br/> Рекомендуется при > 200 строк. Несовместимо с `view='cards'` — при картах игнорируется. |
|
|
2486
|
+
| `enableRowVirtualization` | `boolean` | `false` | Включает виртуализацию строк (windowing по вертикали). <br/> Рекомендуется при > 200 строк. Несовместимо с `view='cards'` — при картах игнорируется. <br/> 🔴 Требует `size` у колонок: виртуализованные строки позиционируются абсолютно и не участвуют в <br/> расчёте внутренней ширины, поэтому колонка без `size` делит ширину контейнера поровну с <br/> остальными вместо растягивания по содержимому. |
|
|
2421
2487
|
| `enableSelectPinned` | `boolean` | — | Параметр отвечает за чекбокс выбора закрепленных строк |
|
|
2422
2488
|
| `errorDataState` | `EmptyStateProps` | — | Экран при ошибке запроса |
|
|
2423
2489
|
| `expanding` | `{ getSubRows: (element: T) => T[]; expandingColumnDefinition: TreeColumnDefinitionProps<T>; initialState?: ExpandedState; state?: ExpandedState \| undefined; onChange?(state: ExpandedState): void; } \| undefined` | — | Общие настройки раскрывающихся (tree) строк: `getSubRows`, `expandingColumnDefinition`, <br/> `initialState`, `state`, `onChange`. |
|
|
@@ -290,6 +290,11 @@ type BaseTableProps<TData extends object, TFilters extends FiltersState = Record
|
|
|
290
290
|
/**
|
|
291
291
|
* Включает виртуализацию строк (windowing по вертикали).
|
|
292
292
|
* Рекомендуется при > 200 строк. Несовместимо с `view='cards'` — при картах игнорируется.
|
|
293
|
+
*
|
|
294
|
+
* 🔴 Требует `size` у колонок: виртуализованные строки позиционируются абсолютно и не участвуют в
|
|
295
|
+
* расчёте внутренней ширины, поэтому колонка без `size` делит ширину контейнера поровну с
|
|
296
|
+
* остальными вместо растягивания по содержимому.
|
|
297
|
+
*
|
|
293
298
|
* @default false
|
|
294
299
|
*/
|
|
295
300
|
enableRowVirtualization?: boolean;
|
|
@@ -29,6 +29,20 @@ function getResizeIndicatorOffset({ header, cellRef }) {
|
|
|
29
29
|
function ResizeHandle({ header, cellRef }) {
|
|
30
30
|
const isResizing = header.column.getIsResizing();
|
|
31
31
|
const resizeHandler = header.getResizeHandler();
|
|
32
|
+
const { table } = header.getContext();
|
|
33
|
+
// У колонки без `size` нет записи в columnSizing, и tanstack стартует перетаскивание от дефолта
|
|
34
|
+
// columnDef (150px), а не от отрисованной ширины. Реальная ширина фиксируется заранее, на
|
|
35
|
+
// наведении: к моменту mousedown состояние уже применено.
|
|
36
|
+
const pinRenderedWidth = () => {
|
|
37
|
+
const id = header.column.id;
|
|
38
|
+
if (table.getState().columnSizing[id] !== undefined) {
|
|
39
|
+
return;
|
|
40
|
+
}
|
|
41
|
+
const rendered = cellRef.current?.offsetWidth;
|
|
42
|
+
if (rendered) {
|
|
43
|
+
table.setColumnSizing(prev => ({ ...prev, [id]: rendered }));
|
|
44
|
+
}
|
|
45
|
+
};
|
|
32
46
|
const handleMouseDown = (event) => {
|
|
33
47
|
if (event.detail === 2) {
|
|
34
48
|
header.column.resetSize();
|
|
@@ -37,5 +51,5 @@ function ResizeHandle({ header, cellRef }) {
|
|
|
37
51
|
resizeHandler(event);
|
|
38
52
|
};
|
|
39
53
|
const offset = isResizing ? getResizeIndicatorOffset({ header, cellRef }) : 0;
|
|
40
|
-
return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("div", { "aria-hidden": true, className: (0, classnames_1.default)(styles_module_scss_1.default.tableHeaderIcon, styles_module_scss_1.default.tableHeaderResizeHandle), "data-resizing": isResizing || undefined, onMouseDown: handleMouseDown, onTouchStart: resizeHandler, onMouseUp: helpers_1.stopEventPropagation }), isResizing && ((0, jsx_runtime_1.jsx)("div", { "data-test-id": constants_1.TEST_IDS.headerResizeHandleMovingPart, className: styles_module_scss_1.default.tableHeaderResizeIndicator, style: { '--offset': `${offset}px` } }))] }));
|
|
54
|
+
return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)("div", { "aria-hidden": true, className: (0, classnames_1.default)(styles_module_scss_1.default.tableHeaderIcon, styles_module_scss_1.default.tableHeaderResizeHandle), "data-resizing": isResizing || undefined, onMouseEnter: pinRenderedWidth, onMouseDown: handleMouseDown, onTouchStart: resizeHandler, onMouseUp: helpers_1.stopEventPropagation }), isResizing && ((0, jsx_runtime_1.jsx)("div", { "data-test-id": constants_1.TEST_IDS.headerResizeHandleMovingPart, className: styles_module_scss_1.default.tableHeaderResizeIndicator, style: { '--offset': `${offset}px` } }))] }));
|
|
41
55
|
}
|
|
@@ -290,6 +290,11 @@ type BaseTableProps<TData extends object, TFilters extends FiltersState = Record
|
|
|
290
290
|
/**
|
|
291
291
|
* Включает виртуализацию строк (windowing по вертикали).
|
|
292
292
|
* Рекомендуется при > 200 строк. Несовместимо с `view='cards'` — при картах игнорируется.
|
|
293
|
+
*
|
|
294
|
+
* 🔴 Требует `size` у колонок: виртуализованные строки позиционируются абсолютно и не участвуют в
|
|
295
|
+
* расчёте внутренней ширины, поэтому колонка без `size` делит ширину контейнера поровну с
|
|
296
|
+
* остальными вместо растягивания по содержимому.
|
|
297
|
+
*
|
|
293
298
|
* @default false
|
|
294
299
|
*/
|
|
295
300
|
enableRowVirtualization?: boolean;
|
|
@@ -23,6 +23,20 @@ function getResizeIndicatorOffset({ header, cellRef }) {
|
|
|
23
23
|
export function ResizeHandle({ header, cellRef }) {
|
|
24
24
|
const isResizing = header.column.getIsResizing();
|
|
25
25
|
const resizeHandler = header.getResizeHandler();
|
|
26
|
+
const { table } = header.getContext();
|
|
27
|
+
// У колонки без `size` нет записи в columnSizing, и tanstack стартует перетаскивание от дефолта
|
|
28
|
+
// columnDef (150px), а не от отрисованной ширины. Реальная ширина фиксируется заранее, на
|
|
29
|
+
// наведении: к моменту mousedown состояние уже применено.
|
|
30
|
+
const pinRenderedWidth = () => {
|
|
31
|
+
const id = header.column.id;
|
|
32
|
+
if (table.getState().columnSizing[id] !== undefined) {
|
|
33
|
+
return;
|
|
34
|
+
}
|
|
35
|
+
const rendered = cellRef.current?.offsetWidth;
|
|
36
|
+
if (rendered) {
|
|
37
|
+
table.setColumnSizing(prev => ({ ...prev, [id]: rendered }));
|
|
38
|
+
}
|
|
39
|
+
};
|
|
26
40
|
const handleMouseDown = (event) => {
|
|
27
41
|
if (event.detail === 2) {
|
|
28
42
|
header.column.resetSize();
|
|
@@ -31,5 +45,5 @@ export function ResizeHandle({ header, cellRef }) {
|
|
|
31
45
|
resizeHandler(event);
|
|
32
46
|
};
|
|
33
47
|
const offset = isResizing ? getResizeIndicatorOffset({ header, cellRef }) : 0;
|
|
34
|
-
return (_jsxs(_Fragment, { children: [_jsx("div", { "aria-hidden": true, className: cn(styles.tableHeaderIcon, styles.tableHeaderResizeHandle), "data-resizing": isResizing || undefined, onMouseDown: handleMouseDown, onTouchStart: resizeHandler, onMouseUp: stopEventPropagation }), isResizing && (_jsx("div", { "data-test-id": TEST_IDS.headerResizeHandleMovingPart, className: styles.tableHeaderResizeIndicator, style: { '--offset': `${offset}px` } }))] }));
|
|
48
|
+
return (_jsxs(_Fragment, { children: [_jsx("div", { "aria-hidden": true, className: cn(styles.tableHeaderIcon, styles.tableHeaderResizeHandle), "data-resizing": isResizing || undefined, onMouseEnter: pinRenderedWidth, onMouseDown: handleMouseDown, onTouchStart: resizeHandler, onMouseUp: stopEventPropagation }), isResizing && (_jsx("div", { "data-test-id": TEST_IDS.headerResizeHandleMovingPart, className: styles.tableHeaderResizeIndicator, style: { '--offset': `${offset}px` } }))] }));
|
|
35
49
|
}
|