@cloud-ru/ds-table 1.1.1-preview-494c465d.0 → 1.2.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/CHANGELOG.md +6 -0
- package/README.md +38 -2
- package/dist/cjs/components/Table/hooks/useTableToolbar.js +2 -0
- package/dist/cjs/components/types.d.ts +4 -2
- package/dist/esm/components/Table/hooks/useTableToolbar.js +2 -0
- package/dist/esm/components/types.d.ts +4 -2
- package/dist/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/tsconfig.esm.tsbuildinfo +1 -1
- package/package.json +20 -20
- package/src/components/Table/hooks/useTableToolbar.ts +2 -0
- package/src/components/types.ts +4 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# 1.2.0 (2026-09-28)
|
|
7
|
+
|
|
8
|
+
### Features
|
|
9
|
+
|
|
10
|
+
- **FF-9021:** add state storage prop ([ea2b24f](https://github.com/cloud-ru-tech/snack-v2/commit/ea2b24fc1c7525aa92074c7821b809937b69a22e))
|
|
11
|
+
|
|
6
12
|
# 1.1.0 (2026-09-25)
|
|
7
13
|
|
|
8
14
|
### Bug Fixes
|
package/README.md
CHANGED
|
@@ -976,7 +976,7 @@ export function FullWidth() {
|
|
|
976
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` | `ToolbarPersistConfig` | — | Конфиг сохранения
|
|
979
|
+
| `savedState` | `ToolbarPersistConfig` | — | Конфиг сохранения фильтров, поиска, пагинации и сортировки в выбранных хранилищах. <br/> По умолчанию URL и localStorage; storages: [] отключает сохранение этого состояния. <br/> Для сохранения необходимы id и filterQueryKey. Изменение storages после монтирования не поддерживается. <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`. |
|
|
@@ -1062,6 +1062,7 @@ export function FullWidth() {
|
|
|
1062
1062
|
- **ServerTable** — постраничные данные с бэкенда.
|
|
1063
1063
|
- **Pagination** — отдельный компонент пагинации.
|
|
1064
1064
|
- **InfoBlock** — основа пустых состояний таблицы.
|
|
1065
|
+
|
|
1065
1066
|
### Адаптивность
|
|
1066
1067
|
|
|
1067
1068
|
`Table` — адаптивный компонент класса preset-defaults: DOM один, по раскладке меняются только дефолты пропсов. Раскладку компонент читает из контекста **`@cloud-ru/ds-adaptive`** — отдельного пропа `layoutType` нет.
|
|
@@ -1133,6 +1134,41 @@ const MobileTable = withLayoutType(Table, 'mobile');
|
|
|
1133
1134
|
|
|
1134
1135
|
Подробнее о модели раскладки — в **`@cloud-ru/ds-adaptive`**.
|
|
1135
1136
|
|
|
1137
|
+
### Хранилища состояния
|
|
1138
|
+
|
|
1139
|
+
`savedState.storages` задаёт хранилища общего объекта: фильтров, поиска, пагинации и сортировки.
|
|
1140
|
+
Для сохранения и восстановления необходимы одновременно `id` и `filterQueryKey`, даже если URL отключён.
|
|
1141
|
+
|
|
1142
|
+
```tsx
|
|
1143
|
+
savedState={{
|
|
1144
|
+
id: 'orders',
|
|
1145
|
+
filterQueryKey: 'ordersState',
|
|
1146
|
+
storages: ['queryParams', 'sessionStorage'],
|
|
1147
|
+
}}
|
|
1148
|
+
```
|
|
1149
|
+
|
|
1150
|
+
| Значение `storages` | Результат |
|
|
1151
|
+
| --- | --- |
|
|
1152
|
+
| Не задано | URL и localStorage — прежнее поведение |
|
|
1153
|
+
| `['queryParams']` | Только URL |
|
|
1154
|
+
| `['localStorage']` | Только localStorage |
|
|
1155
|
+
| `['sessionStorage']` | Только sessionStorage |
|
|
1156
|
+
| `['queryParams', 'sessionStorage']` | URL и sessionStorage |
|
|
1157
|
+
| `[]` | Сохранение и восстановление отключены |
|
|
1158
|
+
|
|
1159
|
+
При восстановлении используется первый валидный объект целиком: URL → sessionStorage → localStorage.
|
|
1160
|
+
Отключённые источники не читаются и не изменяются. Порядок списка не влияет на приоритет, повторы игнорируются.
|
|
1161
|
+
Если данных нет или они невалидны, сохраняется исходное состояние компонента.
|
|
1162
|
+
|
|
1163
|
+
localStorage и sessionStorage используют ключ `${id}_filter` и JSON.
|
|
1164
|
+
Пользовательские `parser` и `serializer` применяются только к URL, ключ которого задаёт `filterQueryKey`.
|
|
1165
|
+
Ошибка одного источника не препятствует работе остальных.
|
|
1166
|
+
Сброс фильтров или поиска записывает обновлённое состояние; старые и отключённые хранилища не очищаются.
|
|
1167
|
+
|
|
1168
|
+
Конфигурация задаётся при монтировании. Переключение хранилищ после монтирования не поддерживается.
|
|
1169
|
+
|
|
1170
|
+
Настройка не влияет на сохранение ширины, порядка и видимости колонок.
|
|
1171
|
+
|
|
1136
1172
|
## ServerTable
|
|
1137
1173
|
|
|
1138
1174
|
Таблица для серверных данных: постраничная загрузка items/total/limit/offset, controlled-поиск и серверная сортировка.
|
|
@@ -1398,7 +1434,7 @@ export function ServerDriven() {
|
|
|
1398
1434
|
| `rowSelection` | `RowAppearance` | — | Параметры выбора строк: `initialState`, `state`, `enable`, `appearance`, `multiRow`, `onChange`. |
|
|
1399
1435
|
| `rowVirtualizerInstanceRef` | `RowVirtualizer` | — | Ref на инстанс row-virtualizer'а для управления прокруткой снаружи |
|
|
1400
1436
|
| `rowVirtualizerOptions` | `Partial<VirtualizerOptions<HTMLElement, Element>>` | — | Дополнительные параметры row-virtualizer'а (`@tanstack/react-virtual`). <br/> Переопределяют дефолты (overscan=10, estimateSize=40). |
|
|
1401
|
-
| `savedState` | `ToolbarPersistConfig` | — | Конфиг сохранения
|
|
1437
|
+
| `savedState` | `ToolbarPersistConfig` | — | Конфиг сохранения фильтров, поиска, пагинации и сортировки в выбранных хранилищах. <br/> По умолчанию URL и localStorage; storages: [] отключает сохранение этого состояния. <br/> Для сохранения необходимы id и filterQueryKey. Изменение storages после монтирования не поддерживается. <br/> `id` должен быть уникальным для разных таблиц в рамках приложения. |
|
|
1402
1438
|
| `scrollContainerRef` | `RefObject<HTMLElement>` | — | Ссылка на контейнер, который скроллится |
|
|
1403
1439
|
| `scrollRef` | `Ref<HTMLElement>` | — | Ссылка на элемент, обозначающий самый конец прокручиваемого списка |
|
|
1404
1440
|
| `search` | `{ initialState?: string; state: string; placeholder?: string; loading?: boolean \| undefined; onChange(value: string): void; } \| undefined` | — | Параметры глобального поиска: `initialState`, `state`, `placeholder`, `loading`, `onChange`. |
|
|
@@ -32,6 +32,7 @@ function useTableToolbar({ table, columnDefinitions, sortingProp, savedState, co
|
|
|
32
32
|
}
|
|
33
33
|
return {
|
|
34
34
|
id: savedState.id,
|
|
35
|
+
storages: savedState.storages,
|
|
35
36
|
filterQueryKey: savedState.filterQueryKey,
|
|
36
37
|
validateData: validatePersistedState,
|
|
37
38
|
state: {
|
|
@@ -63,6 +64,7 @@ function useTableToolbar({ table, columnDefinitions, sortingProp, savedState, co
|
|
|
63
64
|
savedState?.id,
|
|
64
65
|
savedState?.parser,
|
|
65
66
|
savedState?.serializer,
|
|
67
|
+
savedState?.storages,
|
|
66
68
|
setFilter,
|
|
67
69
|
setFilterVisibility,
|
|
68
70
|
sorting,
|
|
@@ -266,10 +266,12 @@ type BaseTableProps<TData extends object, TFilters extends FiltersState = Record
|
|
|
266
266
|
/** Определение, какие строки должны быть закреплены в таблице */
|
|
267
267
|
rowPinning?: Pick<RowPinningState, 'top'>;
|
|
268
268
|
/**
|
|
269
|
-
* Конфиг сохранения
|
|
269
|
+
* Конфиг сохранения фильтров, поиска, пагинации и сортировки в выбранных хранилищах.
|
|
270
|
+
* По умолчанию URL и localStorage; storages: [] отключает сохранение этого состояния.
|
|
271
|
+
* Для сохранения необходимы id и filterQueryKey. Изменение storages после монтирования не поддерживается.
|
|
270
272
|
* `id` должен быть уникальным для разных таблиц в рамках приложения.
|
|
271
273
|
*/
|
|
272
|
-
savedState?: Pick<ToolbarPersistConfig<TFilters>, 'serializer' | 'parser'> & {
|
|
274
|
+
savedState?: Pick<ToolbarPersistConfig<TFilters>, 'serializer' | 'parser' | 'storages'> & {
|
|
273
275
|
id: string;
|
|
274
276
|
filterQueryKey?: string;
|
|
275
277
|
resize?: boolean;
|
|
@@ -29,6 +29,7 @@ export function useTableToolbar({ table, columnDefinitions, sortingProp, savedSt
|
|
|
29
29
|
}
|
|
30
30
|
return {
|
|
31
31
|
id: savedState.id,
|
|
32
|
+
storages: savedState.storages,
|
|
32
33
|
filterQueryKey: savedState.filterQueryKey,
|
|
33
34
|
validateData: validatePersistedState,
|
|
34
35
|
state: {
|
|
@@ -60,6 +61,7 @@ export function useTableToolbar({ table, columnDefinitions, sortingProp, savedSt
|
|
|
60
61
|
savedState?.id,
|
|
61
62
|
savedState?.parser,
|
|
62
63
|
savedState?.serializer,
|
|
64
|
+
savedState?.storages,
|
|
63
65
|
setFilter,
|
|
64
66
|
setFilterVisibility,
|
|
65
67
|
sorting,
|
|
@@ -266,10 +266,12 @@ type BaseTableProps<TData extends object, TFilters extends FiltersState = Record
|
|
|
266
266
|
/** Определение, какие строки должны быть закреплены в таблице */
|
|
267
267
|
rowPinning?: Pick<RowPinningState, 'top'>;
|
|
268
268
|
/**
|
|
269
|
-
* Конфиг сохранения
|
|
269
|
+
* Конфиг сохранения фильтров, поиска, пагинации и сортировки в выбранных хранилищах.
|
|
270
|
+
* По умолчанию URL и localStorage; storages: [] отключает сохранение этого состояния.
|
|
271
|
+
* Для сохранения необходимы id и filterQueryKey. Изменение storages после монтирования не поддерживается.
|
|
270
272
|
* `id` должен быть уникальным для разных таблиц в рамках приложения.
|
|
271
273
|
*/
|
|
272
|
-
savedState?: Pick<ToolbarPersistConfig<TFilters>, 'serializer' | 'parser'> & {
|
|
274
|
+
savedState?: Pick<ToolbarPersistConfig<TFilters>, 'serializer' | 'parser' | 'storages'> & {
|
|
273
275
|
id: string;
|
|
274
276
|
filterQueryKey?: string;
|
|
275
277
|
resize?: boolean;
|