@cloud-ru/ds-toolbar 1.0.8-preview-61ab169d.0 → 1.0.8-preview-4074f7f8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +110 -7
  2. package/package.json +12 -12
package/README.md CHANGED
@@ -197,25 +197,128 @@ export function WithDataView() {
197
197
  | Prop | Type | Default | Description |
198
198
  |------|------|---------|-------------|
199
199
  | `after` | `ReactNode` | — | Дополнительный слот между поиском и переключателем вида (+ slotExtraButton в Figma). <br> <br/> На mobile-раскладке (из `AdaptiveProvider`) не рендерится в строке — кнопки переносятся в меню «⋯» <br/> (`Button` с `onClick` и `label` / `icon` / `aria-label`, одна обёртка вокруг кнопки <br/> или элемент с `data-toolbar-after-overflow`). Иначе — в `moreActions`. |
200
- | `api` | `ToolbarApi` | — | Бэкенд команд: WYSIWYG (TipTap) в preview-режиме либо markdown-исходник (textarea) в raw-режиме. |
201
- | `bulkActions` | `BulkAction[]` | — | Список массовых действий |
200
+ | `bulkActions` | `BulkActionsProps` | — | Список массовых действий |
202
201
  | `checked` | `boolean` | — | Значение чекбокса |
203
202
  | `className` | `string` | — | Класснейм |
204
203
  | `data-test-id` | `string` | — | |
205
- | `dataView` | `ToolbarDataViewProps` | — | Переключатель вида данных — SegmentControl (showDataView в Figma) |
206
- | `filterRow` | `FilterRow<TState>` | — | |
204
+ | `dataView` | `DataViewBaseProps` \| `ToolbarDataViewProps` | — | Переключатель вида данных — SegmentControl (showDataView в Figma) |
205
+ | `filterRow` | `FilterRow` | — | |
207
206
  | `indeterminate` | `boolean` | — | Состояние частичного выбора |
208
- | `items` | `ToolbarItemId` | — | |
209
- | `moreActions` | `Action[]` | — | Элементы выпадающего списка кнопки с действиями |
207
+ | `moreActions` | `MoreActionsProps` | — | Элементы выпадающего списка кнопки с действиями |
210
208
  | `onCheck` | `(() => void)` | — | Колбек смены значения чекбокса |
211
209
  | `onRefresh` | `(() => void)` | — | Колбек обновления |
212
210
  | `outline` | `boolean` | `true` | Внешний бордер |
213
- | `persist` | `ToolbarPersistConfig<TState>` | — | Конфиг для сохранения состояния в localStorage и queryParams. <br> <br/> Поле id должно быть уникальным для каждого инстанса компонента. <br> |
211
+ | `persist` | `ToolbarPersistConfig` | — | Конфиг для сохранения состояния в localStorage и queryParams. <br> <br/> Поле id должно быть уникальным для каждого инстанса компонента. <br> |
214
212
  | `search` | `SearchProps` | — | Параметры отвечают за строку поиска <br> <br/> <strong>value</strong>: Значение строки поиска <br> <br/> <strong>onChange</strong>: Колбэк смены значения <br> <br/> <strong>onSubmit</strong>: Колбэк на подтверждение поиска по строке <br/> <strong>placeholder</strong>: Плейсхолдер <br> <br/> <strong>loading</strong>: Состояние загрузки <br> |
215
213
  | `selectedCount` | `number` | — | Количество выбранных элементов (для подписи Selected: N) |
216
214
  | `showBulkCheckbox` | `boolean` | `true` | Показывать чекбокс слева (Figma: showBulkCheckbox) |
217
215
  | `totalCount` | `number` | — | Общее количество элементов (для подписи Selected: N of M) |
218
216
 
217
+ #### Related types
218
+
219
+ **Action**
220
+
221
+ | Prop | Type | Default | Description |
222
+ |------|------|---------|-------------|
223
+ | `content` | `ItemContent` | — | Основной контент айтема |
224
+ | `data-test-id` | `string \| undefined` | — | |
225
+ | `disabled` | `boolean \| undefined` | — | Флаг неактивности элемента |
226
+ | `icon` | `string \| number \| boolean \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal \| null \| undefined` | — | |
227
+ | `onClick` | `((e: MouseEvent<HTMLElement>) => void) \| undefined` | — | Колбек обработки клика |
228
+ | `tagLabel` | `string \| undefined` | — | |
229
+
230
+ **BulkAction**
231
+
232
+ | Prop | Type | Default | Description |
233
+ |------|------|---------|-------------|
234
+ | `data-test-id` | `string \| undefined` | — | |
235
+ | `disabled` | `boolean \| undefined` | — | |
236
+ | `icon` | `((props: { className?: string; }, deprecatedLegacyContext?: any) => ReactNode) \| (new (props: { className?: string; }, deprecatedLegacyContext?: any) => Component<any, any>)` | — | |
237
+ | `label` | `string` | — | |
238
+ | `onClick` | `(() => void) \| undefined` | — | |
239
+ | `tooltip` | `TooltipProps` | — | |
240
+
241
+ **BulkActionsProps**
242
+
243
+ | Prop | Type | Default | Description |
244
+ |------|------|---------|-------------|
245
+ | `actions` | `BulkAction` | — | Список массовых действий |
246
+ | `checked` | `boolean \| undefined` | — | Значение чекбокса |
247
+ | `data-test-id` | `string \| undefined` | — | |
248
+ | `indeterminate` | `boolean \| undefined` | — | Состояние частичного выбора |
249
+ | `onCheck` | `(() => void) \| undefined` | — | Колбек смены значения чекбокса |
250
+ | `selectedCount` | `number \| undefined` | — | Количество выбранных элементов (для подписи Selected: N) |
251
+ | `showBulkCheckbox` | `boolean \| undefined` | — | Показывать чекбокс слева (Figma: showBulkCheckbox) |
252
+ | `totalCount` | `number \| undefined` | — | Общее количество элементов (для подписи Selected: N of M) |
253
+
254
+ **DataViewBaseProps**
255
+
256
+ | Prop | Type | Default | Description |
257
+ |------|------|---------|-------------|
258
+ | `defaultValue` | `"compact"` \| `"list"` | — | |
259
+ | `items` | `DataViewValue` \| `Segment` \| `SegmentControlProps` | — | |
260
+ | `onChange` | `((value: DataViewValue) => void) \| undefined` | — | |
261
+ | `value` | `"compact"` \| `"list"` | — | |
262
+
263
+ - `DataViewValue` = `"compact"` \| `"list"`
264
+
265
+ **FilterRow**
266
+
267
+ | Prop | Type | Default | Description |
268
+ |------|------|---------|-------------|
269
+ | `className` | `string \| undefined` | — | CSS-класс |
270
+ | `defaultValue` | `Partial<TState> \| undefined` | — | Начальное состояние фильтров |
271
+ | `filters` | `BaseChipProps` \| `ChipChoiceDateWithSeconds` \| `ChipChoiceRowFilter` \| `DropdownBridgeProps` \| `DroplistListProps` \| `DroplistMobileSlots` \| `EmptyState` \| `PublicListContextType` \| `ScrollProps` \| `SelectionMultipleState` \| `SelectionSingleState` \| `SelectionState` | — | Массив чипов |
272
+ | `initialOpen` | `boolean \| undefined` | — | Начальное состояние filter-row (mobile) |
273
+ | `onChange` | `((filters: TState) => void) \| undefined` | — | Колбек изменения состояния фильтров |
274
+ | `onOpenChange` | `((isOpen: boolean) => void) \| undefined` | — | |
275
+ | `onVisibleFiltersChange` | `((value: string[]) => void) \| undefined` | — | Коллбек на изменение видимых фильтров |
276
+ | `open` | `boolean \| undefined` | — | |
277
+ | `showAddButton` | `boolean \| undefined` | — | Скрыть/показать кнопку добавления фильров |
278
+ | `showClearButton` | `boolean \| undefined` | — | Скрыть/показать кнопку очиски фильтров |
279
+ | `value` | `TState \| undefined` | — | Состояние фильтров |
280
+ | `visibleFilters` | `string[] \| undefined` | — | Состояние для видимых фильтров |
281
+
282
+ **MoreActionsProps**
283
+
284
+ | Prop | Type | Default | Description |
285
+ |------|------|---------|-------------|
286
+ | `data-test-id` | `string \| undefined` | — | |
287
+ | `moreActions` | `Action` | — | Элементы выпадающего списка кнопки с действиями |
288
+
289
+ **SearchProps**
290
+
291
+ | Prop | Type | Default | Description |
292
+ |------|------|---------|-------------|
293
+ | `loading` | `boolean \| undefined` | — | |
294
+ | `onChange` | `(value: string) => void` | — | |
295
+ | `onSubmit` | `((value: string) => void) \| undefined` | — | |
296
+ | `placeholder` | `string \| undefined` | — | |
297
+ | `value` | `string` | — | |
298
+
299
+ **ToolbarDataViewProps**
300
+
301
+ | Prop | Type | Default | Description |
302
+ |------|------|---------|-------------|
303
+ | `data-test-id` | `string \| undefined` | — | |
304
+ | `defaultValue` | `"compact"` \| `"list"` | — | |
305
+ | `items` | `DataViewValue` \| `Segment` \| `SegmentControlProps` | — | |
306
+ | `onChange` | `((value: DataViewValue) => void) \| undefined` | — | |
307
+ | `show` | `boolean \| undefined` | — | Показать переключатель вида. Если `dataView` не передан — равносильно `show: false` |
308
+ | `value` | `"compact"` \| `"list"` | — | |
309
+
310
+ **ToolbarPersistConfig**
311
+
312
+ | Prop | Type | Default | Description |
313
+ |------|------|---------|-------------|
314
+ | `filterQueryKey` | `string \| undefined` | — | Ключ для queryParams |
315
+ | `id` | `string \| undefined` | — | Уникальный id для текущего инстанса компонента |
316
+ | `onLoad` | `((state: PersistedFilterState<T>) => void) \| undefined` | — | Колбэк при первом рендере для получения сохраненных данных и установки их в стейт |
317
+ | `parser` | `((value: string) => PersistedFilterState<T>) \| undefined` | — | Custom-парсер queryParams для преобразования в данные состояния |
318
+ | `serializer` | `((value: PersistedFilterState<T>) => string) \| undefined` | — | Custom-сериализация состояния перед сохранением в queryParams |
319
+ | `state` | `PersistedFilterState` | — | Состояние для сохранения |
320
+ | `validateData` | `((value: unknown) => value is PersistedFilterState<T>) \| undefined` | — | Валидатор сохраненных |
321
+
219
322
  ## Смотри также
220
323
 
221
324
  - **`Search`** — поле поиска внутри тулбара (`background={false}`).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cloud-ru/ds-toolbar",
3
- "version": "1.0.8-preview-61ab169d.0",
3
+ "version": "1.0.8-preview-4074f7f8.0",
4
4
  "description": "Панель инструментов списков и таблиц — поиск, фильтры, массовые действия, меню «Ещё».",
5
5
  "repository": {
6
6
  "type": "git",
@@ -42,21 +42,21 @@
42
42
  "@cloud-ru/ft-request-payload-transform": "^0.3.0",
43
43
  "classnames": "^2.5.1",
44
44
  "@cloud-ru/ds-adaptive": "1.0.1",
45
- "@cloud-ru/ds-bottom-sheet": "1.0.3-preview-61ab169d.0",
46
- "@cloud-ru/ds-chips": "1.0.7-preview-61ab169d.0",
45
+ "@cloud-ru/ds-bottom-sheet": "1.0.3-preview-4074f7f8.0",
47
46
  "@cloud-ru/ds-button": "1.0.1",
48
- "@cloud-ru/ds-icons": "1.0.2-preview-61ab169d.0",
49
- "@cloud-ru/ds-list": "2.0.1-preview-61ab169d.0",
47
+ "@cloud-ru/ds-chips": "1.0.7-preview-4074f7f8.0",
48
+ "@cloud-ru/ds-list": "2.0.1-preview-4074f7f8.0",
49
+ "@cloud-ru/ds-icons": "1.0.2-preview-4074f7f8.0",
50
50
  "@cloud-ru/ds-locale": "1.0.0",
51
+ "@cloud-ru/ds-materials": "1.0.1",
51
52
  "@cloud-ru/ds-portal-context": "1.0.1",
53
+ "@cloud-ru/ds-search": "1.0.3-preview-4074f7f8.0",
52
54
  "@cloud-ru/ds-scroll": "1.0.1",
53
- "@cloud-ru/ds-materials": "1.0.1",
54
- "@cloud-ru/ds-segment-control": "1.0.3-preview-61ab169d.0",
55
- "@cloud-ru/ds-tag": "1.0.4-preview-61ab169d.0",
56
- "@cloud-ru/ds-theme": "1.0.1-preview-61ab169d.0",
57
- "@cloud-ru/ds-search": "1.0.3-preview-61ab169d.0",
58
- "@cloud-ru/ds-tooltip": "1.0.3-preview-61ab169d.0",
59
- "@cloud-ru/ds-toggles": "1.1.2-preview-61ab169d.0",
55
+ "@cloud-ru/ds-segment-control": "1.0.3-preview-4074f7f8.0",
56
+ "@cloud-ru/ds-tag": "1.0.4-preview-4074f7f8.0",
57
+ "@cloud-ru/ds-theme": "1.0.1-preview-4074f7f8.0",
58
+ "@cloud-ru/ds-toggles": "1.1.2-preview-4074f7f8.0",
59
+ "@cloud-ru/ds-tooltip": "1.0.3-preview-4074f7f8.0",
60
60
  "@cloud-ru/ds-utils": "1.1.0"
61
61
  },
62
62
  "publishConfig": {