@gravity-ui/dashkit 8.1.0 → 8.2.0

package/build/esm/components/Item/Item.css

@@ -1,4 +1,4 @@
-.dashkit-item__renderer {
+.dashkit-item__placeholder, .dashkit-item__renderer {
   position: absolute;
   inset: 0;
 }

package/build/esm/components/Item/Item.d.ts

@@ -56,6 +56,7 @@ declare const _default: {
         width: PropTypes.Requireable<number>;
         height: PropTypes.Requireable<number>;
         transform: PropTypes.Requireable<string>;
+        isPlaceholder: PropTypes.Requireable<boolean>;
         forwardedPluginRef: PropTypes.Requireable<any>;
     };
     contextType: React.Context<any>;

package/build/esm/components/Item/Item.js

@@ -5,11 +5,16 @@ import { cn } from '../../utils/cn';
 import './Item.css';
 const b = cn('dashkit-item');
 // TODO: getDerivedStateFromError и заглушка с ошибкой
-const Item = ({ registerManager, rendererProps, type, forwardedPluginRef }) => {
+const Item = ({ registerManager, rendererProps, type, isPlaceholder, forwardedPluginRef }) => {
+    var _a, _b;
     if (!registerManager.check(type)) {
         console.warn(`type [${type}] не зарегистрирован`);
         return null;
     }
+    if (isPlaceholder) {
+        return (React.createElement("div", { className: b('placeholder') }, ((_b = (_a = registerManager
+            .getItem(type)).placeholderRenderer) === null || _b === void 0 ? void 0 : _b.call(_a, rendererProps, forwardedPluginRef)) || null));
+    }
     return (React.createElement("div", { className: b('renderer') }, registerManager.getItem(type).renderer(rendererProps, forwardedPluginRef)));
 };
 Item.propTypes = {
@@ -17,5 +22,6 @@ Item.propTypes = {
     rendererProps: PropTypes.object,
     registerManager: PropTypes.object,
     type: PropTypes.string,
+    isPlaceholder: PropTypes.bool,
 };
 export default prepareItem(Item);

package/build/esm/components/OverlayControls/OverlayControls.js

@@ -180,8 +180,8 @@ class OverlayControls extends React.Component {
                 };
             });
         items = items.filter(Boolean);
-        return (React.createElement(DropdownMenu, { items: items, switcher: React.createElement(Button, { view: view, size: size, pin: "brick-round", qa: "dashkit-overlay-control-menu" },
-                React.createElement(Icon, { data: DotsIcon, size: "16" })) }));
+        return (React.createElement(DropdownMenu, { items: items, renderSwitcher: (props) => (React.createElement(Button, Object.assign({}, props, { view: view, size: size, pin: "brick-round", qa: "dashkit-overlay-control-menu" }),
+                React.createElement(Icon, { data: DotsIcon, size: "16" }))) }));
     }
     getControlItemPinStyle(index, itemsLength) {
         const isOnlyOneItem = itemsLength === 1;

package/build/esm/components/index.d.ts

@@ -2,3 +2,4 @@ export * from './DashKit';
 export type { OverlayControlItem, PreparedCopyItemOptions } from './OverlayControls/OverlayControls';
 export * from './ActionPanel/ActionPanel';
 export type { ActionPanelItem, ActionPanelProps } from './ActionPanel/types';
+export * from './DashKitDnDWrapper/DashKitDnDWrapper';

package/build/esm/components/index.js

@@ -1,2 +1,3 @@
 export * from './DashKit';
 export * from './ActionPanel/ActionPanel';
+export * from './DashKitDnDWrapper/DashKitDnDWrapper';

package/build/esm/constants/common.d.ts

@@ -1,8 +1,12 @@
 export declare const COPIED_WIDGET_STORE_KEY = "dashCopiedItem";
 export declare const DEFAULT_NAMESPACE = "default";
 export declare const OVERLAY_CONTROLS_CLASS_NAME = "dashkit-overlay-controls";
+export declare const OVERLAY_CLASS_NAME = "dashkit-grid-item__overlay";
+export declare const TEMPORARY_ITEM_ID = "__dropping-elem__";
 export declare const MenuItems: {
     readonly Copy: "copy";
     readonly Delete: "delete";
     readonly Settings: "settings";
 };
+export declare const DEFAULT_WIDGET_HEIGHT = 3;
+export declare const DEFAULT_WIDGET_WIDTH = 3;

package/build/esm/constants/common.js

@@ -1,8 +1,12 @@
 export const COPIED_WIDGET_STORE_KEY = 'dashCopiedItem';
 export const DEFAULT_NAMESPACE = 'default';
 export const OVERLAY_CONTROLS_CLASS_NAME = 'dashkit-overlay-controls';
+export const OVERLAY_CLASS_NAME = 'dashkit-grid-item__overlay';
+export const TEMPORARY_ITEM_ID = '__dropping-elem__';
 export const MenuItems = {
     Copy: 'copy',
     Delete: 'delete',
     Settings: 'settings',
 };
+export const DEFAULT_WIDGET_HEIGHT = 3;
+export const DEFAULT_WIDGET_WIDTH = 3;

package/build/esm/context/DashKitContext.d.ts

@@ -1,2 +1,3 @@
 export const DashKitContext: React.Context<any>;
+export const DashKitDnDContext: React.Context<any>;
 import React from 'react';

package/build/esm/context/DashKitContext.js

@@ -1,3 +1,4 @@
 import React from 'react';
 const DashKitContext = React.createContext();
-export { DashKitContext };
+const DashKitDnDContext = React.createContext();
+export { DashKitContext, DashKitDnDContext };

package/build/esm/hocs/prepareItem.d.ts

@@ -56,6 +56,7 @@ export function prepareItem(Component: any): {
         width: PropTypes.Requireable<number>;
         height: PropTypes.Requireable<number>;
         transform: PropTypes.Requireable<string>;
+        isPlaceholder: PropTypes.Requireable<boolean>;
         forwardedPluginRef: PropTypes.Requireable<any>;
     };
     contextType: React.Context<any>;

package/build/esm/hocs/prepareItem.js

@@ -22,7 +22,7 @@ export function prepareItem(Component) {
                 return true;
             }
             render() {
-                const { id, width, height, item, adjustWidgetLayout, layout } = this.props;
+                const { id, width, height, item, adjustWidgetLayout, layout, isPlaceholder } = this.props;
                 const { itemsState, itemsParams, registerManager, settings, context, editMode } = this.context;
                 const { type, data, defaults, namespace } = item;
                 const rendererProps = {
@@ -41,8 +41,9 @@ export function prepareItem(Component) {
                     layout,
                     gridLayout: registerManager.gridLayout,
                     adjustWidgetLayout,
+                    isPlaceholder,
                 };
-                return (React.createElement(Component, { forwardedPluginRef: this.props.forwardedPluginRef, rendererProps: rendererProps, registerManager: registerManager, type: type }));
+                return (React.createElement(Component, { forwardedPluginRef: this.props.forwardedPluginRef, rendererProps: rendererProps, registerManager: registerManager, type: type, isPlaceholder: isPlaceholder }));
             }
         },
         _a.propTypes = {
@@ -54,6 +55,7 @@ export function prepareItem(Component) {
             width: PropTypes.number,
             height: PropTypes.number,
             transform: PropTypes.string,
+            isPlaceholder: PropTypes.bool,
             forwardedPluginRef: PropTypes.any,
         },
         _a.contextType = DashKitContext,

package/build/esm/hocs/withContext.js

@@ -1,6 +1,7 @@
 import React from 'react';
 import isEqual from 'lodash/isEqual';
-import { DashKitContext } from '../context/DashKitContext';
+import { DEFAULT_WIDGET_HEIGHT, DEFAULT_WIDGET_WIDTH, TEMPORARY_ITEM_ID } from '../constants/common';
+import { DashKitContext, DashKitDnDContext } from '../context/DashKitContext';
 import { getItemsParams, getItemsState } from '../shared';
 import { UpdateManager } from '../utils';
 function useMemoStateContext(props) {
@@ -11,6 +12,10 @@ function useMemoStateContext(props) {
     // (высота) из конфига будет запоминаться в originalLayouts, новое значение высоты в adjustedLayouts
     const originalLayouts = React.useRef({});
     const adjustedLayouts = React.useRef({});
+    const [temporaryLayout, setTemporaryLayout] = React.useState(null);
+    const resetTemporaryLayout = React.useCallback(() => setTemporaryLayout(null), [setTemporaryLayout]);
+    const dndContext = React.useContext(DashKitDnDContext);
+    const outerDnDEnable = Boolean(dndContext);
     // TODO: need move originalLayouts, adjustedLayouts to state
     const [layoutUpdateCounter, forceUpdateLayout] = React.useState(0);
     const onChange = React.useCallback(({ config = props.config, itemsStateAndParams = props.itemsStateAndParams }) => {
@@ -41,12 +46,27 @@ function useMemoStateContext(props) {
         }
     }, [props.config, onChange]);
     const onItemRemove = React.useCallback((id) => {
-        onChange(UpdateManager.removeItem({
-            id,
-            config: props.config,
-            itemsStateAndParams: props.itemsStateAndParams,
-        }));
-    }, [props.config, props.itemsStateAndParams, onChange]);
+        if (id === TEMPORARY_ITEM_ID) {
+            resetTemporaryLayout();
+        }
+        else {
+            if (temporaryLayout) {
+                setTemporaryLayout(Object.assign(Object.assign({}, temporaryLayout), { data: temporaryLayout.data.filter(({ i }) => i !== id) }));
+            }
+            onChange(UpdateManager.removeItem({
+                id,
+                config: props.config,
+                itemsStateAndParams: props.itemsStateAndParams,
+            }));
+        }
+    }, [
+        props.config,
+        props.itemsStateAndParams,
+        temporaryLayout,
+        onChange,
+        setTemporaryLayout,
+        resetTemporaryLayout,
+    ]);
     const onItemStateAndParamsChange = React.useCallback((id, stateAndParams, options) => {
         onChange({
             itemsStateAndParams: UpdateManager.changeStateAndParams({
@@ -120,8 +140,57 @@ function useMemoStateContext(props) {
     const reloadItems = React.useCallback((pluginsRefs, data) => {
         pluginsRefs.forEach((ref) => ref && ref.reload && ref.reload(data));
     }, []);
+    const dragProps = dndContext === null || dndContext === void 0 ? void 0 : dndContext.dragProps;
+    const dragOverPlugin = React.useMemo(() => {
+        if (!dragProps) {
+            return null;
+        }
+        const pluginType = dragProps.type;
+        if (props.registerManager.check(pluginType)) {
+            return props.registerManager.getItem(pluginType);
+        }
+        else {
+            // eslint-disable-next-line no-console
+            console.error(`Uknown pluginType: ${pluginType}`);
+            return null;
+        }
+    }, [dragProps, props.registerManager]);
+    const onDropDragOver = React.useCallback(() => {
+        if (temporaryLayout) {
+            resetTemporaryLayout();
+            return false;
+        }
+        if (dragOverPlugin) {
+            const { defaultLayout } = dragOverPlugin;
+            const { h = (defaultLayout === null || defaultLayout === void 0 ? void 0 : defaultLayout.h) || DEFAULT_WIDGET_HEIGHT, w = (defaultLayout === null || defaultLayout === void 0 ? void 0 : defaultLayout.w) || DEFAULT_WIDGET_WIDTH, } = dragProps.layout || {};
+            return { h, w };
+        }
+        return false;
+    }, [resetTemporaryLayout, temporaryLayout, dragOverPlugin, dragProps]);
+    const onDrop = React.useCallback((newLayout, item) => {
+        if (!dragProps) {
+            return;
+        }
+        setTemporaryLayout({
+            data: newLayout,
+            dragProps,
+        });
+        const { i, w, h, x, y } = item;
+        props.onDrop({
+            newLayout: newLayout.reduce((memo, l) => {
+                if (l.i !== i) {
+                    memo.push({ i: l.i, w: l.w, h: l.h, x: l.x, y: l.y });
+                }
+                return memo;
+            }, []),
+            itemLayout: { w, h, x, y },
+            commit: resetTemporaryLayout,
+            dragProps,
+        });
+    }, [dragProps, props.onDrop, setTemporaryLayout, resetTemporaryLayout]);
     return React.useMemo(() => ({
         layout: resultLayout,
+        temporaryLayout,
         config: props.config,
         context: props.context,
         noOverlay: props.noOverlay,
@@ -135,6 +204,8 @@ function useMemoStateContext(props) {
         registerManager: props.registerManager,
         onItemStateAndParamsChange,
         removeItem: onItemRemove,
+        onDrop,
+        onDropDragOver,
         editItem: props.onItemEdit,
         layoutChange: onLayoutChange,
         getItemsMeta,
@@ -143,8 +214,11 @@ function useMemoStateContext(props) {
         revertToOriginalLayout,
         forwardedMetaRef: props.forwardedMetaRef,
         draggableHandleClassName: props.draggableHandleClassName,
+        outerDnDEnable,
+        dragOverPlugin,
     }), [
         resultLayout,
+        temporaryLayout,
         props.config,
         props.context,
         props.noOverlay,
@@ -157,6 +231,8 @@ function useMemoStateContext(props) {
         props.registerManager,
         onItemStateAndParamsChange,
         onItemRemove,
+        onDrop,
+        onDropDragOver,
         props.onItemEdit,
         onLayoutChange,
         getItemsMeta,
@@ -165,6 +241,8 @@ function useMemoStateContext(props) {
         revertToOriginalLayout,
         props.forwardedMetaRef,
         props.draggableHandleClassName,
+        outerDnDEnable,
+        dragOverPlugin,
     ]);
 }
 export function withContext(Component) {

package/build/esm/hooks/useDnDItemProps.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import { ActionPanelItem } from '../components';
+type DndProps = null | {
+    draggable: true;
+    unselectable: 'on';
+    onDragStart: React.DragEventHandler<HTMLDivElement>;
+    onDragEnd: React.DragEventHandler<HTMLDivElement>;
+};
+export declare const useDnDItemProps: (item: ActionPanelItem) => DndProps;
+export {};

package/build/esm/hooks/useDnDItemProps.js

@@ -0,0 +1,25 @@
+import React from 'react';
+import { DashKitDnDContext } from '../context/DashKitContext';
+export const useDnDItemProps = (item) => {
+    const dragContext = React.useContext(DashKitDnDContext);
+    const onDragStart = React.useCallback((e) => {
+        if (dragContext && item.dragProps) {
+            dragContext.onDragStart(e, item.dragProps);
+            e.dataTransfer.setDragImage(dragContext.dragImagePreview, 0, 0);
+        }
+    }, [dragContext, item.dragProps]);
+    const onDragEnd = React.useCallback((e) => {
+        if (dragContext) {
+            dragContext.onDragEnd(e);
+        }
+    }, [dragContext]);
+    if (dragContext && item.dragProps) {
+        return {
+            draggable: true,
+            unselectable: 'on',
+            onDragStart,
+            onDragEnd,
+        };
+    }
+    return null;
+};

package/build/esm/shared/constants/common.d.ts

@@ -1,3 +1,4 @@
 export declare const CURRENT_VERSION = 2;
 export declare const META_KEY = "__meta__";
 export declare const ACTION_PARAM_PREFIX = "_ap_";
+export declare const TERMORARY_ITEM_ID = "__dropping-elem__";

package/build/esm/shared/constants/common.js

@@ -1,3 +1,4 @@
 export const CURRENT_VERSION = 2;
 export const META_KEY = '__meta__';
 export const ACTION_PARAM_PREFIX = '_ap_';
+export const TERMORARY_ITEM_ID = '__dropping-elem__';

package/build/esm/shared/types/common.d.ts

@@ -1,5 +1,20 @@
+import { ConfigLayout } from './config';
 export type Dictionary<T = unknown> = Record<string, T>;
 export interface StringParams extends Dictionary<string | string[]> {
 }
 export interface GlobalParams extends StringParams {
 }
+export type ItemDragProps = {
+    type: string;
+    layout?: {
+        w?: number;
+        h?: number;
+    };
+    extra?: any;
+};
+export type ItemDropProps = {
+    commit: () => void;
+    dragProps: ItemDragProps;
+    itemLayout: ConfigLayout;
+    newLayout: ConfigLayout[];
+};

package/build/esm/typings/config.d.ts

@@ -8,3 +8,6 @@ export type SetConfigItem = ConfigItem | AddConfigItem;
 export type SetItemOptions = {
     excludeIds?: string[];
 };
+export type SetNewItemOptions = SetItemOptions & {
+    updateLayout?: ConfigLayout[];
+};

package/build/esm/typings/plugin.d.ts

@@ -36,4 +36,5 @@ export interface PluginDefaultLayout {
 export interface Plugin<P extends PluginWidgetProps<T> = any, T = StringParams> extends PluginBase {
     defaultLayout?: PluginDefaultLayout;
     renderer: (props: P, forwardedRef: React.RefObject<any>) => React.ReactNode;
+    placeholderRenderer?: (props: P, forwardedRef: React.RefObject<any>) => React.ReactNode;
 }

package/build/esm/utils/update-manager.d.ts

@@ -1,5 +1,5 @@
 import type { Config, ConfigItem, ItemStateAndParams, ItemStateAndParamsChangeOptions, ItemsStateAndParams } from '../shared';
-import type { AddConfigItem, SetItemOptions, WidgetLayout } from '../typings';
+import type { AddConfigItem, SetItemOptions, SetNewItemOptions, WidgetLayout } from '../typings';
 import { RegisterManagerPluginLayout } from './register-manager';
 interface RemoveItemArg {
     id: string;
@@ -19,7 +19,7 @@ export declare class UpdateManager {
         namespace: string;
         layout: RegisterManagerPluginLayout;
         config: Config;
-        options: SetItemOptions;
+        options: SetNewItemOptions;
     }): Config;
     static editItem({ item, namespace, config, options, }: {
         item: ConfigItem;

package/build/esm/utils/update-manager.js

@@ -212,19 +212,37 @@ function changeGroupParams({ groupItemIds, initiatorId, initiatorItem, itemsStat
 }
 export class UpdateManager {
     static addItem({ item, namespace = DEFAULT_NAMESPACE, layout, config, options, }) {
-        const layoutY = Math.max(0, ...config.layout.map(({ h, y }) => h + y));
-        const saveDefaultLayout = pick(layout, ['h', 'w', 'x', 'y']);
         const salt = config.salt;
         const newItemData = getNewItemData({ item, config, salt, counter: config.counter, options });
         let counter = newItemData.counter;
         const newIdData = getNewId({ config, salt, counter, excludeIds: newItemData.excludeIds });
         counter = newIdData.counter;
         const newItem = Object.assign(Object.assign({}, item), { id: newIdData.id, data: newItemData.data, namespace });
-        return update(config, {
-            items: { $push: [newItem] },
-            layout: { $push: [Object.assign(Object.assign({}, saveDefaultLayout), { y: layoutY, i: newItem.id })] },
-            counter: { $set: counter },
-        });
+        const saveDefaultLayout = pick(layout, ['h', 'w', 'x', 'y']);
+        if (options.updateLayout) {
+            const byId = options.updateLayout.reduce((memo, t) => {
+                memo[t.i] = t;
+                return memo;
+            }, {});
+            const newLayout = [
+                ...config.layout.map((t) => (Object.assign(Object.assign({}, t), (byId[t.i] || {})))),
+                Object.assign(Object.assign({}, saveDefaultLayout), { i: newItem.id }),
+            ];
+            return update(config, {
+                items: { $push: [newItem] },
+                layout: { $set: newLayout },
+                counter: { $set: counter },
+            });
+        }
+        else {
+            const layoutY = Math.max(0, ...config.layout.map(({ h, y }) => h + y));
+            const newLayoutItem = Object.assign(Object.assign({}, saveDefaultLayout), { y: layoutY, i: newItem.id });
+            return update(config, {
+                items: { $push: [newItem] },
+                layout: { $push: [newLayoutItem] },
+                counter: { $set: counter },
+            });
+        }
     }
     static editItem({ item, namespace = DEFAULT_NAMESPACE, config, options, }) {
         const itemIndex = config.items.findIndex(({ id }) => item.id === id);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/dashkit",
-  "version": "8.1.0",
+  "version": "8.2.0",
   "description": "Library for rendering dashboard grid layout",
   "license": "MIT",
   "repository": {