From ceff5a8c75376d512a23e2656751e99057ad773d Mon Sep 17 00:00:00 2001 From: timofeyevvv Date: Fri, 27 Dec 2024 16:51:17 +0300 Subject: [PATCH] fix: fixed after github conversation --- README-ru.md | 54 +++++++++++++++++++++++++--------------------------- 1 file changed, 26 insertions(+), 28 deletions(-) diff --git a/README-ru.md b/README-ru.md index bb9c906..b8a77b0 100644 --- a/README-ru.md +++ b/README-ru.md @@ -64,30 +64,30 @@ interface DashKitProps { } ``` -- `config` — [кофигурация](#Config). -- `editMode`— включает или отключает режим редактирования. -- `onItemEdit` – вызывается по клику для редактирования виджета. -- `onChange` — вызывается при изменении значения `config` или [`itemsStateAndParams`](#itemsStateAndParams). -- `onDrop` — вызывается, когда элемент перетаскивается из `ActionPanel` (панели действий) с помощью `(#DashKitDnDWrapper)`. -- `onItemMountChange` — вызывается при изменении состояния монтирования элемента. -- `onItemRender` — вызывается по завершении рендеринга элемента. -- `defaultGlobalParams`, `globalParams` — [параметры](#Params), которые влияют на все виджеты. В DataLens `defaultGlobalParams` — глобальные параметры, заданные в настройках дашборда, а `globalParams` — глобальные параметры, которые можно задать в URL. -- `itemsStateAndParams` — [itemsStateAndParams](#itemsStateAndParams). -- `settings` — настройки `DashKit`. +- `config`: [кофигурация](#Config). +- `editMode`: включает или отключает режим редактирования. +- `onItemEdit`: вызывается по клику для редактирования виджета. +- `onChange`: вызывается при изменении значения `config` или [`itemsStateAndParams`](#itemsstateandparams). +- `onDrop`: вызывается, когда элемент перетаскивается из `ActionPanel` (панели действий) с помощью `(#DashKitDnDWrapper)`. +- `onItemMountChange`: вызывается при изменении состояния монтирования элемента. +- `onItemRender`: вызывается по завершении рендеринга элемента. +- `defaultGlobalParams`, `globalParams`: [параметры](#Params), которые влияют на все виджеты. В DataLens `defaultGlobalParams` — глобальные параметры, заданные в настройках дашборда, а `globalParams` — глобальные параметры, которые можно задать в URL. +- `itemsStateAndParams`: [itemsStateAndParams](#itemsstateandparams). +- `settings`: настройки `DashKit`. - `context`: объект, который пробросится в виде свойства во все виджеты. -- `overlayControls` — объект, который переопределяет контролы виджета в момент редактирования. Если он не передан, будут отображаться базовые контролы. При передаче `null` будет отображаться только кнопка закрытия или пользовательское меню. -- `overlayMenuItems` — пользовательские элементы выпадающего меню. -- `noOverlay` — если установлено значение `true`, оверлей и контролы не отображаются при редактировании. -- `focusable` — если установлено значение `true`, элементы сетки будут доступны для фокуса. -- `draggableHandleClassName` — имя CSS-класса элемента, который позволяет перетаскивать виджет. -- `onDragStart` — вызывается при начале перетаскивания элемента в библиотеке `ReactGridLayout`. -- `onDrag` — вызывается во время перетаскивания элемента в библиотеке `ReactGridLayout`. -- `onDragStop` — вызывается по завершении перетаскивания элемента в библиотеке `ReactGridLayout`. -- `onResizeStart` — вызывается при начале изменения размера элемента в библиотеке ReactGridLayout. -- `onResize` — вызывается в процессе изменения размера элемента в библиотеке `ReactGridLayout`. -- `onResizeStop` — вызывается по завершении изменения размера элемента в библиотеке `ReactGridLayout`. -- `getPreparedCopyItemOptions` — вызывается для преобразования скопированного элемента в сериализуемый объект перед его сохранением в локальное хранилище. Используется вместо устаревшего свойства `context.getPreparedCopyItemOptions`. -- `onCopyFulfill` — вызывается при завершении копирования элемента. При успешном копировании передается `error=null` и определенное значение `data`, при неудачном копировании — `error: Error` без `data`. +- `overlayControls`: объект, который переопределяет дефолтные контролы виджета, отображаемые в режиме редактирования. Если он не передан, будут отображаться базовые контролы. При передаче `null` будет отображаться только кнопка закрытия или пользовательское меню. +- `overlayMenuItems`: пользовательские элементы выпадающего меню, отображаемое в режиме редактирования. +- `noOverlay`: если установлено значение `true`, оверлей и контролы не отображаются при редактировании. +- `focusable`: если установлено значение `true`, элементы сетки будут доступны для фокуса. +- `draggableHandleClassName`: имя CSS-класса элемента, который позволяет перетаскивать виджет. +- `onDragStart`: вызывается при начале перетаскивания элемента в библиотеке `ReactGridLayout`. +- `onDrag`: вызывается во время перетаскивания элемента в библиотеке `ReactGridLayout`. +- `onDragStop`: вызывается по завершении перетаскивания элемента в библиотеке `ReactGridLayout`. +- `onResizeStart`: вызывается при начале изменения размера элемента в библиотеке ReactGridLayout. +- `onResize`: вызывается в процессе изменения размера элемента в библиотеке `ReactGridLayout`. +- `onResizeStop`: вызывается по завершении изменения размера элемента в библиотеке `ReactGridLayout`. +- `getPreparedCopyItemOptions`: вызывается для преобразования скопированного элемента в сериализуемый объект перед его сохранением в локальное хранилище. Используется вместо устаревшего свойства `context.getPreparedCopyItemOptions`. +- `onCopyFulfill`: вызывается при завершении копирования элемента. При успешном копировании передается `error=null` и определенное значение `data`, при неудачном копировании — `error: Error` без `data`. ## Использование @@ -329,7 +329,7 @@ type Params = Record; 1. `defaultGlobalParams`. 2. Параметры виджета, используемые по умолчанию, — `item.default`. 3. `globalParams`. -4. Параметры из [`itemsStateAndParams`](#itemsStateAndParams), согласно очереди. +4. Параметры из [`itemsStateAndParams`](#itemsstateandparams), согласно очереди. ### `itemsStateAndParams` @@ -362,7 +362,7 @@ type ItemsStateAndParams = StateAndParamsMeta & ItemsStateAndParamsBase; ### Меню -В режиме редактирования можно задать пользовательское меню оверлея для виджета `DashKit`. +Можно задать пользовательские элементы выпадающего меню оверлея `DashKit` виджета, которое отображается в режиме редактирования. ```ts type MenuItem = { @@ -428,8 +428,7 @@ type ItemDropProps = { }; ``` - -#### Например: +#### Например ```jsx const overlayMenuItems = [ @@ -521,7 +520,6 @@ const CustomThemeWrapper = (props: { По умолчанию Storybook запускается на `http://localhost:7120/`. В некоторых случаях при запущенном storybook свежие изменения из проекта могут не примениться. В таких ситуациях следует пересобрать проект вручную и перезапустить Storybook. - ### Пример конфигурации nginx для разработки на dev-машине ```bash