@snack-uikit/table 0.8.6 → 0.8.7-preview-48fde6f4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -22
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -107,33 +107,12 @@ const columnDefinitions: ColumnDefinition<TableData>[] = [
|
|
|
107
107
|
### Props
|
|
108
108
|
| name | type | default value | description |
|
|
109
109
|
|------|------|---------------|-------------|
|
|
110
|
-
| columnDefinitions* | `ColumnDefinition<TData>[]` | - | Определение внешнего вида и функционала колонок |
|
|
111
|
-
| data* | `TData[]` | - | Данные для отрисовки |
|
|
112
|
-
| sorting | `{ initialState?: SortingState; state?: SortingState; onChange?(state: SortingState): void; }` | - | Параметры отвечают за возможность сортировки, их стоит использовать если нужно отслеживать состояние <br> <strong>initialState</strong>: Начальное состояние сортировки <br> <strong>state</strong>: Состояние сортировки, жестко устанавливаемое снаружи <br> <strong>onChange</strong>: Колбэк на изменение сортировки |
|
|
113
|
-
| 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>: Колбэк на выбор строк |
|
|
114
|
-
| 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 строки поиска |
|
|
115
|
-
| pageSize | `number` | 10 | Максимальное кол-во строк на страницу |
|
|
116
|
-
| 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>: Текст для селектора кол-ва строк на страницу |
|
|
117
|
-
| pageCount | `number` | - | Кол-во страниц (используется для внешнего управления) |
|
|
118
|
-
| onRowClick | `RowClickHandler<TData>` | - | Колбэк клика по строке |
|
|
119
|
-
| className | `string` | - | CSS-класс |
|
|
120
|
-
| loading | `boolean` | - | Состояние загрузки |
|
|
121
|
-
| onRefresh | `() => void` | - | Колбек обновления данных |
|
|
122
|
-
| onDelete | `(selectionState: RowSelectionState, resetRowSelection: (defaultState?: boolean) => void) => void` | - | Колбек удаления выбранных |
|
|
123
|
-
| outline | `boolean` | - | Внешний бордер для тулбара и таблицы |
|
|
124
|
-
| columnFilters | `ReactNode` | - | Фильтры |
|
|
125
|
-
| exportFileName | `string` | - | Название файла при экспорте CSV/XLSX |
|
|
126
|
-
| moreActions | `Pick<DroplistItemSingleProps, "option" \| "caption" \| "description" \| "tagLabel" \| "disabled" \| "icon" \| "onClick">[]` | - | Элементы выпадающего списка кнопки с действиями |
|
|
127
|
-
| noDataState | `TableEmptyStateProps` | { icon: CrossSVG, appearance: 'red', title: 'Data collection error', description: 'Try refreshing the page', } as const | Экран при отстутствии данных |
|
|
128
|
-
| noResultsState | `TableEmptyStateProps` | { icon: SearchSVG, appearance: 'neutral', title: 'Not found', description: 'Try entering another query', } as const | Экран при отстутствии результатов поиска |
|
|
129
|
-
| suppressToolbar | `boolean` | - | Отключение тулбара |
|
|
130
|
-
| suppressPagination | `boolean` | - | Отключение пагинации |
|
|
131
110
|
## Table.getStatusColumnDef
|
|
132
111
|
Вспомогательная функция для создания ячейки со статусом
|
|
133
112
|
### Props
|
|
134
113
|
| name | type | default value | description |
|
|
135
114
|
|------|------|---------------|-------------|
|
|
136
|
-
| mapStatusToAppearance* | `(value: string \| number) =>
|
|
115
|
+
| mapStatusToAppearance* | `(value: string \| number) => ValueOf<{ readonly Primary: "primary"; readonly Neutral: "neutral"; readonly Red: "red"; readonly Orange: "orange"; readonly Yellow: "yellow"; readonly Green: "green"; readonly Blue: "blue"; readonly Violet: "violet"; readonly Pink: "pink"; readonly Loading: "loading"; }>` | - | Маппинг значений статуса на цвета |
|
|
137
116
|
| accessorKey* | `string` | - | Имя ключа соответствующее полю в data |
|
|
138
117
|
| enableSorting | `boolean` | - | Включение/выключение сортировки |
|
|
139
118
|
| renderDescription | `(cellValue: string) => string` | - | Функция для отрисовки текста, если не передана, то будет отрисован только индикатор статуса |
|
package/package.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"access": "public"
|
|
5
5
|
},
|
|
6
6
|
"title": "Table",
|
|
7
|
-
"version": "0.8.
|
|
7
|
+
"version": "0.8.7-preview-48fde6f4.0",
|
|
8
8
|
"sideEffects": [
|
|
9
9
|
"*.css",
|
|
10
10
|
"*.woff",
|
|
@@ -32,9 +32,6 @@
|
|
|
32
32
|
],
|
|
33
33
|
"license": "Apache-2.0",
|
|
34
34
|
"scripts": {},
|
|
35
|
-
"bundledDependencies": [
|
|
36
|
-
"xlsx"
|
|
37
|
-
],
|
|
38
35
|
"dependencies": {
|
|
39
36
|
"@snack-uikit/button": "0.15.0",
|
|
40
37
|
"@snack-uikit/chips": "0.10.3",
|
|
@@ -55,5 +52,8 @@
|
|
|
55
52
|
"uncontrollable": "8.0.0",
|
|
56
53
|
"xlsx": "file:vendor/xlsx-0.20.1.tgz"
|
|
57
54
|
},
|
|
58
|
-
"
|
|
55
|
+
"bundleDependencies": [
|
|
56
|
+
"xlsx"
|
|
57
|
+
],
|
|
58
|
+
"gitHead": "e46378ca7cb736a21a987fe5afd45a8ad3bee55e"
|
|
59
59
|
}
|