@gravity-ui/dashkit 3.5.0 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [4.1.0](https://github.com/gravity-ui/dashkit/compare/v4.0.0...v4.1.0) (2023-01-31)
+
+
+### Features
+
+* remove preventDoubleCompact flag ([#37](https://github.com/gravity-ui/dashkit/issues/37)) ([9b95e61](https://github.com/gravity-ui/dashkit/commit/9b95e61b7939a9883fda832947e70728b8f66410))
+
+## [4.0.0](https://github.com/gravity-ui/dashkit/compare/v3.5.0...v4.0.0) (2022-12-19)
+
+
+### ⚠ BREAKING CHANGES
+
+* rename types in plugin Text ([#33](https://github.com/gravity-ui/dashkit/issues/33))
+* change grid item forward ref behavior
+
+### Features
+
+* rename types in plugin Text ([#33](https://github.com/gravity-ui/dashkit/issues/33)) ([c55917f](https://github.com/gravity-ui/dashkit/commit/c55917f918a4592c680e4e3bf3173fb53514b185))
+* update react-grid-layout major release ([#31](https://github.com/gravity-ui/dashkit/issues/31)) ([e31ff70](https://github.com/gravity-ui/dashkit/commit/e31ff707f48038435a63d95ad34b8685c39fb1ba))
+
 ## [3.5.0](https://github.com/gravity-ui/dashkit/compare/v3.4.0...v3.5.0) (2022-12-19)
 
 

package/README.md

@@ -1,3 +1,5 @@
+# @gravity-ui/dashkit · [![npm package](https://img.shields.io/npm/v/@gravity-ui/dashkit)](https://www.npmjs.com/package/@gravity-ui/dashkit) [![CI](https://img.shields.io/github/actions/workflow/status/gravity-ui/dashkit/.github/workflows/ci.yaml?branch=main&label=CI&logo=github)](https://github.com/gravity-ui/dashkit/actions/workflows/ci.yaml?query=branch:main) [![storybook](https://img.shields.io/badge/Storybook-deployed-ff4685)](https://preview.gravity-ui.com/dashkit/)
+
 # DashKit
 
 A dashboard grid rendering library.

package/build/cjs/components/DashKit/DashKit.d.ts

@@ -21,7 +21,6 @@ interface DashKitDefaultProps {
     overlayControls?: Record<string, OverlayControlItem[]>;
     noOverlay?: boolean;
     draggableHandleClassName?: string;
-    _EXPERIMENTAL_preventDoubleCompact?: boolean;
 }
 export interface DashKitProps extends DashKitGeneralProps, Partial<DashKitDefaultProps> {
 }

package/build/cjs/components/GridItem/GridItem.js

@@ -40,7 +40,7 @@ class GridItem extends react_1.default.PureComponent {
         return (react_1.default.createElement("div", Object.assign({ className: b({
                 'is-dragging': isDragging,
                 'with-custom-handle': withCustomHandle,
-            }, preparedClassName), "data-qa": "dashkit-grid-item", style: style }, reactGridLayoutProps),
+            }, preparedClassName), "data-qa": "dashkit-grid-item", style: style, ref: this.props.forwardedRef }, reactGridLayoutProps),
             react_1.default.createElement("div", { className: b('item', { editMode: editMode && !_editActive && !noOverlay }) },
                 react_1.default.createElement(Item_1.default, { id: this.props.id, item: this.props.item, shouldItemUpdate: !isDragging, width: width, height: height, transform: transform, adjustWidgetLayout: this.props.adjustWidgetLayout, layout: this.props.layout, forwardedPluginRef: this.props.forwardedPluginRef })),
             !noOverlay && this.renderOverlay(),
@@ -54,6 +54,7 @@ GridItem.propTypes = {
     isDragging: prop_types_1.default.bool,
     layout: prop_types_1.default.array,
     overlayControls: prop_types_1.default.object,
+    forwardedRef: prop_types_1.default.any,
     forwardedPluginRef: prop_types_1.default.any,
     // from react-grid-layout:
     children: prop_types_1.default.node,
@@ -68,5 +69,5 @@ GridItem.propTypes = {
 };
 GridItem.contextType = DashKitContext_1.DashKitContext;
 exports.default = react_1.default.forwardRef((props, ref) => {
-    return react_1.default.createElement(GridItem, Object.assign({}, props, { forwardedPluginRef: ref }));
+    return react_1.default.createElement(GridItem, Object.assign({}, props, { forwardedRef: ref }));
 });

package/build/cjs/components/GridLayout/GridLayout.js

@@ -76,7 +76,7 @@ class GridLayout extends react_1.default.PureComponent {
         return (react_1.default.createElement(Layout, Object.assign({}, registerManager.gridLayout, { layout: layout, isDraggable: editMode, isResizable: editMode, onDragStart: this._onStart, onDragStop: this._onStop, onResizeStart: this._onStart, onResizeStop: this._onStop }, (draggableHandleClassName
             ? { draggableHandle: `.${draggableHandleClassName}` }
             : null)), config.items.map((item, i) => {
-            return (react_1.default.createElement(GridItem_1.default, { ref: (pluginRef) => {
+            return (react_1.default.createElement(GridItem_1.default, { forwardedPluginRef: (pluginRef) => {
                     this.pluginsRefs[i] = pluginRef;
                 }, key: item.id, id: item.id, item: item, layout: layout, adjustWidgetLayout: this.adjustWidgetLayout, isDragging: this.state.isDragging, noOverlay: noOverlay, withCustomHandle: Boolean(draggableHandleClassName), overlayControls: this.props.overlayControls }));
         })));

package/build/cjs/hocs/withContext.js

@@ -7,8 +7,6 @@ const DashKitContext_1 = require("../context/DashKitContext");
 const utils_1 = require("../utils");
 const shared_1 = require("../shared");
 const isEqual_1 = tslib_1.__importDefault(require("lodash/isEqual"));
-const react_grid_layout_1 = require("react-grid-layout");
-const LAYOUT_COMPACTING_TYPE = 'vertical';
 function useMemoStateContext(props) {
     // так как мы не хотим хранить параметры виджета с активированной автовысотой в сторе и на сервере, актуальный
     // (видимый юзером в конкретный момент времени) лэйаут (массив объектов с данными о ширине, высоте,
@@ -38,22 +36,14 @@ function useMemoStateContext(props) {
                 return Object.assign({}, item);
             }
         });
-        // [experimental] if the _prevent Double Compact is enabled, then skip recalculate layout with auto height
-        // после того, как у виждета активировали автовысоту и его параметр "h" изменился, это приведёт, также, и к
-        // изменению параметра (координаты) "y" у элементов расположенных под ним, поэтому, после того, как
-        // значения параметра "h" виджетов с активированной автовысотой были изменены, необходимо изменить и
-        // координату "y" виджетов расположенных ниже
-        const compactedLayout = props._EXPERIMENTAL_preventDoubleCompact
-            ? currentInnerLayout
-            : react_grid_layout_1.utils.compact(currentInnerLayout, LAYOUT_COMPACTING_TYPE, props.registerManager.gridLayout.cols);
         const newConfig = utils_1.UpdateManager.updateLayout({
-            layout: compactedLayout,
+            layout: currentInnerLayout,
             config: props.config,
         });
         if (!(0, isEqual_1.default)(newConfig.layout, props.config.layout)) {
             onChange({ config: newConfig });
         }
-    }, [props._EXPERIMENTAL_preventDoubleCompact, props.registerManager, props.config, onChange]);
+    }, [props.config, onChange]);
     const onItemRemove = react_1.default.useCallback((id) => {
         onChange(utils_1.UpdateManager.removeItem({
             id,

package/build/cjs/plugins/Text/Text.d.ts

@@ -41,12 +41,12 @@ export declare class PluginText extends React.PureComponent<PluginTextProps, Plu
     get withMarkdown(): boolean;
 }
 declare type PluginDataProps = Omit<PluginTextProps, 'apiHandler'>;
-export declare type PluginObjectSettings = {
+export declare type PluginTextObjectSettings = {
     apiHandler?: PluginTextApiHandler;
 };
-export declare type PluginObject = Plugin<PluginDataProps> & {
-    setSettings: (settings: PluginObjectSettings) => PluginObject;
+export declare type PluginTextObject = Plugin<PluginDataProps> & {
+    setSettings: (settings: PluginTextObjectSettings) => PluginTextObject;
     _apiHandler?: PluginTextApiHandler;
 };
-declare const plugin: PluginObject;
+declare const plugin: PluginTextObject;
 export default plugin;

package/build/cjs/plugins/Text/index.d.ts

@@ -1 +1,2 @@
-export { PluginTextApiHandler, PluginTextProps, PluginText, PluginObjectSettings as PluginTextObjectSettings, PluginObject as PluginTextObject, default as pluginText, } from './Text';
+export * from './Text';
+export { default as pluginText } from './Text';

package/build/cjs/plugins/Text/index.js

@@ -1,9 +1,7 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pluginText = exports.PluginText = void 0;
+exports.pluginText = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./Text"), exports);
 var Text_1 = require("./Text");
-Object.defineProperty(exports, "PluginText", { enumerable: true, get: function () { return Text_1.PluginText; } });
-Object.defineProperty(exports, "pluginText", { enumerable: true, get: function () { return __importDefault(Text_1).default; } });
+Object.defineProperty(exports, "pluginText", { enumerable: true, get: function () { return tslib_1.__importDefault(Text_1).default; } });

package/build/cjs/plugins/Title/index.d.ts

@@ -1 +1,2 @@
-export { PluginTitle, PluginTitleProps, default as pluginTitle } from './Title';
+export * from './Title';
+export { default as pluginTitle } from './Title';

package/build/cjs/plugins/Title/index.js

@@ -1,9 +1,7 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pluginTitle = exports.PluginTitle = void 0;
+exports.pluginTitle = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./Title"), exports);
 var Title_1 = require("./Title");
-Object.defineProperty(exports, "PluginTitle", { enumerable: true, get: function () { return Title_1.PluginTitle; } });
-Object.defineProperty(exports, "pluginTitle", { enumerable: true, get: function () { return __importDefault(Title_1).default; } });
+Object.defineProperty(exports, "pluginTitle", { enumerable: true, get: function () { return tslib_1.__importDefault(Title_1).default; } });

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

@@ -21,7 +21,6 @@ interface DashKitDefaultProps {
     overlayControls?: Record<string, OverlayControlItem[]>;
     noOverlay?: boolean;
     draggableHandleClassName?: string;
-    _EXPERIMENTAL_preventDoubleCompact?: boolean;
 }
 export interface DashKitProps extends DashKitGeneralProps, Partial<DashKitDefaultProps> {
 }

package/build/esm/components/GridItem/GridItem.js

@@ -38,7 +38,7 @@ class GridItem extends React.PureComponent {
         return (React.createElement("div", Object.assign({ className: b({
                 'is-dragging': isDragging,
                 'with-custom-handle': withCustomHandle,
-            }, preparedClassName), "data-qa": "dashkit-grid-item", style: style }, reactGridLayoutProps),
+            }, preparedClassName), "data-qa": "dashkit-grid-item", style: style, ref: this.props.forwardedRef }, reactGridLayoutProps),
             React.createElement("div", { className: b('item', { editMode: editMode && !_editActive && !noOverlay }) },
                 React.createElement(Item, { id: this.props.id, item: this.props.item, shouldItemUpdate: !isDragging, width: width, height: height, transform: transform, adjustWidgetLayout: this.props.adjustWidgetLayout, layout: this.props.layout, forwardedPluginRef: this.props.forwardedPluginRef })),
             !noOverlay && this.renderOverlay(),
@@ -52,6 +52,7 @@ GridItem.propTypes = {
     isDragging: PropTypes.bool,
     layout: PropTypes.array,
     overlayControls: PropTypes.object,
+    forwardedRef: PropTypes.any,
     forwardedPluginRef: PropTypes.any,
     // from react-grid-layout:
     children: PropTypes.node,
@@ -66,5 +67,5 @@ GridItem.propTypes = {
 };
 GridItem.contextType = DashKitContext;
 export default React.forwardRef((props, ref) => {
-    return React.createElement(GridItem, Object.assign({}, props, { forwardedPluginRef: ref }));
+    return React.createElement(GridItem, Object.assign({}, props, { forwardedRef: ref }));
 });

package/build/esm/components/GridLayout/GridLayout.js

@@ -73,7 +73,7 @@ export default class GridLayout extends React.PureComponent {
         return (React.createElement(Layout, Object.assign({}, registerManager.gridLayout, { layout: layout, isDraggable: editMode, isResizable: editMode, onDragStart: this._onStart, onDragStop: this._onStop, onResizeStart: this._onStart, onResizeStop: this._onStop }, (draggableHandleClassName
             ? { draggableHandle: `.${draggableHandleClassName}` }
             : null)), config.items.map((item, i) => {
-            return (React.createElement(GridItem, { ref: (pluginRef) => {
+            return (React.createElement(GridItem, { forwardedPluginRef: (pluginRef) => {
                     this.pluginsRefs[i] = pluginRef;
                 }, key: item.id, id: item.id, item: item, layout: layout, adjustWidgetLayout: this.adjustWidgetLayout, isDragging: this.state.isDragging, noOverlay: noOverlay, withCustomHandle: Boolean(draggableHandleClassName), overlayControls: this.props.overlayControls }));
         })));

package/build/esm/hocs/withContext.js

@@ -3,8 +3,6 @@ import { DashKitContext } from '../context/DashKitContext';
 import { UpdateManager } from '../utils';
 import { getItemsParams, getItemsState } from '../shared';
 import isEqual from 'lodash/isEqual';
-import { utils as gridLayoutUtils } from 'react-grid-layout';
-const LAYOUT_COMPACTING_TYPE = 'vertical';
 function useMemoStateContext(props) {
     // так как мы не хотим хранить параметры виджета с активированной автовысотой в сторе и на сервере, актуальный
     // (видимый юзером в конкретный момент времени) лэйаут (массив объектов с данными о ширине, высоте,
@@ -34,22 +32,14 @@ function useMemoStateContext(props) {
                 return Object.assign({}, item);
             }
         });
-        // [experimental] if the _prevent Double Compact is enabled, then skip recalculate layout with auto height
-        // после того, как у виждета активировали автовысоту и его параметр "h" изменился, это приведёт, также, и к
-        // изменению параметра (координаты) "y" у элементов расположенных под ним, поэтому, после того, как
-        // значения параметра "h" виджетов с активированной автовысотой были изменены, необходимо изменить и
-        // координату "y" виджетов расположенных ниже
-        const compactedLayout = props._EXPERIMENTAL_preventDoubleCompact
-            ? currentInnerLayout
-            : gridLayoutUtils.compact(currentInnerLayout, LAYOUT_COMPACTING_TYPE, props.registerManager.gridLayout.cols);
         const newConfig = UpdateManager.updateLayout({
-            layout: compactedLayout,
+            layout: currentInnerLayout,
             config: props.config,
         });
         if (!isEqual(newConfig.layout, props.config.layout)) {
             onChange({ config: newConfig });
         }
-    }, [props._EXPERIMENTAL_preventDoubleCompact, props.registerManager, props.config, onChange]);
+    }, [props.config, onChange]);
     const onItemRemove = React.useCallback((id) => {
         onChange(UpdateManager.removeItem({
             id,

package/build/esm/plugins/Text/Text.d.ts

@@ -42,12 +42,12 @@ export declare class PluginText extends React.PureComponent<PluginTextProps, Plu
     get withMarkdown(): boolean;
 }
 declare type PluginDataProps = Omit<PluginTextProps, 'apiHandler'>;
-export declare type PluginObjectSettings = {
+export declare type PluginTextObjectSettings = {
     apiHandler?: PluginTextApiHandler;
 };
-export declare type PluginObject = Plugin<PluginDataProps> & {
-    setSettings: (settings: PluginObjectSettings) => PluginObject;
+export declare type PluginTextObject = Plugin<PluginDataProps> & {
+    setSettings: (settings: PluginTextObjectSettings) => PluginTextObject;
     _apiHandler?: PluginTextApiHandler;
 };
-declare const plugin: PluginObject;
+declare const plugin: PluginTextObject;
 export default plugin;

package/build/esm/plugins/Text/index.d.ts

@@ -1 +1,2 @@
-export { PluginTextApiHandler, PluginTextProps, PluginText, PluginObjectSettings as PluginTextObjectSettings, PluginObject as PluginTextObject, default as pluginText, } from './Text';
+export * from './Text';
+export { default as pluginText } from './Text';

package/build/esm/plugins/Text/index.js

@@ -1 +1,2 @@
-export { PluginText, default as pluginText, } from './Text';
+export * from './Text';
+export { default as pluginText } from './Text';

package/build/esm/plugins/Title/index.d.ts

@@ -1 +1,2 @@
-export { PluginTitle, PluginTitleProps, default as pluginTitle } from './Title';
+export * from './Title';
+export { default as pluginTitle } from './Title';

package/build/esm/plugins/Title/index.js

@@ -1 +1,2 @@
-export { PluginTitle, default as pluginTitle } from './Title';
+export * from './Title';
+export { default as pluginTitle } from './Title';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/dashkit",
-  "version": "3.5.0",
+  "version": "4.1.0",
   "description": "Library for rendering dashboard grid layout",
   "license": "MIT",
   "repository": {
@@ -28,17 +28,17 @@
     "test": "jest",
     "clean": "gulp clean",
     "build": "gulp",
-    "start": "start-storybook -p 7120",
+    "start": "env TS_NODE_PROJECT=.storybook/tsconfig.json start-storybook -p 7120",
     "typecheck": "tsc --noEmit",
-    "build-storybook": "build-storybook -c .storybook -o storybook-static",
+    "build-storybook": "env TS_NODE_PROJECT=.storybook/tsconfig.json build-storybook -c .storybook -o storybook-static",
     "prepare": "husky install",
     "prepublishOnly": "npm run lint && npm run test && npm run build"
   },
   "dependencies": {
+    "@gravity-ui/i18n": "^1.0.0",
     "hashids": "^2.2.8",
     "immutability-helper": "^3.1.1",
-    "react-grid-layout": "^0.18.3",
-    "@gravity-ui/i18n": "^1.0.0"
+    "react-grid-layout": "^1.3.4"
   },
   "peerDependencies": {
     "@gravity-ui/uikit": "^3.0.0",