@gravity-ui/dashkit 5.4.0 → 5.6.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [5.6.0](https://github.com/gravity-ui/dashkit/compare/v5.5.0...v5.6.0) (2023-04-18)
+
+
+### Features
+
+* add item state to overlay dropdown menu action handler ([#57](https://github.com/gravity-ui/dashkit/issues/57)) ([78b13fa](https://github.com/gravity-ui/dashkit/commit/78b13fa4107e94abd93c6e469a36840b61b6a10a))
+
+## [5.5.0](https://github.com/gravity-ui/dashkit/compare/v5.4.0...v5.5.0) (2023-04-17)
+
+
+### Features
+
+* support all props from react-grid-layout ([#54](https://github.com/gravity-ui/dashkit/issues/54)) ([7e3d316](https://github.com/gravity-ui/dashkit/commit/7e3d316a4cc0fbbf24a23f52408c4fa10f69a4b5))
+
 ## [5.4.0](https://github.com/gravity-ui/dashkit/compare/v5.3.0...v5.4.0) (2023-04-13)
 
 

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

@@ -1,6 +1,6 @@
 import React from 'react';
 import { ButtonView, ButtonSize, IconProps, MenuItemProps } from '@gravity-ui/uikit';
-import { ConfigItem, PluginBase, StringParams, Config } from '../../shared';
+import { ConfigItem, PluginBase, StringParams, Config, ItemState } from '../../shared';
 import type { RegisterManager } from '../../utils/register-manager';
 export declare enum OverlayControlsPosition {
     TopRight = "top_right",
@@ -23,7 +23,7 @@ export interface OverlayCustomControlItem {
     title?: string;
     icon?: MenuItemProps['icon'];
     iconSize?: number | string;
-    handler?: (item: ConfigItem, params: StringParams) => void;
+    handler?: (item: ConfigItem, params: StringParams, state: ItemState) => void;
     visible?: (item: ConfigItem) => boolean;
     className?: string;
     qa?: string;
@@ -41,6 +41,7 @@ interface OverlayControlsProps extends OverlayControlsDefaultProps {
 type DashKitCtx = React.Context<{
     registerManager: RegisterManager;
     itemsParams: Record<string, StringParams>;
+    itemsState: Record<string, ItemState>;
     editItem: (item: ConfigItem) => void;
     removeItem: (id: string) => void;
     config: Config;

package/build/cjs/components/OverlayControls/OverlayControls.js

@@ -143,9 +143,10 @@ class OverlayControls extends react_1.default.Component {
     }
     renderDropdownMenu() {
         const { view, size } = this.props;
-        const { registerManager, itemsParams } = this.context;
+        const { registerManager, itemsParams, itemsState } = this.context;
         const configItem = this.props.configItem;
         const itemParams = itemsParams[configItem.id];
+        const itemState = itemsState[configItem.id];
         let menu = registerManager.settings.menu;
         if (!menu.length) {
             menu = DEFAULT_DROPDOWN_MENU;
@@ -164,7 +165,7 @@ class OverlayControls extends react_1.default.Component {
                 }
                 const itemHandler = item.handler;
                 const itemAction = typeof itemHandler === 'function'
-                    ? () => itemHandler(configItem, itemParams)
+                    ? () => itemHandler(configItem, itemParams, itemState)
                     : ((_a = this.getDropDownMenuItemConfig(item.id)) === null || _a === void 0 ? void 0 : _a.action) || (() => { });
                 return {
                     text: item.title || (0, i18n_1.default)(item.id),

package/build/cjs/typings/common.d.ts

@@ -1,12 +1,8 @@
 import { OverlayCustomControlItem } from '../components/OverlayControls/OverlayControls';
 import { MenuItems } from '../constants';
+import type { ReactGridLayoutProps } from 'react-grid-layout';
 export interface Settings {
-    gridLayout?: {
-        margin?: [number, number];
-        rowHeight?: number;
-        cols?: number;
-        containerPadding?: [number, number];
-    };
+    gridLayout?: ReactGridLayoutProps;
     theme?: string;
     isMobile?: boolean;
     menu?: Array<MenuItem>;

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

@@ -1,7 +1,7 @@
 import React from 'react';
 import { ContextProps, SettingsProps, WidgetLayout } from './common';
 import { StringParams, ConfigItem, ItemState, ItemStateAndParams, PluginBase } from '../shared';
-import { RegisterManagerGridLayout } from '../utils/register-manager';
+import type { ReactGridLayoutProps } from 'react-grid-layout';
 export interface PluginWidgetProps {
     id: string;
     editMode: boolean;
@@ -16,7 +16,7 @@ export interface PluginWidgetProps {
     settings: SettingsProps;
     context: ContextProps;
     layout: WidgetLayout[];
-    gridLayout: RegisterManagerGridLayout;
+    gridLayout: ReactGridLayoutProps;
     adjustWidgetLayout: (data: {
         widgetId: string;
         needSetDefault?: boolean;

package/build/cjs/utils/register-manager.d.ts

@@ -1,4 +1,5 @@
 import { Plugin, PluginDefaultLayout, Settings } from '../typings';
+import type { ReactGridLayoutProps } from 'react-grid-layout';
 interface RegisterManagerDefaultLayout {
     x: number;
     y: number;
@@ -11,12 +12,6 @@ export type RegisterManagerPluginLayout = RegisterManagerDefaultLayout & PluginD
 export interface RegisterManagerPlugin extends Omit<Plugin, 'defaultLayout'> {
     defaultLayout: RegisterManagerDefaultLayout & Plugin['defaultLayout'];
 }
-export type RegisterManagerGridLayout = {
-    margin: [number, number];
-    rowHeight: number;
-    cols: number;
-    containerPadding: [number, number];
-} & Settings['gridLayout'];
 export type RegisterManagerSettings = {
     theme: string;
 } & Settings;
@@ -28,17 +23,7 @@ export declare class RegisterManager {
     registerPlugin(plugin: Plugin): void;
     setSettings(settings?: Settings): void;
     get settings(): RegisterManagerSettings;
-    get gridLayout(): {
-        margin: [number, number];
-        rowHeight: number;
-        cols: number;
-        containerPadding: [number, number];
-    } & {
-        margin?: [number, number] | undefined;
-        rowHeight?: number | undefined;
-        cols?: number | undefined;
-        containerPadding?: [number, number] | undefined;
-    };
+    get gridLayout(): ReactGridLayoutProps;
     getPlugins(): RegisterManagerPlugin[];
     getItem(type: string): RegisterManagerPlugin;
     check(type: string): boolean;

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

@@ -1,6 +1,6 @@
 import React from 'react';
 import { ButtonView, ButtonSize, IconProps, MenuItemProps } from '@gravity-ui/uikit';
-import { ConfigItem, PluginBase, StringParams, Config } from '../../shared';
+import { ConfigItem, PluginBase, StringParams, Config, ItemState } from '../../shared';
 import type { RegisterManager } from '../../utils/register-manager';
 import './OverlayControls.css';
 export declare enum OverlayControlsPosition {
@@ -24,7 +24,7 @@ export interface OverlayCustomControlItem {
     title?: string;
     icon?: MenuItemProps['icon'];
     iconSize?: number | string;
-    handler?: (item: ConfigItem, params: StringParams) => void;
+    handler?: (item: ConfigItem, params: StringParams, state: ItemState) => void;
     visible?: (item: ConfigItem) => boolean;
     className?: string;
     qa?: string;
@@ -42,6 +42,7 @@ interface OverlayControlsProps extends OverlayControlsDefaultProps {
 type DashKitCtx = React.Context<{
     registerManager: RegisterManager;
     itemsParams: Record<string, StringParams>;
+    itemsState: Record<string, ItemState>;
     editItem: (item: ConfigItem) => void;
     removeItem: (id: string) => void;
     config: Config;

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

@@ -140,9 +140,10 @@ class OverlayControls extends React.Component {
     }
     renderDropdownMenu() {
         const { view, size } = this.props;
-        const { registerManager, itemsParams } = this.context;
+        const { registerManager, itemsParams, itemsState } = this.context;
         const configItem = this.props.configItem;
         const itemParams = itemsParams[configItem.id];
+        const itemState = itemsState[configItem.id];
         let menu = registerManager.settings.menu;
         if (!menu.length) {
             menu = DEFAULT_DROPDOWN_MENU;
@@ -161,7 +162,7 @@ class OverlayControls extends React.Component {
                 }
                 const itemHandler = item.handler;
                 const itemAction = typeof itemHandler === 'function'
-                    ? () => itemHandler(configItem, itemParams)
+                    ? () => itemHandler(configItem, itemParams, itemState)
                     : ((_a = this.getDropDownMenuItemConfig(item.id)) === null || _a === void 0 ? void 0 : _a.action) || (() => { });
                 return {
                     text: item.title || i18n(item.id),

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

@@ -1,12 +1,8 @@
 import { OverlayCustomControlItem } from '../components/OverlayControls/OverlayControls';
 import { MenuItems } from '../constants';
+import type { ReactGridLayoutProps } from 'react-grid-layout';
 export interface Settings {
-    gridLayout?: {
-        margin?: [number, number];
-        rowHeight?: number;
-        cols?: number;
-        containerPadding?: [number, number];
-    };
+    gridLayout?: ReactGridLayoutProps;
     theme?: string;
     isMobile?: boolean;
     menu?: Array<MenuItem>;

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

@@ -1,7 +1,7 @@
 import React from 'react';
 import { ContextProps, SettingsProps, WidgetLayout } from './common';
 import { StringParams, ConfigItem, ItemState, ItemStateAndParams, PluginBase } from '../shared';
-import { RegisterManagerGridLayout } from '../utils/register-manager';
+import type { ReactGridLayoutProps } from 'react-grid-layout';
 export interface PluginWidgetProps {
     id: string;
     editMode: boolean;
@@ -16,7 +16,7 @@ export interface PluginWidgetProps {
     settings: SettingsProps;
     context: ContextProps;
     layout: WidgetLayout[];
-    gridLayout: RegisterManagerGridLayout;
+    gridLayout: ReactGridLayoutProps;
     adjustWidgetLayout: (data: {
         widgetId: string;
         needSetDefault?: boolean;

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

@@ -1,4 +1,5 @@
 import { Plugin, PluginDefaultLayout, Settings } from '../typings';
+import type { ReactGridLayoutProps } from 'react-grid-layout';
 interface RegisterManagerDefaultLayout {
     x: number;
     y: number;
@@ -11,12 +12,6 @@ export type RegisterManagerPluginLayout = RegisterManagerDefaultLayout & PluginD
 export interface RegisterManagerPlugin extends Omit<Plugin, 'defaultLayout'> {
     defaultLayout: RegisterManagerDefaultLayout & Plugin['defaultLayout'];
 }
-export type RegisterManagerGridLayout = {
-    margin: [number, number];
-    rowHeight: number;
-    cols: number;
-    containerPadding: [number, number];
-} & Settings['gridLayout'];
 export type RegisterManagerSettings = {
     theme: string;
 } & Settings;
@@ -28,17 +23,7 @@ export declare class RegisterManager {
     registerPlugin(plugin: Plugin): void;
     setSettings(settings?: Settings): void;
     get settings(): RegisterManagerSettings;
-    get gridLayout(): {
-        margin: [number, number];
-        rowHeight: number;
-        cols: number;
-        containerPadding: [number, number];
-    } & {
-        margin?: [number, number] | undefined;
-        rowHeight?: number | undefined;
-        cols?: number | undefined;
-        containerPadding?: [number, number] | undefined;
-    };
+    get gridLayout(): ReactGridLayoutProps;
     getPlugins(): RegisterManagerPlugin[];
     getItem(type: string): RegisterManagerPlugin;
     check(type: string): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/dashkit",
-  "version": "5.4.0",
+  "version": "5.6.0",
   "description": "Library for rendering dashboard grid layout",
   "license": "MIT",
   "repository": {
@@ -60,6 +60,7 @@
     "@types/jest": "^26.0.20",
     "@types/lodash": "^4.14.170",
     "@types/react": "^18.0.27",
+    "@types/react-grid-layout": "^1.3.2",
     "babel-jest": "^26.6.3",
     "bem-cn-lite": "^4.0.0",
     "copyfiles": "^2.4.1",