@snack-uikit/table 0.37.28 → 0.37.29-preview-9d961963.0

package/README.md

@@ -6,15 +6,19 @@
 
 [Changelog](./CHANGELOG.md)
 
-## TODO:
-
-- multiple row selection with Shift key pressed
-
 ## Примечание
 
 > Для оптимальной работы таблицы используйте `useMemo` для `columnDefinitions`
 > или выносите их определение за компонент
 
+## Description
+
+- Пакет `@snack-uikit/table` предоставляет компоненты для отображения структурированных данных в виде таблиц с расширенным функционалом: сортировка, фильтрация, пагинация, выбор строк, поиск, экспорт данных и настройка колонок.
+- Основной компонент `Table` поддерживает клиентскую и серверную обработку данных, работу с большими объёмами информации через бесконечную прокрутку, закрепление строк и колонок, раскрывающиеся строки (tree-структура), массовые действия и сохранение состояния в localStorage и query-параметрах.
+- Компонент `ServerTable` является обёрткой над `Table` для работы с серверной пагинацией: автоматически управляет состоянием поиска с дебаунсом, преобразует параметры пагинации в формат offset/limit и передаёт их через колбэк `onChangePage`, а также устанавливает режимы `manualSorting`, `manualPagination` и `manualFiltering` для серверной обработки.
+- Таблица поддерживает настройку внешнего вида колонок (размеры, выравнивание, закрепление), кастомный рендеринг ячеек, колонки со статусами и действиями для строк, а также различные состояния: загрузка, пустые данные, ошибки, фильтрация.
+- Figma: [Table](https://www.figma.com/file/jtGxAPvFJOMir7V0eQFukN/Snack-UI-Kit-1.1.0?node-id=41%3A225842&mode=design).
+
 ## Example
 
 ```typescript jsx
@@ -31,7 +35,7 @@ type TableData = {
 }
 
 const columnDefinitions: ColumnDefinition<TableData>[] = [
-  Table.getStatusColumnDef<Person>({
+  Table.getStatusColumnDef<TableData>({
     accessorKey: 'status',
     mapStatusToAppearance: {
       pending: Table.statusAppearances.Blue,
@@ -123,112 +127,21 @@ const columnDefinitions: ColumnDefinition<TableData>[] = [
 | expanding | `{ getSubRows: (element: TData) => TData[]; expandingColumnDefinition: TreeColumnDefinitionProps<TData>; state?: ExpandedState; onChange?(state: ExpandedState): void; }` | - | Параметр отвечает за общие настройки раскрывающихся строк <br> <strong>getSubRows</strong>: Метод отвечает за получение дочерних строк <br> <strong>expandingColumnDefinition</strong>: Описание колонок для дочерних строк <br> <strong>state</strong>: Состояние открытых строк <br> <strong>onExpandedChange</strong>: Колбэк на раскрытие строк <br> |
 | enableSelectPinned | `boolean` | - | Параметр отвечает за чекбокс выбора закрепленных строк |
 ## isColumnEnabledInitially
-### Props
-| name | type | default value | description |
-|------|------|---------------|-------------|
-| accessorFn* | `AccessorFn<TData, unknown>` | - |  |
-| accessorKey* | `string \| number \| symbol \| (string & {})` | - |  |
-| getUniqueValues | `AccessorFn<TData, unknown[]>` | - |  |
-| cell | `ColumnDefTemplate<CellContext<TData, unknown>>` | - |  |
-| meta | `ColumnMeta<TData, unknown> & { skipOnExport?: boolean; }` | - | Пропуск в экспорте |
-| enableSorting | `boolean` | - | Enables/Disables sorting for this column. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesorting) @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting) |
-| invertSorting | `boolean` | - | Inverts the order of the sorting for this column. This is useful for values that have an inverted best/worst scale where lower numbers are better, eg. a ranking (1st, 2nd, 3rd) or golf-like scoring @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#invertsorting) @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting) |
-| sortDescFirst | `boolean` | - | Set to `true` for sorting toggles on this column to start in the descending direction. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortdescfirst) @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting) |
-| sortingFn | `SortingFnOption<TData>` | - | The sorting function to use with this column. - A `string` referencing a built-in sorting function - A custom sorting function @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortingfn) @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting) |
-| sortUndefined | `false \| 1 \| -1` | - | - `false`   - Undefined values will be considered tied and need to be sorted by the next column filter or original index (whichever applies) - `-1`   - Undefined values will be sorted with higher priority (ascending) (if ascending, undefined will appear on the beginning of the list) - `1`   - Undefined values will be sorted with lower priority (descending) (if ascending, undefined will appear on the end of the list) |
-| aggregatedCell | `ColumnDefTemplate<CellContext<TData, unknown>>` | - | The cell to display each row for the column if the cell is an aggregate. If a function is passed, it will be passed a props object with the context of the cell and should return the property type for your adapter (the exact type depends on the adapter being used). @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#aggregatedcell) @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping) |
-| aggregationFn | `AggregationFnOption<TData>` | - | The resolved aggregation function for the column. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#aggregationfn) @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping) |
-| getGroupingValue | `(row: TData) => any` | - | Specify a value to be used for grouping rows on this column. If this option is not specified, the value derived from `accessorKey` / `accessorFn` will be used instead. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupingvalue) @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping) |
-| enableResizing | `boolean` | - | Enables or disables column resizing for the column. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#enableresizing) @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) |
-| maxSize | `number` | - | The maximum allowed size for the column @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#maxsize) @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) |
-| minSize | `number` | - | The minimum allowed size for the column @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#minsize) @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) |
-| size | `number` | - | The desired size for the column Размер ячейки @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#size) @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) |
-| header | `string \| (string & ReactElement<any, string \| JSXElementConstructor<any>>) \| (string & Iterable<ReactNode>) \| ... 9 more ... \| (((props: HeaderContext<...>) => any) & ((ctx: HeaderContext<...>) => ReactNode))` | - | Заголовок колонки |
-| id | `string` | - |  |
-| headerAlign | enum ColumnAlign: `"left"`, `"right"` | - | Позиционирование заголовка колонки |
-| align | enum ColumnAlign: `"left"`, `"right"` | - | Позиционирование контента ячейки в теле таблицы |
-| noBodyCellPadding | `boolean` | - | Отключить паддинг у ячейки в теле таблицы |
-| noHeaderCellPadding | `boolean` | - | Отключить паддинг у ячейки в шапке таблицы |
-| noHeaderCellBorderOffset | `boolean` | - | Отключить смещение бордера слева у ячейки хедера |
-| cellClassName | `string` | - | CSS-класс для ячейки в теле таблицы |
-| headerClassName | `string` | - | CSS-класс для ячейки в теле таблицы |
-| pinned | enum ColumnPinPosition: `"left"`, `"right"` | - | Закрепление колонки слева/справа в таблице |
-| columns | `ColumnDef<TData, any>[]` | - |  |
-| columnSettings | `{ label?: string; mode?: ColumnSettingsMode; }` | - |  |
+`isColumnEnabledInitially` 
+
+Проверка на то, должна ли колонка быть включена по умолчанию
 ## isColumnVisibilityConfigurable
-### Props
-| name | type | default value | description |
-|------|------|---------------|-------------|
-| accessorFn* | `AccessorFn<TData, unknown>` | - |  |
-| accessorKey* | `string \| number \| symbol \| (string & {})` | - |  |
-| getUniqueValues | `AccessorFn<TData, unknown[]>` | - |  |
-| cell | `ColumnDefTemplate<CellContext<TData, unknown>>` | - |  |
-| meta | `ColumnMeta<TData, unknown> & { skipOnExport?: boolean; }` | - | Пропуск в экспорте |
-| enableSorting | `boolean` | - | Enables/Disables sorting for this column. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesorting) @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting) |
-| invertSorting | `boolean` | - | Inverts the order of the sorting for this column. This is useful for values that have an inverted best/worst scale where lower numbers are better, eg. a ranking (1st, 2nd, 3rd) or golf-like scoring @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#invertsorting) @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting) |
-| sortDescFirst | `boolean` | - | Set to `true` for sorting toggles on this column to start in the descending direction. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortdescfirst) @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting) |
-| sortingFn | `SortingFnOption<TData>` | - | The sorting function to use with this column. - A `string` referencing a built-in sorting function - A custom sorting function @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortingfn) @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting) |
-| sortUndefined | `false \| 1 \| -1` | - | - `false`   - Undefined values will be considered tied and need to be sorted by the next column filter or original index (whichever applies) - `-1`   - Undefined values will be sorted with higher priority (ascending) (if ascending, undefined will appear on the beginning of the list) - `1`   - Undefined values will be sorted with lower priority (descending) (if ascending, undefined will appear on the end of the list) |
-| aggregatedCell | `ColumnDefTemplate<CellContext<TData, unknown>>` | - | The cell to display each row for the column if the cell is an aggregate. If a function is passed, it will be passed a props object with the context of the cell and should return the property type for your adapter (the exact type depends on the adapter being used). @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#aggregatedcell) @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping) |
-| aggregationFn | `AggregationFnOption<TData>` | - | The resolved aggregation function for the column. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#aggregationfn) @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping) |
-| getGroupingValue | `(row: TData) => any` | - | Specify a value to be used for grouping rows on this column. If this option is not specified, the value derived from `accessorKey` / `accessorFn` will be used instead. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupingvalue) @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping) |
-| enableResizing | `boolean` | - | Enables or disables column resizing for the column. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#enableresizing) @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) |
-| maxSize | `number` | - | The maximum allowed size for the column @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#maxsize) @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) |
-| minSize | `number` | - | The minimum allowed size for the column @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#minsize) @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) |
-| size | `number` | - | The desired size for the column Размер ячейки @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#size) @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) |
-| header | `string \| (string & ReactElement<any, string \| JSXElementConstructor<any>>) \| (string & Iterable<ReactNode>) \| ... 9 more ... \| (((props: HeaderContext<...>) => any) & ((ctx: HeaderContext<...>) => ReactNode))` | - | Заголовок колонки |
-| id | `string` | - |  |
-| headerAlign | enum ColumnAlign: `"left"`, `"right"` | - | Позиционирование заголовка колонки |
-| align | enum ColumnAlign: `"left"`, `"right"` | - | Позиционирование контента ячейки в теле таблицы |
-| noBodyCellPadding | `boolean` | - | Отключить паддинг у ячейки в теле таблицы |
-| noHeaderCellPadding | `boolean` | - | Отключить паддинг у ячейки в шапке таблицы |
-| noHeaderCellBorderOffset | `boolean` | - | Отключить смещение бордера слева у ячейки хедера |
-| cellClassName | `string` | - | CSS-класс для ячейки в теле таблицы |
-| headerClassName | `string` | - | CSS-класс для ячейки в теле таблицы |
-| pinned | enum ColumnPinPosition: `"left"`, `"right"` | - | Закрепление колонки слева/справа в таблице |
-| columns | `ColumnDef<TData, any>[]` | - |  |
-| columnSettings | `{ label?: string; mode?: ColumnSettingsMode; }` | - |  |
+`isColumnVisibilityConfigurable` 
+
+Проверка на то, должна ли колонка отображаться в настройках колонок
 ## isFilterableColumn
-### Props
-| name | type | default value | description |
-|------|------|---------------|-------------|
-| accessorFn* | `AccessorFn<TData, unknown>` | - |  |
-| accessorKey* | `string \| number \| symbol \| (string & {})` | - |  |
-| getUniqueValues | `AccessorFn<TData, unknown[]>` | - |  |
-| cell | `ColumnDefTemplate<CellContext<TData, unknown>>` | - |  |
-| meta | `ColumnMeta<TData, unknown> & { skipOnExport?: boolean; }` | - | Пропуск в экспорте |
-| enableSorting | `boolean` | - | Enables/Disables sorting for this column. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesorting) @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting) |
-| invertSorting | `boolean` | - | Inverts the order of the sorting for this column. This is useful for values that have an inverted best/worst scale where lower numbers are better, eg. a ranking (1st, 2nd, 3rd) or golf-like scoring @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#invertsorting) @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting) |
-| sortDescFirst | `boolean` | - | Set to `true` for sorting toggles on this column to start in the descending direction. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortdescfirst) @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting) |
-| sortingFn | `SortingFnOption<TData>` | - | The sorting function to use with this column. - A `string` referencing a built-in sorting function - A custom sorting function @link [API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortingfn) @link [Guide](https://tanstack.com/table/v8/docs/guide/sorting) |
-| sortUndefined | `false \| 1 \| -1` | - | - `false`   - Undefined values will be considered tied and need to be sorted by the next column filter or original index (whichever applies) - `-1`   - Undefined values will be sorted with higher priority (ascending) (if ascending, undefined will appear on the beginning of the list) - `1`   - Undefined values will be sorted with lower priority (descending) (if ascending, undefined will appear on the end of the list) |
-| aggregatedCell | `ColumnDefTemplate<CellContext<TData, unknown>>` | - | The cell to display each row for the column if the cell is an aggregate. If a function is passed, it will be passed a props object with the context of the cell and should return the property type for your adapter (the exact type depends on the adapter being used). @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#aggregatedcell) @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping) |
-| aggregationFn | `AggregationFnOption<TData>` | - | The resolved aggregation function for the column. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#aggregationfn) @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping) |
-| getGroupingValue | `(row: TData) => any` | - | Specify a value to be used for grouping rows on this column. If this option is not specified, the value derived from `accessorKey` / `accessorFn` will be used instead. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupingvalue) @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping) |
-| enableResizing | `boolean` | - | Enables or disables column resizing for the column. @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#enableresizing) @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) |
-| maxSize | `number` | - | The maximum allowed size for the column @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#maxsize) @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) |
-| minSize | `number` | - | The minimum allowed size for the column @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#minsize) @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) |
-| size | `number` | - | The desired size for the column Размер ячейки @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#size) @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) |
-| header | `string \| (string & ReactElement<any, string \| JSXElementConstructor<any>>) \| (string & Iterable<ReactNode>) \| ... 9 more ... \| (((props: HeaderContext<...>) => any) & ((ctx: HeaderContext<...>) => ReactNode))` | - | Заголовок колонки |
-| id | `string` | - |  |
-| headerAlign | enum ColumnAlign: `"left"`, `"right"` | - | Позиционирование заголовка колонки |
-| align | enum ColumnAlign: `"left"`, `"right"` | - | Позиционирование контента ячейки в теле таблицы |
-| noBodyCellPadding | `boolean` | - | Отключить паддинг у ячейки в теле таблицы |
-| noHeaderCellPadding | `boolean` | - | Отключить паддинг у ячейки в шапке таблицы |
-| noHeaderCellBorderOffset | `boolean` | - | Отключить смещение бордера слева у ячейки хедера |
-| cellClassName | `string` | - | CSS-класс для ячейки в теле таблицы |
-| headerClassName | `string` | - | CSS-класс для ячейки в теле таблицы |
-| pinned | enum ColumnPinPosition: `"left"`, `"right"` | - | Закрепление колонки слева/справа в таблице |
-| columns | `ColumnDef<TData, any>[]` | - |  |
-| columnSettings | `{ label?: string; mode?: ColumnSettingsMode; }` | - |  |
+`isFilterableColumn` 
+
+Проверка на то, должна ли колонка отображаться в таблице
 ## prepareColumnsSettings
-### Props
-| name | type | default value | description |
-|------|------|---------------|-------------|
-| t* | `GetLocaleText<Dictionary, "Table">` | - |  |
-| areAllColumnsEnabled* | `boolean` | - |  |
-| columnOrder* | `string[]` | - |  |
-| pinnedGroups* | `PinnedGroupsState<TData>` | - |  |
+`prepareColumnsSettings` 
+
+Отвечает за создание списка колонок в настройках с учётом порядка и всех групп
 ## usePageReset
 ### Props
 | name | type | default value | description |
@@ -239,66 +152,19 @@ const columnDefinitions: ColumnDefinition<TableData>[] = [
 | maximumAvailablePage* | `number` | - |  |
 | manualPagination* | `boolean` | - |  |
 ## getPinnedGroups
-### Props
-| name | type | default value | description |
-|------|------|---------------|-------------|
-| __@unscopables@2312* | `{ [x: number]: boolean; length?: boolean; toString?: boolean; toLocaleString?: boolean; pop?: boolean; push?: boolean; concat?: boolean; join?: boolean; reverse?: boolean; shift?: boolean; slice?: boolean; sort?: boolean; ... 29 more ...; readonly [Symbol.unscopables]?: boolean; }` | - | Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. |
-| __@iterator@1606* | `() => ArrayIterator<ColumnDefinition<TData>>` | - | Iterator |
-| with* | `(index: number, value: ColumnDefinition<TData>) => ColumnDefinition<TData>[]` | - | Copies an array, then overwrites the value at the provided index with the given value. If the index is negative, then it replaces from the end of the array. @param index The index of the value to overwrite. If the index is negative, then it replaces from the end of the array. @param value The value to write into the copied array. @returns The copied array with the updated value. |
-| toSpliced* | `{ (start: number, deleteCount: number, ...items: ColumnDefinition<TData>[]): ColumnDefinition<TData>[]; (start: number, deleteCount?: number): ColumnDefinition<...>[]; }` | - | Copies an array and removes elements and, if necessary, inserts new elements in their place. Returns the copied array. Copies an array and removes elements while returning the remaining elements. @param start The zero-based location in the array from which to start removing elements. @param deleteCount The number of elements to remove. @param items Elements to insert into the copied array in place of the deleted elements. @returns The copied array. @param start The zero-based location in the array from which to start removing elements. @param deleteCount The number of elements to remove. @returns A copy of the original array with the remaining elements. |
-| toSorted* | `(compareFn?: (a: ColumnDefinition<TData>, b: ColumnDefinition<TData>) => number) => ColumnDefinition<TData>[]` | - | Returns a copy of an array with its elements sorted. @param compareFn Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order. ```ts [11, 2, 22, 1].toSorted((a, b) => a - b) // [1, 2, 11, 22] ``` |
-| toReversed* | `() => ColumnDefinition<TData>[]` | - | Returns a copy of an array with its elements reversed. |
-| findLastIndex* | `(predicate: (value: ColumnDefinition<TData>, index: number, array: ColumnDefinition<TData>[]) => unknown, thisArg?: any) => number` | - | Returns the index of the last element in the array where predicate is true, and -1 otherwise. @param predicate findLastIndex calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1. @param thisArg If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. |
-| findLast* | `{ <S extends ColumnDefinition<TData>>(predicate: (value: ColumnDefinition<TData>, index: number, array: ColumnDefinition<TData>[]) => value is S, thisArg?: any): S; (predicate: (value: ColumnDefinition<...>, index: number, array: ColumnDefinition<...>[]) => unknown, thisArg?: any): ColumnDefinition<...>; }` | - | Returns the value of the last element in the array where predicate is true, and undefined otherwise. @param predicate findLast calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLast immediately returns that element value. Otherwise, findLast returns undefined. @param thisArg If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. |
-| at* | `(index: number) => ColumnDefinition<TData>` | - | Returns the item located at the specified index. @param index The zero-based index of the desired code unit. A negative index will count back from the last item. |
-| flat* | `<A, D extends number = 1>(this: A, depth?: D) => FlatArray<A, D>[]` | - | Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. @param depth The maximum recursion depth |
-| flatMap* | `<U, This = undefined>(callback: (this: This, value: ColumnDefinition<TData>, index: number, array: ColumnDefinition<TData>[]) => U \| readonly U[], thisArg?: This) => U[]` | - | Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. @param callback A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. @param thisArg An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. |
-| includes* | `(searchElement: ColumnDefinition<TData>, fromIndex?: number) => boolean` | - | Determines whether an array includes a certain element, returning true or false as appropriate. @param searchElement The element to search for. @param fromIndex The position in this array at which to begin searching for searchElement. |
-| values* | `() => ArrayIterator<ColumnDefinition<TData>>` | - | Returns an iterable of values in the array |
-| keys* | `() => ArrayIterator<number>` | - | Returns an iterable of keys in the array |
-| entries* | `() => ArrayIterator<[number, ColumnDefinition<TData>]>` | - | Returns an iterable of key, value pairs for every entry in the array |
-| copyWithin* | `(target: number, start: number, end?: number) => ColumnDefinition<TData>[]` | - | Returns the this object after copying a section of the array identified by start and end to the same array starting at position target @param target If target is negative, it is treated as length+target where length is the length of the array. @param start If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. @param end If not specified, length of the this object is used as its default value. |
-| fill* | `(value: ColumnDefinition<TData>, start?: number, end?: number) => ColumnDefinition<TData>[]` | - | Changes all array elements from `start` to `end` index to a static `value` and returns the modified array @param value value to fill array section with @param start index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. @param end index to stop filling the array at. If end is negative, it is treated as length+end. |
-| findIndex* | `(predicate: (value: ColumnDefinition<TData>, index: number, obj: ColumnDefinition<TData>[]) => unknown, thisArg?: any) => number` | - | Returns the index of the first element in the array where predicate is true, and -1 otherwise. @param predicate find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. @param thisArg If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. |
-| find* | `{ <S extends ColumnDefinition<TData>>(predicate: (value: ColumnDefinition<TData>, index: number, obj: ColumnDefinition<TData>[]) => value is S, thisArg?: any): S; (predicate: (value: ColumnDefinition<...>, index: number, obj: ColumnDefinition<...>[]) => unknown, thisArg?: any): ColumnDefinition<...>; }` | - | Returns the value of the first element in the array where predicate is true, and undefined otherwise. @param predicate find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. @param thisArg If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. |
-| reduceRight* | `{ (callbackfn: (previousValue: ColumnDefinition<TData>, currentValue: ColumnDefinition<TData>, currentIndex: number, array: ColumnDefinition<TData>[]) => ColumnDefinition<...>): ColumnDefinition<...>; (callbackfn: (previousValue: ColumnDefinition<...>, currentValue: ColumnDefinition<...>, currentIndex: number, array...` | - | Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. @param callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. @param callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. |
-| reduce* | `{ (callbackfn: (previousValue: ColumnDefinition<TData>, currentValue: ColumnDefinition<TData>, currentIndex: number, array: ColumnDefinition<TData>[]) => ColumnDefinition<...>): ColumnDefinition<...>; (callbackfn: (previousValue: ColumnDefinition<...>, currentValue: ColumnDefinition<...>, currentIndex: number, array...` | - | Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. @param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. @param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. |
-| filter* | `{ <S extends ColumnDefinition<TData>>(predicate: (value: ColumnDefinition<TData>, index: number, array: ColumnDefinition<TData>[]) => value is S, thisArg?: any): S[]; (predicate: (value: ColumnDefinition<...>, index: number, array: ColumnDefinition<...>[]) => unknown, thisArg?: any): ColumnDefinition<...>[]; }` | - | Returns the elements of an array that meet the condition specified in a callback function. @param predicate A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. @param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. @param predicate A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. @param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. |
-| map* | `<U>(callbackfn: (value: ColumnDefinition<TData>, index: number, array: ColumnDefinition<TData>[]) => U, thisArg?: any) => U[]` | - | Calls a defined callback function on each element of an array, and returns an array that contains the results. @param callbackfn A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |
-| forEach* | `(callbackfn: (value: ColumnDefinition<TData>, index: number, array: ColumnDefinition<TData>[]) => void, thisArg?: any) => void` | - | Performs the specified action for each element in an array. @param callbackfn A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |
-| some* | `(predicate: (value: ColumnDefinition<TData>, index: number, array: ColumnDefinition<TData>[]) => unknown, thisArg?: any) => boolean` | - | Determines whether the specified callback function returns true for any element of an array. @param predicate A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array. @param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. |
-| every* | `{ <S extends ColumnDefinition<TData>>(predicate: (value: ColumnDefinition<TData>, index: number, array: ColumnDefinition<TData>[]) => value is S, thisArg?: any): this is S[]; (predicate: (value: ColumnDefinition<...>, index: number, array: ColumnDefinition<...>[]) => unknown, thisArg?: any): boolean; }` | - | Determines whether all the members of an array satisfy the specified test. @param predicate A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. @param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. @param predicate A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. @param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. |
-| lastIndexOf* | `(searchElement: ColumnDefinition<TData>, fromIndex?: number) => number` | - | Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present. @param searchElement The value to locate in the array. @param fromIndex The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array. |
-| indexOf* | `(searchElement: ColumnDefinition<TData>, fromIndex?: number) => number` | - | Returns the index of the first occurrence of a value in an array, or -1 if it is not present. @param searchElement The value to locate in the array. @param fromIndex The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. |
-| unshift* | `(...items: ColumnDefinition<TData>[]) => number` | - | Inserts new elements at the start of an array, and returns the new length of the array. @param items Elements to insert at the start of the array. |
-| splice* | `{ (start: number, deleteCount?: number): ColumnDefinition<TData>[]; (start: number, deleteCount: number, ...items: ColumnDefinition<TData>[]): ColumnDefinition<...>[]; }` | - | Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. @param start The zero-based location in the array from which to start removing elements. @param deleteCount The number of elements to remove. Omitting this argument will remove all elements from the start paramater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements. @returns An array containing the elements that were deleted. @param start The zero-based location in the array from which to start removing elements. @param deleteCount The number of elements to remove. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements. @param items Elements to insert into the array in place of the deleted elements. @returns An array containing the elements that were deleted. |
-| sort* | `(compareFn?: (a: ColumnDefinition<TData>, b: ColumnDefinition<TData>) => number) => ColumnDefinition<TData>[]` | - | Sorts an array in place. This method mutates the array and returns a reference to the same array. @param compareFn Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order. ```ts [11,2,22,1].sort((a, b) => a - b) ``` |
-| slice* | `(start?: number, end?: number) => ColumnDefinition<TData>[]` | - | Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array. @param start The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0. @param end The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array. |
-| shift* | `() => ColumnDefinition<TData>` | - | Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified. |
-| reverse* | `() => ColumnDefinition<TData>[]` | - | Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array. |
-| join* | `(separator?: string) => string` | - | Adds all the elements of an array into a string, separated by the specified separator string. @param separator A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma. |
-| concat* | `{ (...items: ConcatArray<ColumnDefinition<TData>>[]): ColumnDefinition<TData>[]; (...items: (ColumnDefinition<TData> \| ConcatArray<...>)[]): ColumnDefinition<...>[]; }` | - | Combines two or more arrays. This method returns a new array without modifying any existing arrays. @param items Additional arrays and/or items to add to the end of the array. @param items Additional arrays and/or items to add to the end of the array. |
-| push* | `(...items: ColumnDefinition<TData>[]) => number` | - | Appends new elements to the end of an array, and returns the new length of the array. @param items New elements to add to the array. |
-| pop* | `() => ColumnDefinition<TData>` | - | Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified. |
-| length* | `number` | - | Gets or sets the length of the array. This is a number one higher than the highest index in the array. |
-| toString | `() => string` | function toString() { [native code] } | Returns a string representation of an array. |
-| toLocaleString | `{ (): string; (locales: string \| string[], options?: NumberFormatOptions & DateTimeFormatOptions): string; }` | function toLocaleString() { [native code] } | Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. |
+`getPinnedGroups` 
+
+Отвечает за распределение columnDefinitions по возможным pinned группам. Возвращает PinnedGroupsState
 ## getTableColumnsDefinitions
-### Props
-| name | type | default value | description |
-|------|------|---------------|-------------|
-| expanding* | `{ getSubRows: (element: TData) => TData[]; expandingColumnDefinition: TreeColumnDefinitionProps<TData>; state?: ExpandedState; onChange?(state: ExpandedState): void; }` | - |  |
-| enableSelectPinned* | `boolean` | - |  |
-| enableSelection* | `boolean` | - |  |
-| columnDefinitions* | `ColumnDefinition<TData>[]` | - |  |
-| rowSelectionAppearance | enum RowAppearance: `"disabled"`, `"hide-toggler"` | RowAppearance.Disabled |  |
+`getTableColumnsDefinitions` 
+
+Получение фактического списка columnDefinitions с учётом всевозможных настроек
 ## formatTableStateToRequestPayload
 Вспомогательная функция для преобразования состояния таблицы к формату RequestPayloadParams
 ### Props
 | name | type | default value | description |
 |------|------|---------------|-------------|
 | filter | `FiltersState` | - |  |
-| ordering | `FieldSort[]` | - |  |
 | search | `string` | - |  |
 | pagination | `PaginationState \| PaginationParams` | - |  |
 | sorting | `SortingState` | - |  |

package/dist/cjs/components/Table/hooks/useColumnSettings/utils/isColumnEnabledInitially.d.ts

@@ -1,2 +1,6 @@
 import { ColumnDefinition } from '../../../../../types';
+/**
+ * Проверка на то, должна ли колонка быть включена по умолчанию
+ * @function isColumnEnabledInitially
+ */
 export declare function isColumnEnabledInitially<TData extends object>(colDef: ColumnDefinition<TData>): boolean;

package/dist/cjs/components/Table/hooks/useColumnSettings/utils/isColumnEnabledInitially.js

@@ -4,6 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.isColumnEnabledInitially = isColumnEnabledInitially;
+/**
+ * Проверка на то, должна ли колонка быть включена по умолчанию
+ * @function isColumnEnabledInitially
+ */
 function isColumnEnabledInitially(colDef) {
   var _a;
   if ('columnSettings' in colDef && colDef.columnSettings !== undefined) {

package/dist/cjs/components/Table/hooks/useColumnSettings/utils/isColumnVisibilityConfigurable.d.ts

@@ -1,2 +1,6 @@
 import { ColumnDefinition } from '../../../../../types';
+/**
+ * Проверка на то, должна ли колонка отображаться в настройках колонок
+ * @function isColumnVisibilityConfigurable
+ */
 export declare function isColumnVisibilityConfigurable<TData extends object>(colDef: ColumnDefinition<TData>): boolean;

package/dist/cjs/components/Table/hooks/useColumnSettings/utils/isColumnVisibilityConfigurable.js

@@ -4,6 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.isColumnVisibilityConfigurable = isColumnVisibilityConfigurable;
+/**
+ * Проверка на то, должна ли колонка отображаться в настройках колонок
+ * @function isColumnVisibilityConfigurable
+ */
 function isColumnVisibilityConfigurable(colDef) {
   if ('columnSettings' in colDef && colDef.columnSettings !== undefined) {
     const {

package/dist/cjs/components/Table/hooks/useColumnSettings/utils/isFilterableColumn.d.ts

@@ -1,2 +1,6 @@
 import { ColumnDefinition, FilterableColumnDefinition } from '../../../../../types';
+/**
+ * Проверка на то, должна ли колонка отображаться в таблице
+ * @function isFilterableColumn
+ */
 export declare function isFilterableColumn<TData extends object>(colDef: ColumnDefinition<TData>): colDef is FilterableColumnDefinition<TData>;

package/dist/cjs/components/Table/hooks/useColumnSettings/utils/isFilterableColumn.js

@@ -4,6 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.isFilterableColumn = isFilterableColumn;
+/**
+ * Проверка на то, должна ли колонка отображаться в таблице
+ * @function isFilterableColumn
+ */
 function isFilterableColumn(colDef) {
   var _a;
   return ('id' in colDef || 'accessorKey' in colDef) && 'columnSettings' in colDef && ((_a = colDef.columnSettings) === null || _a === void 0 ? void 0 : _a.mode) !== 'hidden';

package/dist/cjs/components/Table/hooks/useColumnSettings/utils/prepareColumnsSettings.d.ts

@@ -7,5 +7,9 @@ type PrepareColumnsSettingsProps<TData extends object> = {
     areAllColumnsEnabled: boolean;
     t: ReturnType<typeof useLocale<'Table'>>['t'];
 };
+/**
+ * Отвечает за создание списка колонок в настройках с учётом порядка и всех групп
+ * @function prepareColumnsSettings
+ */
 export declare function prepareColumnsSettings<TData extends object>({ pinnedGroups, columnOrder, areAllColumnsEnabled, t, }: PrepareColumnsSettingsProps<TData>): [GroupSelectItemProps];
 export {};

package/dist/cjs/components/Table/hooks/useColumnSettings/utils/prepareColumnsSettings.js

@@ -20,6 +20,10 @@ function createColumnsSettingsOption(columnDefinition) {
 function createGroupOptions(group, columnOrder) {
   return group.filter(isFilterableColumn_1.isFilterableColumn).sort((0, utils_1.sortColumnDefinitions)(columnOrder)).map(createColumnsSettingsOption);
 }
+/**
+ * Отвечает за создание списка колонок в настройках с учётом порядка и всех групп
+ * @function prepareColumnsSettings
+ */
 function prepareColumnsSettings(_ref) {
   let {
     pinnedGroups,

package/dist/cjs/components/Table/utils/getPinnedGroups.d.ts

@@ -4,4 +4,8 @@ export type PinnedGroupsState<TData extends object> = {
     right: ColumnDefinition<TData>[];
     unpinned: ColumnDefinition<TData>[];
 };
+/**
+ * Отвечает за распределение columnDefinitions по возможным pinned группам. Возвращает PinnedGroupsState
+ * @function getPinnedGroups
+ */
 export declare function getPinnedGroups<TData extends object>(columnDefinitions: ColumnDefinition<TData>[]): PinnedGroupsState<TData>;

package/dist/cjs/components/Table/utils/getPinnedGroups.js

@@ -4,6 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getPinnedGroups = getPinnedGroups;
+/**
+ * Отвечает за распределение columnDefinitions по возможным pinned группам. Возвращает PinnedGroupsState
+ * @function getPinnedGroups
+ */
 function getPinnedGroups(columnDefinitions) {
   return columnDefinitions.reduce((accPinnedState, colDef) => {
     switch (colDef.pinned) {

package/dist/cjs/components/Table/utils/getTableColumnsDefinitions.d.ts

@@ -7,5 +7,9 @@ type GetTableColumnsDefinitionsProps<TData extends object> = {
     expanding: TableProps<TData>['expanding'];
     rowSelectionAppearance?: RowAppearance;
 };
+/**
+ * Получение фактического списка columnDefinitions с учётом всевозможных настроек
+ * @function getTableColumnsDefinitions
+ */
 export declare function getTableColumnsDefinitions<TData extends object>({ columnDefinitions, enableSelection, enableSelectPinned, expanding, rowSelectionAppearance, }: GetTableColumnsDefinitionsProps<TData>): ColumnDefinition<TData>[];
 export {};

package/dist/cjs/components/Table/utils/getTableColumnsDefinitions.js

@@ -6,6 +6,10 @@ Object.defineProperty(exports, "__esModule", {
 exports.getTableColumnsDefinitions = getTableColumnsDefinitions;
 const helperComponents_1 = require("../../../helperComponents");
 const types_1 = require("../../types");
+/**
+ * Получение фактического списка columnDefinitions с учётом всевозможных настроек
+ * @function getTableColumnsDefinitions
+ */
 function getTableColumnsDefinitions(_ref) {
   let {
     columnDefinitions,

package/dist/esm/components/Table/hooks/useColumnSettings/utils/isColumnEnabledInitially.d.ts

@@ -1,2 +1,6 @@
 import { ColumnDefinition } from '../../../../../types';
+/**
+ * Проверка на то, должна ли колонка быть включена по умолчанию
+ * @function isColumnEnabledInitially
+ */
 export declare function isColumnEnabledInitially<TData extends object>(colDef: ColumnDefinition<TData>): boolean;

package/dist/esm/components/Table/hooks/useColumnSettings/utils/isColumnEnabledInitially.js

@@ -1,3 +1,7 @@
+/**
+ * Проверка на то, должна ли колонка быть включена по умолчанию
+ * @function isColumnEnabledInitially
+ */
 export function isColumnEnabledInitially(colDef) {
     var _a;
     if ('columnSettings' in colDef && colDef.columnSettings !== undefined) {

package/dist/esm/components/Table/hooks/useColumnSettings/utils/isColumnVisibilityConfigurable.d.ts

@@ -1,2 +1,6 @@
 import { ColumnDefinition } from '../../../../../types';
+/**
+ * Проверка на то, должна ли колонка отображаться в настройках колонок
+ * @function isColumnVisibilityConfigurable
+ */
 export declare function isColumnVisibilityConfigurable<TData extends object>(colDef: ColumnDefinition<TData>): boolean;

package/dist/esm/components/Table/hooks/useColumnSettings/utils/isColumnVisibilityConfigurable.js

@@ -1,3 +1,7 @@
+/**
+ * Проверка на то, должна ли колонка отображаться в настройках колонок
+ * @function isColumnVisibilityConfigurable
+ */
 export function isColumnVisibilityConfigurable(colDef) {
     if ('columnSettings' in colDef && colDef.columnSettings !== undefined) {
         const { mode } = colDef.columnSettings;

package/dist/esm/components/Table/hooks/useColumnSettings/utils/isFilterableColumn.d.ts

@@ -1,2 +1,6 @@
 import { ColumnDefinition, FilterableColumnDefinition } from '../../../../../types';
+/**
+ * Проверка на то, должна ли колонка отображаться в таблице
+ * @function isFilterableColumn
+ */
 export declare function isFilterableColumn<TData extends object>(colDef: ColumnDefinition<TData>): colDef is FilterableColumnDefinition<TData>;

package/dist/esm/components/Table/hooks/useColumnSettings/utils/isFilterableColumn.js

@@ -1,3 +1,7 @@
+/**
+ * Проверка на то, должна ли колонка отображаться в таблице
+ * @function isFilterableColumn
+ */
 export function isFilterableColumn(colDef) {
     var _a;
     return (('id' in colDef || 'accessorKey' in colDef) &&

package/dist/esm/components/Table/hooks/useColumnSettings/utils/prepareColumnsSettings.d.ts

@@ -7,5 +7,9 @@ type PrepareColumnsSettingsProps<TData extends object> = {
     areAllColumnsEnabled: boolean;
     t: ReturnType<typeof useLocale<'Table'>>['t'];
 };
+/**
+ * Отвечает за создание списка колонок в настройках с учётом порядка и всех групп
+ * @function prepareColumnsSettings
+ */
 export declare function prepareColumnsSettings<TData extends object>({ pinnedGroups, columnOrder, areAllColumnsEnabled, t, }: PrepareColumnsSettingsProps<TData>): [GroupSelectItemProps];
 export {};

package/dist/esm/components/Table/hooks/useColumnSettings/utils/prepareColumnsSettings.js

@@ -14,6 +14,10 @@ function createColumnsSettingsOption(columnDefinition) {
 function createGroupOptions(group, columnOrder) {
     return group.filter(isFilterableColumn).sort(sortColumnDefinitions(columnOrder)).map(createColumnsSettingsOption);
 }
+/**
+ * Отвечает за создание списка колонок в настройках с учётом порядка и всех групп
+ * @function prepareColumnsSettings
+ */
 export function prepareColumnsSettings({ pinnedGroups, columnOrder, areAllColumnsEnabled, t, }) {
     return [
         {

package/dist/esm/components/Table/utils/getPinnedGroups.d.ts

@@ -4,4 +4,8 @@ export type PinnedGroupsState<TData extends object> = {
     right: ColumnDefinition<TData>[];
     unpinned: ColumnDefinition<TData>[];
 };
+/**
+ * Отвечает за распределение columnDefinitions по возможным pinned группам. Возвращает PinnedGroupsState
+ * @function getPinnedGroups
+ */
 export declare function getPinnedGroups<TData extends object>(columnDefinitions: ColumnDefinition<TData>[]): PinnedGroupsState<TData>;

package/dist/esm/components/Table/utils/getPinnedGroups.js

@@ -1,3 +1,7 @@
+/**
+ * Отвечает за распределение columnDefinitions по возможным pinned группам. Возвращает PinnedGroupsState
+ * @function getPinnedGroups
+ */
 export function getPinnedGroups(columnDefinitions) {
     return columnDefinitions.reduce((accPinnedState, colDef) => {
         switch (colDef.pinned) {

package/dist/esm/components/Table/utils/getTableColumnsDefinitions.d.ts

@@ -7,5 +7,9 @@ type GetTableColumnsDefinitionsProps<TData extends object> = {
     expanding: TableProps<TData>['expanding'];
     rowSelectionAppearance?: RowAppearance;
 };
+/**
+ * Получение фактического списка columnDefinitions с учётом всевозможных настроек
+ * @function getTableColumnsDefinitions
+ */
 export declare function getTableColumnsDefinitions<TData extends object>({ columnDefinitions, enableSelection, enableSelectPinned, expanding, rowSelectionAppearance, }: GetTableColumnsDefinitionsProps<TData>): ColumnDefinition<TData>[];
 export {};

package/dist/esm/components/Table/utils/getTableColumnsDefinitions.js

@@ -1,5 +1,9 @@
 import { getSelectionCellColumnDef, getTreeColumnDef } from '../../../helperComponents';
 import { RowAppearance } from '../../types';
+/**
+ * Получение фактического списка columnDefinitions с учётом всевозможных настроек
+ * @function getTableColumnsDefinitions
+ */
 export function getTableColumnsDefinitions({ columnDefinitions, enableSelection, enableSelectPinned, expanding, rowSelectionAppearance = RowAppearance.Disabled, }) {
     let cols = columnDefinitions;
     if (enableSelection && !expanding) {

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "title": "Table",
-  "version": "0.37.28",
+  "version": "0.37.29-preview-9d961963.0",
   "sideEffects": [
     "*.css",
     "*.woff",
@@ -65,5 +65,5 @@
   "peerDependencies": {
     "@snack-uikit/locale": "*"
   },
-  "gitHead": "77eb300ff87d91df0f3c12a15f89755eec155599"
+  "gitHead": "d4e277eb1dd29fd832c47807cb4fd46aeb2def2a"
 }

package/src/components/Table/hooks/useColumnSettings/utils/isColumnEnabledInitially.ts

@@ -1,5 +1,9 @@
 import { ColumnDefinition } from '../../../../../types';
 
+/**
+ * Проверка на то, должна ли колонка быть включена по умолчанию
+ * @function isColumnEnabledInitially
+ */
 export function isColumnEnabledInitially<TData extends object>(colDef: ColumnDefinition<TData>) {
   if ('columnSettings' in colDef && colDef.columnSettings !== undefined) {
     return colDef.columnSettings?.mode !== 'defaultFalse';

package/src/components/Table/hooks/useColumnSettings/utils/isColumnVisibilityConfigurable.ts

@@ -1,5 +1,9 @@
 import { ColumnDefinition } from '../../../../../types';
 
+/**
+ * Проверка на то, должна ли колонка отображаться в настройках колонок
+ * @function isColumnVisibilityConfigurable
+ */
 export function isColumnVisibilityConfigurable<TData extends object>(colDef: ColumnDefinition<TData>): boolean {
   if ('columnSettings' in colDef && colDef.columnSettings !== undefined) {
     const { mode } = colDef.columnSettings;

package/src/components/Table/hooks/useColumnSettings/utils/isFilterableColumn.ts

@@ -1,5 +1,8 @@
 import { ColumnDefinition, FilterableColumnDefinition } from '../../../../../types';
-
+/**
+ * Проверка на то, должна ли колонка отображаться в таблице
+ * @function isFilterableColumn
+ */
 export function isFilterableColumn<TData extends object>(
   colDef: ColumnDefinition<TData>,
 ): colDef is FilterableColumnDefinition<TData> {

package/src/components/Table/hooks/useColumnSettings/utils/prepareColumnsSettings.ts

@@ -30,6 +30,10 @@ type PrepareColumnsSettingsProps<TData extends object> = {
   t: ReturnType<typeof useLocale<'Table'>>['t'];
 };
 
+/**
+ * Отвечает за создание списка колонок в настройках с учётом порядка и всех групп
+ * @function prepareColumnsSettings
+ */
 export function prepareColumnsSettings<TData extends object>({
   pinnedGroups,
   columnOrder,

package/src/components/Table/utils/getPinnedGroups.ts

@@ -6,6 +6,10 @@ export type PinnedGroupsState<TData extends object> = {
   unpinned: ColumnDefinition<TData>[];
 };
 
+/**
+ * Отвечает за распределение columnDefinitions по возможным pinned группам. Возвращает PinnedGroupsState
+ * @function getPinnedGroups
+ */
 export function getPinnedGroups<TData extends object>(columnDefinitions: ColumnDefinition<TData>[]) {
   return columnDefinitions.reduce(
     (accPinnedState: PinnedGroupsState<TData>, colDef: ColumnDefinition<TData>) => {

package/src/components/Table/utils/getTableColumnsDefinitions.ts

@@ -10,6 +10,10 @@ type GetTableColumnsDefinitionsProps<TData extends object> = {
   rowSelectionAppearance?: RowAppearance;
 };
 
+/**
+ * Получение фактического списка columnDefinitions с учётом всевозможных настроек
+ * @function getTableColumnsDefinitions
+ */
 export function getTableColumnsDefinitions<TData extends object>({
   columnDefinitions,
   enableSelection,

package/src/helperComponents/ColumnsSettings/ColumnsSettings.tsx

@@ -3,6 +3,7 @@ import { FunctionSettingsSVG } from '@snack-uikit/icons';
 import { Droplist, GroupSelectItemProps } from '@snack-uikit/list';
 
 import styles from './styles.module.scss';
+
 export type ColumnsSettingsProps = {
   enabledColumns: string[];
   setEnabledColumns(enabledColumns: string[]): void;