@snack-uikit/table 0.11.4 → 0.11.6-preview-a0815a00.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 CHANGED
@@ -3,6 +3,15 @@
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
+ ## 0.11.5 (2024-02-02)
7
+
8
+ ### Only dependencies have been changed
9
+ * [@snack-uikit/chips@0.10.9](https://github.com/cloud-ru-tech/snack-uikit/blob/master/packages/chips/CHANGELOG.md)
10
+
11
+
12
+
13
+
14
+
6
15
  ## 0.11.4 (2024-02-02)
7
16
 
8
17
  ### Only dependencies have been changed
package/README.md CHANGED
@@ -107,7 +107,7 @@ const columnDefinitions: ColumnDefinition<TableData>[] = [
107
107
  | data* | `TData[]` | - | Данные для отрисовки |
108
108
  | sorting | `{ initialState?: SortingState; state?: SortingState; onChange?(state: SortingState): void; }` | - | Параметры отвечают за возможность сортировки, их стоит использовать если нужно отслеживать состояние <br> <strong>initialState</strong>: Начальное состояние сортировки <br> <strong>state</strong>: Состояние сортировки, жестко устанавливаемое снаружи <br> <strong>onChange</strong>: Колбэк на изменение сортировки |
109
109
  | rowSelection | `{ initialState?: RowSelectionState; state?: RowSelectionState; enable?: boolean \| ((row: Row<TData>) => boolean); multiRow?: boolean; onChange?(state: RowSelectionState): void; }` | - | Параметры отвечают за возможность выбора строк <br> <strong>initialState</strong>: Начальное состояние выбора строк <br> <strong>state</strong>: Состояние выбора строк, жестко устанавливаемое снаружи <br> <strong>enable</strong>: Колбэк определяющий можно ли выбрать строку <br> <strong>multiRow</strong>: Мульти-выбор строк (включен по-умолчанию, когда включается выбор) <br> <strong>onChange</strong>: Колбэк на выбор строк |
110
- | search | `{ initialValue?: string; state?: string; placeholder?: string; loading?: boolean; onChange?(value: string): void; }` | 'Search'<br> <strong>loading</strong>: Состояние загрузки в строке поиска <br> <strong>onChange</strong>: Колбэк на изменение данных в строке поиска | Параметры отвечают за глобальный поиск в таблице <br> <strong>initialState</strong>: Начальное состояние строки поиска <br> <strong>state</strong>: Состояние строки поиска, жестко устанавливаемое снаружи <br> <strong>placeholder</strong>: Placeholder строки поиска |
110
+ | search | `{ initialValue?: string; state?: string; placeholder?: string; loading?: boolean; onChange?(value: string): void; disableDefaultSearch?: boolean; }` | 'Search'<br> <strong>loading</strong>: Состояние загрузки в строке поиска <br> <strong>onChange</strong>: Колбэк на изменение данных в строке поиска | Параметры отвечают за глобальный поиск в таблице <br> <strong>initialState</strong>: Начальное состояние строки поиска <br> <strong>state</strong>: Состояние строки поиска, жестко устанавливаемое снаружи <br> <strong>placeholder</strong>: Placeholder строки поиска |
111
111
  | pageSize | `number` | 10 | Максимальное кол-во строк на страницу |
112
112
  | pagination | `{ state?: PaginationState; options?: number[]; optionsLabel?: string; onChange?(state: PaginationState): void; }` | 'Rows volume: ' <br> <strong>onChange</strong>: Колбэк на изменение пагинации | Параметры отвечают за пагинацию в таблице <br> <strong>state</strong>: Состояние строки поиска, жестко устанавливаемое снаружи <br> <strong>options</strong>: Варианты в выпадающем селекторе для установки кол-ва строк на страницу <br> <strong>optionsLabel</strong>: Текст для селектора кол-ва строк на страницу |
113
113
  | pageCount | `number` | - | Кол-во страниц (используется для внешнего управления) |
@@ -144,6 +144,52 @@ const columnDefinitions: ColumnDefinition<TableData>[] = [
144
144
  |------|------|---------------|-------------|
145
145
  | actionsGenerator* | `ActionsGenerator<TData>` | - | Действия для строки |
146
146
  | pinned | `boolean` | - | Закрепление колонки справа в таблице |
147
+ ## ServerTable
148
+ ### Props
149
+ | name | type | default value | description |
150
+ |------|------|---------------|-------------|
151
+ | onRefresh* | `() => void` | - | Колбек обновления данных |
152
+ | search* | `{ initialValue?: string; state: string; placeholder?: string; loading?: boolean; onChange(value: string): void; }` | 'Search...'<br> <strong>loading</strong>: Состояние загрузки в строке поиска <br> <strong>onChange</strong>: Колбэк на изменение данных в строке поиска | Параметры отвечают за глобальный поиск в таблице <br> <strong>initialState</strong>: Начальное состояние строки поиска <br> <strong>state</strong>: Состояние строки поиска, жестко устанавливаемое снаружи <br> <strong>placeholder</strong>: Placeholder строки поиска |
153
+ | columnDefinitions* | `ColumnDefinition<TData>[]` | - | Определение внешнего вида и функционала колонок |
154
+ | onChangePage* | `(offset: number, limit: number) => void` | - | |
155
+ | items | `TData[]` | - | Данные для отрисовки |
156
+ | total | `number` | 10 | Общее кол-во строк |
157
+ | limit | `number` | 10 | Кол-во строк на страницу |
158
+ | offset | `number` | - | Смещение |
159
+ | sorting | `{ initialState?: SortingState; state: SortingState; onChange(state: SortingState): void; }` | - | Параметры отвечают за возможность сортировки, их стоит использовать если нужно отслеживать состояние <br> <strong>initialState</strong>: Начальное состояние сортировки <br> <strong>state</strong>: Состояние сортировки, жестко устанавливаемое снаружи <br> <strong>onChange</strong>: Колбэк на изменение сортировки |
160
+ | rowSelection | `{ initialState?: RowSelectionState; state: RowSelectionState; enable?: boolean \| ((row: Row<TData>) => boolean); multiRow?: boolean; onChange(state: RowSelectionState): void; }` | - | Параметры отвечают за возможность выбора строк <br> <strong>initialState</strong>: Начальное состояние выбора строк <br> <strong>state</strong>: Состояние выбора строк, жестко устанавливаемое снаружи <br> <strong>enable</strong>: Колбэк определяющий можно ли выбрать строку <br> <strong>multiRow</strong>: Мульти-выбор строк (включен по-умолчанию, когда включается выбор) <br> <strong>onChange</strong>: Колбэк на выбор строк |
161
+ | pagination | `{ options?: number[]; optionsLabel?: string; }` | 'Rows volume' <br> | Параметры отвечают за пагинацию в таблице <br> <strong>options</strong>: Варианты в выпадающем селекторе для установки кол-ва строк на страницу<br> <strong>optionsLabel</strong>: Текст для селектора кол-ва строк на страницу |
162
+ | onRowClick | `RowClickHandler<TData>` | - | Колбэк клика по строке |
163
+ | className | `string` | - | CSS-класс |
164
+ | loading | `boolean` | - | Состояние загрузки |
165
+ | onDelete | `(selectionState: RowSelectionState, resetRowSelection: (defaultState?: boolean) => void) => void` | - | Колбек удаления выбранных |
166
+ | outline | `boolean` | - | Внешний бордер для тулбара и таблицы |
167
+ | columnFilters | `ReactNode` | - | Фильтры |
168
+ | exportFileName | `string` | - | Название файла при экспорте CSV/XLSX |
169
+ | moreActions | `Action[]` | - | Элементы выпадающего списка кнопки с действиями |
170
+ | noDataState | `TableEmptyStateProps` | - | Экран при отстутствии данных |
171
+ | noResultsState | `TableEmptyStateProps` | - | Экран при отстутствии результатов поиска |
172
+ | suppressToolbar | `boolean` | - | Отключение тулбара |
173
+ | suppressPagination | `boolean` | - | Отключение пагинации |
174
+ ## ServerTable.getRowActionsColumnDef
175
+ Вспомогательная функция для создания ячейки с дополнительными действиями у строки
176
+ ### Props
177
+ | name | type | default value | description |
178
+ |------|------|---------------|-------------|
179
+ | actionsGenerator* | `ActionsGenerator<TData>` | - | Действия для строки |
180
+ | pinned | `boolean` | - | Закрепление колонки справа в таблице |
181
+ ## ServerTable.getStatusColumnDef
182
+ Вспомогательная функция для создания ячейки со статусом
183
+ ### Props
184
+ | name | type | default value | description |
185
+ |------|------|---------------|-------------|
186
+ | mapStatusToAppearance* | `(value: string \| number) => StatusAppearance` | - | Маппинг значений статуса на цвета |
187
+ | accessorKey* | `string` | - | Имя ключа соответствующее полю в data |
188
+ | enableSorting | `boolean` | - | Включение/выключение сортировки |
189
+ | renderDescription | `(cellValue: string) => string` | - | Функция для отрисовки текста, если не передана, то будет отрисован только индикатор статуса |
190
+ | size | `number` | - | Размер ячейки |
191
+ | header | `ColumnDefTemplate<HeaderContext<TData, unknown>> & (string \| ((ctx: HeaderContext<TData, unknown>) => string))` | - | Заголовок колонки |
192
+ | enableResizing | `boolean` | - | Включение/выключение ресайза колонки |
147
193
  ## exportToCSV
148
194
  ### Props
149
195
  | name | type | default value | description |
@@ -0,0 +1,93 @@
1
+ import { ReactNode } from 'react';
2
+ import { WithSupportProps } from '@snack-uikit/utils';
3
+ import { ColumnDefinition, RowClickHandler, RowSelectionOptions, RowSelectionState, SortingState, TableEmptyStateProps, ToolbarProps } from '../../types';
4
+ export type ServerTableProps<TData extends object> = WithSupportProps<{
5
+ /** Данные для отрисовки */
6
+ items?: TData[];
7
+ /** Общее кол-во строк @default 10 */
8
+ total?: number;
9
+ /** Кол-во строк на страницу @default 10 */
10
+ limit?: number;
11
+ /** Смещение @default 0 */
12
+ offset?: number;
13
+ onChangePage(offset: number, limit: number): void;
14
+ /** Определение внешнего вида и функционала колонок */
15
+ columnDefinitions: ColumnDefinition<TData>[];
16
+ /** Параметры отвечают за возможность сортировки, их стоит использовать если нужно отслеживать состояние <br>
17
+ * <strong>initialState</strong>: Начальное состояние сортировки <br>
18
+ * <strong>state</strong>: Состояние сортировки, жестко устанавливаемое снаружи <br>
19
+ * <strong>onChange</strong>: Колбэк на изменение сортировки
20
+ * */
21
+ sorting?: {
22
+ initialState?: SortingState;
23
+ state: SortingState;
24
+ onChange(state: SortingState): void;
25
+ };
26
+ /** Параметры отвечают за возможность выбора строк <br>
27
+ * <strong>initialState</strong>: Начальное состояние выбора строк <br>
28
+ * <strong>state</strong>: Состояние выбора строк, жестко устанавливаемое снаружи <br>
29
+ * <strong>enable</strong>: Колбэк определяющий можно ли выбрать строку <br>
30
+ * <strong>multiRow</strong>: Мульти-выбор строк (включен по-умолчанию, когда включается выбор) <br>
31
+ * <strong>onChange</strong>: Колбэк на выбор строк
32
+ * */
33
+ rowSelection?: {
34
+ initialState?: RowSelectionState;
35
+ state: RowSelectionState;
36
+ enable?: RowSelectionOptions<TData>['enableRowSelection'];
37
+ multiRow?: boolean;
38
+ onChange(state: RowSelectionState): void;
39
+ };
40
+ /** Параметры отвечают за глобальный поиск в таблице <br>
41
+ * <strong>initialState</strong>: Начальное состояние строки поиска <br>
42
+ * <strong>state</strong>: Состояние строки поиска, жестко устанавливаемое снаружи <br>
43
+ * <strong>placeholder</strong>: Placeholder строки поиска @default 'Search...'<br>
44
+ * <strong>loading</strong>: Состояние загрузки в строке поиска <br>
45
+ * <strong>onChange</strong>: Колбэк на изменение данных в строке поиска
46
+ * */
47
+ search: {
48
+ initialValue?: string;
49
+ state: string;
50
+ placeholder?: string;
51
+ loading?: boolean;
52
+ onChange(value: string): void;
53
+ };
54
+ /** Параметры отвечают за пагинацию в таблице <br>
55
+ * <strong>options</strong>: Варианты в выпадающем селекторе для установки кол-ва строк на страницу<br>
56
+ * <strong>optionsLabel</strong>: Текст для селектора кол-ва строк на страницу @default 'Rows volume' <br>
57
+ * */
58
+ pagination?: {
59
+ options?: number[];
60
+ optionsLabel?: string;
61
+ };
62
+ /** Колбэк клика по строке */
63
+ onRowClick?: RowClickHandler<TData>;
64
+ /** CSS-класс */
65
+ className?: string;
66
+ /** Состояние загрузки */
67
+ loading?: boolean;
68
+ /** Колбек обновления данных */
69
+ onRefresh(): void;
70
+ /** Колбек удаления выбранных */
71
+ onDelete?(selectionState: RowSelectionState, resetRowSelection: (defaultState?: boolean) => void): void;
72
+ /** Внешний бордер для тулбара и таблицы*/
73
+ outline?: boolean;
74
+ /** Фильтры*/
75
+ columnFilters?: ReactNode;
76
+ /** Название файла при экспорте CSV/XLSX*/
77
+ exportFileName?: string;
78
+ /** Элементы выпадающего списка кнопки с действиями */
79
+ moreActions?: ToolbarProps['moreActions'];
80
+ /** Экран при отстутствии данных */
81
+ noDataState?: TableEmptyStateProps;
82
+ /** Экран при отстутствии результатов поиска */
83
+ noResultsState?: TableEmptyStateProps;
84
+ /** Отключение тулбара */
85
+ suppressToolbar?: boolean;
86
+ /** Отключение пагинации */
87
+ suppressPagination?: boolean;
88
+ }>;
89
+ export declare function ServerTable<TData extends object>({ items, total, limit, offset, onChangePage, search, pagination, columnFilters, ...rest }: ServerTableProps<TData>): import("react/jsx-runtime").JSX.Element;
90
+ export declare namespace ServerTable {
91
+ var getRowActionsColumnDef: typeof import("../../helperComponents").getRowActionsColumnDef;
92
+ var getStatusColumnDef: typeof import("../../helperComponents").getStatusColumnDef;
93
+ }
@@ -0,0 +1,43 @@
1
+ var __rest = (this && this.__rest) || function (s, e) {
2
+ var t = {};
3
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
4
+ t[p] = s[p];
5
+ if (s != null && typeof Object.getOwnPropertySymbols === "function")
6
+ for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
7
+ if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
8
+ t[p[i]] = s[p[i]];
9
+ }
10
+ return t;
11
+ };
12
+ import { jsx as _jsx } from "react/jsx-runtime";
13
+ import debounce from 'lodash.debounce';
14
+ import { useCallback, useMemo, useState } from 'react';
15
+ import { Table } from '../Table';
16
+ import { DEFAULT_PAGINATION_LIMIT, SEARCH_DELAY } from './constants';
17
+ export function ServerTable(_a) {
18
+ var { items, total = DEFAULT_PAGINATION_LIMIT, limit = DEFAULT_PAGINATION_LIMIT, offset = 0, onChangePage, search, pagination, columnFilters } = _a, rest = __rest(_a, ["items", "total", "limit", "offset", "onChangePage", "search", "pagination", "columnFilters"]);
19
+ const [tempSearch, setTempSearch] = useState(search.initialValue || '');
20
+ const onSearchDebounced = useMemo(() => debounce((newValue, onChange) => {
21
+ onChange(newValue);
22
+ }, SEARCH_DELAY), []);
23
+ const handleSearch = useCallback((newValue) => {
24
+ setTempSearch(newValue);
25
+ onSearchDebounced(newValue.trim(), search.onChange);
26
+ },
27
+ // eslint-disable-next-line react-hooks/exhaustive-deps
28
+ [limit, onSearchDebounced]);
29
+ const handlePageChange = useCallback(({ pageSize, pageIndex }) => onChangePage(pageIndex * pageSize, pageSize), [onChangePage]);
30
+ const pageIndex = useMemo(() => Math.floor(offset / limit), [limit, offset]);
31
+ const pageCount = useMemo(() => Math.ceil(total / limit), [limit, total]);
32
+ return (_jsx(Table, Object.assign({ data: items || [], search: {
33
+ state: tempSearch,
34
+ onChange: handleSearch,
35
+ loading: search.loading,
36
+ placeholder: search.placeholder,
37
+ }, columnFilters: columnFilters, pageCount: pageCount, pagination: Object.assign(Object.assign({}, pagination), { state: {
38
+ pageIndex,
39
+ pageSize: limit,
40
+ }, onChange: handlePageChange }), pageSize: limit }, rest)));
41
+ }
42
+ ServerTable.getRowActionsColumnDef = Table.getRowActionsColumnDef;
43
+ ServerTable.getStatusColumnDef = Table.getStatusColumnDef;
@@ -0,0 +1,2 @@
1
+ export declare const SEARCH_DELAY = 500;
2
+ export declare const DEFAULT_PAGINATION_LIMIT = 10;
@@ -0,0 +1,2 @@
1
+ export const SEARCH_DELAY = 500;
2
+ export const DEFAULT_PAGINATION_LIMIT = 10;
@@ -0,0 +1 @@
1
+ export * from './ServerTable';
@@ -0,0 +1 @@
1
+ export * from './ServerTable';
@@ -47,6 +47,7 @@ export type TableProps<TData extends object> = WithSupportProps<{
47
47
  placeholder?: string;
48
48
  loading?: boolean;
49
49
  onChange?(value: string): void;
50
+ disableDefaultSearch?: boolean;
50
51
  };
51
52
  /** Максимальное кол-во строк на страницу @default 10 */
52
53
  pageSize?: number;
@@ -22,12 +22,12 @@ import { BodyRow, ExportButton, getColumnId, getRowActionsColumnDef, getSelectio
22
22
  import { fuzzyFilter } from '../../utils';
23
23
  import { TableEmptyState } from '../TableEmptyState';
24
24
  import { TablePagination } from '../TablePagination';
25
- import { DEFAULT_NO_DATA_TABLE_STATE, DEFAULT_NO_RESULTS_TABLE_STATE } from './constants';
25
+ import { DEFAULT_NO_DATA_TABLE_STATE, DEFAULT_NO_RESULTS_TABLE_STATE, DEFAULT_PAGE_SIZE } from './constants';
26
26
  import { useLoadingTable, useStateControl } from './hooks';
27
27
  import styles from './styles.module.css';
28
28
  /** Компонент таблицы */
29
29
  export function Table(_a) {
30
- var { data, columnDefinitions, rowSelection: rowSelectionProp, search, sorting: sortingProp, columnFilters: columnFiltersProp, pagination: paginationProp, className, onRowClick, onRefresh, onDelete, pageSize = 10, pageCount, loading = false, outline = false, moreActions, exportFileName, noDataState = DEFAULT_NO_DATA_TABLE_STATE, noResultsState = DEFAULT_NO_RESULTS_TABLE_STATE, suppressToolbar = false, toolbarBefore, suppressPagination = false } = _a, rest = __rest(_a, ["data", "columnDefinitions", "rowSelection", "search", "sorting", "columnFilters", "pagination", "className", "onRowClick", "onRefresh", "onDelete", "pageSize", "pageCount", "loading", "outline", "moreActions", "exportFileName", "noDataState", "noResultsState", "suppressToolbar", "toolbarBefore", "suppressPagination"]);
30
+ var { data, columnDefinitions, rowSelection: rowSelectionProp, search, sorting: sortingProp, columnFilters: columnFiltersProp, pagination: paginationProp, className, onRowClick, onRefresh, onDelete, pageSize = DEFAULT_PAGE_SIZE, pageCount, loading = false, outline = false, moreActions, exportFileName, noDataState = DEFAULT_NO_DATA_TABLE_STATE, noResultsState = DEFAULT_NO_RESULTS_TABLE_STATE, suppressToolbar = false, toolbarBefore, suppressPagination = false } = _a, rest = __rest(_a, ["data", "columnDefinitions", "rowSelection", "search", "sorting", "columnFilters", "pagination", "className", "onRowClick", "onRefresh", "onDelete", "pageSize", "pageCount", "loading", "outline", "moreActions", "exportFileName", "noDataState", "noResultsState", "suppressToolbar", "toolbarBefore", "suppressPagination"]);
31
31
  const { state: globalFilter, onStateChange: onGlobalFilterChange } = useStateControl(search, '');
32
32
  const { state: rowSelection, onStateChange: onRowSelectionChange } = useStateControl(rowSelectionProp, {});
33
33
  const defaultPaginationState = useMemo(() => ({
@@ -73,6 +73,9 @@ export function Table(_a) {
73
73
  enableResizing: false,
74
74
  minSize: 40,
75
75
  },
76
+ manualSorting: Boolean(pageCount),
77
+ manualPagination: pageCount !== undefined,
78
+ manualFiltering: Boolean(pageCount),
76
79
  globalFilterFn: fuzzyFilter,
77
80
  onGlobalFilterChange,
78
81
  onRowSelectionChange,
@@ -82,9 +85,7 @@ export function Table(_a) {
82
85
  getFilteredRowModel: getFilteredRowModel(),
83
86
  enableColumnResizing: true,
84
87
  enableSorting: true,
85
- manualSorting: false,
86
- enableMultiSort: false,
87
- manualPagination: pageCount !== undefined,
88
+ enableMultiSort: true,
88
89
  onSortingChange,
89
90
  getSortedRowModel: getSortedRowModel(),
90
91
  onPaginationChange,
@@ -140,7 +141,8 @@ export function Table(_a) {
140
141
  const tableRows = table.getRowModel().rows;
141
142
  const loadingTableRows = loadingTable.getRowModel().rows;
142
143
  const tablePagination = table.getState().pagination;
143
- return (_jsx(_Fragment, { children: _jsxs("div", Object.assign({ style: { '--page-size': !suppressPagination ? tablePagination === null || tablePagination === void 0 ? void 0 : tablePagination.pageSize : pageSize }, className: cn(styles.wrapper, className) }, extractSupportProps(rest), { children: [!suppressToolbar && (_jsxs("div", { className: styles.header, children: [_jsx(Toolbar, { search: {
144
+ const prePageSize = !suppressPagination ? tablePagination === null || tablePagination === void 0 ? void 0 : tablePagination.pageSize : pageSize;
145
+ return (_jsx(_Fragment, { children: _jsxs("div", Object.assign({ style: { '--page-size': !tableRows.length ? Math.min(prePageSize, DEFAULT_PAGE_SIZE) : prePageSize }, className: cn(styles.wrapper, className) }, extractSupportProps(rest), { children: [!suppressToolbar && (_jsxs("div", { className: styles.header, children: [_jsx(Toolbar, { search: {
144
146
  value: globalFilter,
145
147
  onChange: onGlobalFilterChange,
146
148
  loading: search === null || search === void 0 ? void 0 : search.loading,
@@ -1,3 +1,4 @@
1
1
  import { TableEmptyStateProps } from '../TableEmptyState';
2
2
  export declare const DEFAULT_NO_DATA_TABLE_STATE: TableEmptyStateProps;
3
3
  export declare const DEFAULT_NO_RESULTS_TABLE_STATE: TableEmptyStateProps;
4
+ export declare const DEFAULT_PAGE_SIZE = 10;
@@ -11,3 +11,4 @@ export const DEFAULT_NO_RESULTS_TABLE_STATE = {
11
11
  title: 'Not found',
12
12
  description: 'Try entering another query',
13
13
  };
14
+ export const DEFAULT_PAGE_SIZE = 10;
@@ -1 +1,2 @@
1
1
  export * from './Table';
2
+ export * from './ServerTable';
@@ -1 +1,2 @@
1
1
  export * from './Table';
2
+ export * from './ServerTable';
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "access": "public"
5
5
  },
6
6
  "title": "Table",
7
- "version": "0.11.4",
7
+ "version": "0.11.6-preview-a0815a00.0",
8
8
  "sideEffects": [
9
9
  "*.css",
10
10
  "*.woff",
@@ -33,24 +33,25 @@
33
33
  "scripts": {},
34
34
  "dependencies": {
35
35
  "@snack-uikit/button": "0.15.1",
36
- "@snack-uikit/chips": "0.10.8",
36
+ "@snack-uikit/chips": "0.10.9",
37
37
  "@snack-uikit/icon-predefined": "0.4.1",
38
38
  "@snack-uikit/icons": "0.20.0",
39
- "@snack-uikit/list": "0.2.0",
39
+ "@snack-uikit/list": "0.2.1-preview-a0815a00.0",
40
40
  "@snack-uikit/pagination": "0.6.1",
41
41
  "@snack-uikit/scroll": "0.5.0",
42
42
  "@snack-uikit/skeleton": "0.3.2",
43
43
  "@snack-uikit/tag": "0.7.1",
44
44
  "@snack-uikit/toggles": "0.9.4",
45
- "@snack-uikit/toolbar": "0.7.4",
45
+ "@snack-uikit/toolbar": "0.7.5-preview-a0815a00.0",
46
46
  "@snack-uikit/truncate-string": "0.4.6",
47
47
  "@snack-uikit/typography": "0.6.1",
48
48
  "@snack-uikit/utils": "3.2.0",
49
49
  "@tanstack/match-sorter-utils": "8.8.4",
50
50
  "@tanstack/react-table": "8.11.6",
51
51
  "classnames": "2.3.2",
52
+ "lodash.debounce": "4.0.8",
52
53
  "uncontrollable": "8.0.0",
53
54
  "xlsx": "https://cdn.sheetjs.com/xlsx-0.20.1/xlsx-0.20.1.tgz"
54
55
  },
55
- "gitHead": "07c554af2d1a8128e587ba88d5d36e6da3c8f1ce"
56
+ "gitHead": "bccfe5b8df0866bff03fc00d5f5480988da8512b"
56
57
  }
@@ -0,0 +1,182 @@
1
+ import debounce from 'lodash.debounce';
2
+ import { ReactNode, useCallback, useMemo, useState } from 'react';
3
+
4
+ import { WithSupportProps } from '@snack-uikit/utils';
5
+
6
+ import {
7
+ ColumnDefinition,
8
+ PaginationState,
9
+ RowClickHandler,
10
+ RowSelectionOptions,
11
+ RowSelectionState,
12
+ SortingState,
13
+ TableEmptyStateProps,
14
+ ToolbarProps,
15
+ } from '../../types';
16
+ import { Table } from '../Table';
17
+ import { DEFAULT_PAGINATION_LIMIT, SEARCH_DELAY } from './constants';
18
+
19
+ export type ServerTableProps<TData extends object> = WithSupportProps<{
20
+ /** Данные для отрисовки */
21
+ items?: TData[];
22
+ /** Общее кол-во строк @default 10 */
23
+ total?: number;
24
+ /** Кол-во строк на страницу @default 10 */
25
+ limit?: number;
26
+ /** Смещение @default 0 */
27
+ offset?: number;
28
+
29
+ onChangePage(offset: number, limit: number): void;
30
+
31
+ /** Определение внешнего вида и функционала колонок */
32
+ columnDefinitions: ColumnDefinition<TData>[];
33
+ /** Параметры отвечают за возможность сортировки, их стоит использовать если нужно отслеживать состояние <br>
34
+ * <strong>initialState</strong>: Начальное состояние сортировки <br>
35
+ * <strong>state</strong>: Состояние сортировки, жестко устанавливаемое снаружи <br>
36
+ * <strong>onChange</strong>: Колбэк на изменение сортировки
37
+ * */
38
+ sorting?: {
39
+ initialState?: SortingState;
40
+ state: SortingState;
41
+ onChange(state: SortingState): void;
42
+ };
43
+ /** Параметры отвечают за возможность выбора строк <br>
44
+ * <strong>initialState</strong>: Начальное состояние выбора строк <br>
45
+ * <strong>state</strong>: Состояние выбора строк, жестко устанавливаемое снаружи <br>
46
+ * <strong>enable</strong>: Колбэк определяющий можно ли выбрать строку <br>
47
+ * <strong>multiRow</strong>: Мульти-выбор строк (включен по-умолчанию, когда включается выбор) <br>
48
+ * <strong>onChange</strong>: Колбэк на выбор строк
49
+ * */
50
+ rowSelection?: {
51
+ initialState?: RowSelectionState;
52
+ state: RowSelectionState;
53
+ enable?: RowSelectionOptions<TData>['enableRowSelection'];
54
+ multiRow?: boolean;
55
+ onChange(state: RowSelectionState): void;
56
+ };
57
+ /** Параметры отвечают за глобальный поиск в таблице <br>
58
+ * <strong>initialState</strong>: Начальное состояние строки поиска <br>
59
+ * <strong>state</strong>: Состояние строки поиска, жестко устанавливаемое снаружи <br>
60
+ * <strong>placeholder</strong>: Placeholder строки поиска @default 'Search...'<br>
61
+ * <strong>loading</strong>: Состояние загрузки в строке поиска <br>
62
+ * <strong>onChange</strong>: Колбэк на изменение данных в строке поиска
63
+ * */
64
+ search: {
65
+ initialValue?: string;
66
+ state: string;
67
+ placeholder?: string;
68
+ loading?: boolean;
69
+ onChange(value: string): void;
70
+ };
71
+
72
+ /** Параметры отвечают за пагинацию в таблице <br>
73
+ * <strong>options</strong>: Варианты в выпадающем селекторе для установки кол-ва строк на страницу<br>
74
+ * <strong>optionsLabel</strong>: Текст для селектора кол-ва строк на страницу @default 'Rows volume' <br>
75
+ * */
76
+ pagination?: {
77
+ options?: number[];
78
+ optionsLabel?: string;
79
+ };
80
+
81
+ /** Колбэк клика по строке */
82
+ onRowClick?: RowClickHandler<TData>;
83
+ /** CSS-класс */
84
+ className?: string;
85
+
86
+ /** Состояние загрузки */
87
+ loading?: boolean;
88
+
89
+ /** Колбек обновления данных */
90
+ onRefresh(): void;
91
+
92
+ /** Колбек удаления выбранных */
93
+ onDelete?(selectionState: RowSelectionState, resetRowSelection: (defaultState?: boolean) => void): void;
94
+
95
+ /** Внешний бордер для тулбара и таблицы*/
96
+ outline?: boolean;
97
+
98
+ /** Фильтры*/
99
+ columnFilters?: ReactNode;
100
+
101
+ /** Название файла при экспорте CSV/XLSX*/
102
+ exportFileName?: string;
103
+
104
+ /** Элементы выпадающего списка кнопки с действиями */
105
+ moreActions?: ToolbarProps['moreActions'];
106
+
107
+ /** Экран при отстутствии данных */
108
+ noDataState?: TableEmptyStateProps;
109
+ /** Экран при отстутствии результатов поиска */
110
+ noResultsState?: TableEmptyStateProps;
111
+
112
+ /** Отключение тулбара */
113
+ suppressToolbar?: boolean;
114
+ /** Отключение пагинации */
115
+ suppressPagination?: boolean;
116
+ }>;
117
+
118
+ export function ServerTable<TData extends object>({
119
+ items,
120
+ total = DEFAULT_PAGINATION_LIMIT,
121
+ limit = DEFAULT_PAGINATION_LIMIT,
122
+ offset = 0,
123
+ onChangePage,
124
+ search,
125
+ pagination,
126
+ columnFilters,
127
+ ...rest
128
+ }: ServerTableProps<TData>) {
129
+ const [tempSearch, setTempSearch] = useState(search.initialValue || '');
130
+
131
+ const onSearchDebounced = useMemo(
132
+ () =>
133
+ debounce((newValue: string, onChange: (newValue: string) => void) => {
134
+ onChange(newValue);
135
+ }, SEARCH_DELAY),
136
+ [],
137
+ );
138
+
139
+ const handleSearch = useCallback(
140
+ (newValue: string) => {
141
+ setTempSearch(newValue);
142
+ onSearchDebounced(newValue.trim(), search.onChange);
143
+ },
144
+ // eslint-disable-next-line react-hooks/exhaustive-deps
145
+ [limit, onSearchDebounced],
146
+ );
147
+
148
+ const handlePageChange = useCallback(
149
+ ({ pageSize, pageIndex }: PaginationState) => onChangePage(pageIndex * pageSize, pageSize),
150
+ [onChangePage],
151
+ );
152
+
153
+ const pageIndex = useMemo(() => Math.floor(offset / limit), [limit, offset]);
154
+ const pageCount = useMemo(() => Math.ceil(total / limit), [limit, total]);
155
+
156
+ return (
157
+ <Table
158
+ data={items || []}
159
+ search={{
160
+ state: tempSearch,
161
+ onChange: handleSearch,
162
+ loading: search.loading,
163
+ placeholder: search.placeholder,
164
+ }}
165
+ columnFilters={columnFilters}
166
+ pageCount={pageCount}
167
+ pagination={{
168
+ ...pagination,
169
+ state: {
170
+ pageIndex,
171
+ pageSize: limit,
172
+ },
173
+ onChange: handlePageChange,
174
+ }}
175
+ pageSize={limit}
176
+ {...rest}
177
+ />
178
+ );
179
+ }
180
+
181
+ ServerTable.getRowActionsColumnDef = Table.getRowActionsColumnDef;
182
+ ServerTable.getStatusColumnDef = Table.getStatusColumnDef;
@@ -0,0 +1,2 @@
1
+ export const SEARCH_DELAY = 500;
2
+ export const DEFAULT_PAGINATION_LIMIT = 10;
@@ -0,0 +1 @@
1
+ export * from './ServerTable';
@@ -36,7 +36,7 @@ import { ColumnDefinition } from '../../types';
36
36
  import { fuzzyFilter } from '../../utils';
37
37
  import { TableEmptyState, TableEmptyStateProps } from '../TableEmptyState';
38
38
  import { TablePagination } from '../TablePagination';
39
- import { DEFAULT_NO_DATA_TABLE_STATE, DEFAULT_NO_RESULTS_TABLE_STATE } from './constants';
39
+ import { DEFAULT_NO_DATA_TABLE_STATE, DEFAULT_NO_RESULTS_TABLE_STATE, DEFAULT_PAGE_SIZE } from './constants';
40
40
  import { useLoadingTable, useStateControl } from './hooks';
41
41
  import styles from './styles.module.scss';
42
42
 
@@ -82,6 +82,7 @@ export type TableProps<TData extends object> = WithSupportProps<{
82
82
  placeholder?: string;
83
83
  loading?: boolean;
84
84
  onChange?(value: string): void;
85
+ disableDefaultSearch?: boolean;
85
86
  };
86
87
 
87
88
  /** Максимальное кол-во строк на страницу @default 10 */
@@ -161,7 +162,7 @@ export function Table<TData extends object>({
161
162
  onRefresh,
162
163
  onDelete,
163
164
 
164
- pageSize = 10,
165
+ pageSize = DEFAULT_PAGE_SIZE,
165
166
  pageCount,
166
167
  loading = false,
167
168
  outline = false,
@@ -252,6 +253,10 @@ export function Table<TData extends object>({
252
253
  minSize: 40,
253
254
  },
254
255
 
256
+ manualSorting: Boolean(pageCount),
257
+ manualPagination: pageCount !== undefined,
258
+ manualFiltering: Boolean(pageCount),
259
+
255
260
  globalFilterFn: fuzzyFilter,
256
261
  onGlobalFilterChange,
257
262
 
@@ -265,11 +270,12 @@ export function Table<TData extends object>({
265
270
  enableColumnResizing: true,
266
271
 
267
272
  enableSorting: true,
268
- manualSorting: false,
269
- enableMultiSort: false,
270
- manualPagination: pageCount !== undefined,
273
+
274
+ enableMultiSort: true,
275
+
271
276
  onSortingChange,
272
277
  getSortedRowModel: getSortedRowModel(),
278
+
273
279
  onPaginationChange,
274
280
  getPaginationRowModel: getPaginationRowModel(),
275
281
 
@@ -339,10 +345,12 @@ export function Table<TData extends object>({
339
345
  const loadingTableRows = loadingTable.getRowModel().rows;
340
346
  const tablePagination = table.getState().pagination;
341
347
 
348
+ const prePageSize = !suppressPagination ? tablePagination?.pageSize : pageSize;
349
+
342
350
  return (
343
351
  <>
344
352
  <div
345
- style={{ '--page-size': !suppressPagination ? tablePagination?.pageSize : pageSize }}
353
+ style={{ '--page-size': !tableRows.length ? Math.min(prePageSize, DEFAULT_PAGE_SIZE) : prePageSize }}
346
354
  className={cn(styles.wrapper, className)}
347
355
  {...extractSupportProps(rest)}
348
356
  >
@@ -15,3 +15,5 @@ export const DEFAULT_NO_RESULTS_TABLE_STATE: TableEmptyStateProps = {
15
15
  title: 'Not found',
16
16
  description: 'Try entering another query',
17
17
  } as const;
18
+
19
+ export const DEFAULT_PAGE_SIZE = 10;
@@ -1 +1,2 @@
1
1
  export * from './Table';
2
+ export * from './ServerTable';