§@gravity-ui/dashkit ·

§DashKit

一个用于渲染仪表盘网格的库。

§安装

npm i @gravity-ui/dashkit @gravity-ui/uikit

§描述

该库用于在网格中排列小部件、调整它们的大小、添加新部件以及删除它们。 小部件是一个 React 组件。例如，文本、图形和图像。

新小部件通过插件系统添加。

§插件

插件是创建自定义小部件所必需的。

§Props

type ItemManipulationCallback = (eventData: {
  layout: Layout[];
  oldItem: Layout;
  newItem: Layout;
  placeholder: Layout;
  e: MouseEvent;
  element: HTMLElement;
}) => void;

interface DashKitProps {
  config: Config;
  editMode: boolean;
  onItemEdit: ({id}: {id: string}) => void;
  onChange: (data: {config: Config; itemsStateAndParams: ItemsStateAndParams}) => void;
  onDrop: (dropProps: ItemDropProps) => void;
  onItemMountChange: (item: ConfigItem, state: {isAsync: boolead; isMounted: boolean}) => void;
  onItemRender: (item: ConfigItem) => void;

  onDragStart?: ItemManipulationCallback;
  onDrag?: ItemManipulationCallback;
  onDragStop?: ItemManipulationCallback;
  onResizeStart?: ItemManipulationCallback;
  onResize?: ItemManipulationCallback;
  onResizeStop?: ItemManipulationCallback;

  defaultGlobalParams: GlobalParams;
  globalParams: GlobalParams;
  itemsStateAndParams: ItemsStateAndParams;
  settings: SettingsProps;
  context: ContextProps;
  overlayControls?: Record<string, OverlayControlItem[]> | null;
  overlayMenuItems?: MenuItems[] | null;
  noOverlay?: boolean;

  focusable?: boolean;
  onItemFocus: (item: ConfigItem) => void;
  onItemBlur: (item: ConfigItem) => void;

  draggableHandleClassName?: string;
  getPreparedCopyItemOptions?: (options: PreparedCopyItemOptions) => PreparedCopyItemOptions;
  onCopyFulfill?: (error: null | Error, data?: PreparedCopyItemOptions) => void;
}

• config: 配置。
• editMode: 是否启用编辑模式。
• onItemEdit: 点击编辑小部件时调用。
• onChange: 配置或 itemsStateAndParams 更改时调用。
• onDrop: 使用 (#DashKitDnDWrapper) 从 ActionPanel 拖放项目时调用。
• onItemMountChange: 项目挂载状态更改时调用。
• onItemRender: 项目渲染完成时调用。
• defaultGlobalParams, globalParams: 影响所有小部件的参数。在 DataLens 中，defaultGlobalParams 是在仪表盘设置中设置的全局参数。globalParams 是可以在 URL 中设置的全局参数。
• itemsStateAndParams: itemsStateAndParams。
• settings: DashKit 设置。
• context: 将传递给所有小部件的对象。
• overlayControls: 在编辑时覆盖小部件控件的对象。如果未传递，将显示基本控件。如果传递 null，则仅显示关闭按钮或自定义菜单。
• overlayMenuItems: 自定义下拉菜单项。
• noOverlay: 如果为 true，则在编辑时不会显示覆盖层和控件。
• focusable: 如果为 true，则网格项将可聚焦。
• onItemFocus: 当 focusable 为 true 且项目获得焦点时调用。
• onItemBlur: 当 focusable 为 true 且项目失去焦点时调用。
• draggableHandleClassName: 使小部件可拖动的元素的 CSS 类名。
• onDragStart: ReactGridLayout 在项目拖动开始时调用。
• onDrag: ReactGridLayout 在项目拖动过程中调用。
• onDragStop: ReactGridLayout 在项目拖动停止时调用。
• onResizeStart: ReactGridLayout 在项目调整大小开始时调用。
• onResize: ReactGridLayout 在项目调整大小时调用。
• onResizeStop: ReactGridLayout 在项目调整大小停止时调用。
• getPreparedCopyItemOptions: 在保存到本地存储之前，用于将复制的项目转换为可序列化对象。它应该取代已弃用的 context.getPreparedCopyItemOptions prop。
• onCopyFulfill: 在项目复制成功完成时调用，error=null 和 data 已定义；否则，调用时 error: Error 且没有 data。

§用法

§DashKit 配置

在使用 DashKit 作为 React 组件之前，必须对其进行配置。

• 设置语言

  import {configure, Lang} from '@gravity-ui/uikit';
  
  configure({lang: Lang.En});
  

• DashKit.setSettings

  用于全局 DashKit 设置（例如，小部件之间的边距、默认小部件大小和小部件覆盖菜单）。

  import {DashKit} from '@gravity-ui/dashkit';
  
  DashKit.setSettings({
    gridLayout: {margin: [8, 8]},
    isMobile: true,
    // menu: [] as Array<MenuItem>,
  });
  

• DashKit.registerPlugins

  注册和配置插件。

  import {DashKit} from '@gravity-ui/dashkit';
  import {pluginTitle, pluginText} from '@gravity-ui/dashkit';
  
  DashKit.registerPlugins(
    pluginTitle,
    pluginText.setSettings({
      apiHandler({text}) {
        return api.getMarkdown(text);
      },
    }),
  );
  
  DashKit.registerPlugins({
    type: 'custom',
    defaultLayout: {
      w: 10,
      h: 8,
    },
    renderer: function CustomPlugin() {
      return <div>Custom widget with custom controls</div>;
    },
  });
  

§Config

export interface Config {
  salt: string; // 用于形成唯一 ID
  counter: number; // 用于形成唯一 ID，仅递增
  items: ConfigItem[]; // 初始小部件状态
  layout: ConfigLayout[]; // 网格上的小部件位置 https://github.com/react-grid-layout
  aliases: ConfigAliases; // 参数的别名，参见 #Params
  connections: ConfigConnection[]; // 小部件之间的链接，参见 #Params
}

Config 示例：

import {DashKitProps} from '@gravity-ui/dashkit';

const config: DashKitProps['config'] = {
  salt: '0.46703554571365613',
  counter: 4,
  items: [
    {
      id: 'tT',
      data: {
        size: 'm',
        text: 'Caption',
        showInTOC: true,
      },
      type: 'title',
      namespace: 'default',
      orderId: 1,
    },
    {
      id: 'Ea',
      data: {
        text: 'mode _editActive',
        _editActive: true,
      },
      type: 'text',
      namespace: 'default',
    },
    {
      id: 'zR',
      data: {
        text: '### Text',
      },
      type: 'text',
      namespace: 'default',
      orderId: 0,
    },
    {
      id: 'Dk',
      data: {
        foo: 'bar',
      },
      type: 'custom',
      namespace: 'default',
      orderId: 5,
    },
  ],
  layout: [
    {
      h: 2,
      i: 'tT',
      w: 36,
      x: 0,
      y: 0,
    },
    {
      h: 6,
      i: 'Ea',
      w: 12,
      x: 0,
      y: 2,
    },
    {
      h: 6,
      i: 'zR',
      w: 12,
      x: 12,
      y: 2,
    },
    {
      h: 4,
      i: 'Dk',
      w: 8,
      x: 0,
      y: 8,
    },
  ],
  aliases: {},
  connections: [],
};

向配置中添加新项：

const newLayout = updateLayout: [
  {
    h: 6,
    i: 'Ea',
    w: 12,
    x: 0,
    y: 6,
  },
  {
    h: 4,
    i: 'Dk',
    w: 8,
    x: 0,
    y: 12,
  },
];

const newConfig = DashKit.setItem({
  item: {
    data: {
      text: `Some text`,
    },
    namespace: 'default',
    type: 'text',
    // 可选。如果需要将新项插入到当前布局中，并预定义尺寸
    layout: { // 当前项插入到 'Ea' 之前
      h: 6,
      w: 12,
      x: 0,
      y: 2,
    },,
  },
  config: config,
  options: {
    // 可选。当新元素从 ActionPanel 拖放时，现有项的新布局值
    updateLayout: newLayout,
  },
});

更改现有项：

const newConfig = DashKit.setItem({
  item: {
    id: 'tT', // item.id
    data: {
      size: 'm',
      text: `New caption`,
    },
    namespace: 'default',
    type: 'title',
  },
  config: config,
});

删除项：

import {DashKitProps} from '@gravity-ui/dashkit';

const oldItemsStateAndParams: DashKitProps['itemsStateAndParams'] = {};

const {config: newConfig, itemsStateAndParams} = DashKit.removeItem({
  id: 'tT', // item.id
  config: config,
  itemsStateAndParams: this.state.itemsStateAndParams,
});

§Params

type Params = Record<string, string | string[]>;

DashKit 根据小部件、链接和别名的默认参数生成参数。这些参数是 ChartKit 库所必需的。

生成顺序：

1. defaultGlobalParams
2. 默认小部件参数 item.default
3. globalParams
4. 根据队列从 itemsStateAndParams 获取的参数。

§itemsStateAndParams

存储小部件参数和状态以及参数更改队列的对象。 它有一个 __meta__ 字段，用于存储队列和元信息。

interface StateAndParamsMeta = {
    __meta__: {
        queue: {id: string}[]; // 队列
        version: number; // itemsStateAndParams 的当前版本
    };
}

以及小部件状态和参数：

interface ItemsStateAndParamsBase {
  [itemId: string]: {
    state?: Record<string, any>;
    params?: Params;
  };
}

type ItemsStateAndParams = StateAndParamsMeta & ItemsStateAndParamsBase;

§实验性 DashKit 事件

实验性：此 API 可能在次要版本中发生更改。

DashKit 提供了一个实验性的实例事件 API。使用组件 ref 并通过 dashkitRef.current?.on(eventName, handler) 进行订阅。该方法返回一个取消订阅的回调函数。

支持的第一个事件是 change。当布局发生更改时，在调用 onChange 之前会发出此事件。处理程序可以读取完整的下一个和上一个布局，读取布局补丁，或调用 preventDefault() 来阻止默认的 onChange 调用。

import React from 'react';
import {DashKit} from '@gravity-ui/dashkit';
import type {DashKitChangeEvent} from '@gravity-ui/dashkit';

function Dashboard() {
  const dashkitRef = React.useRef<DashKit>(null);

  React.useEffect(() => {
    const unsubscribe = dashkitRef.current?.on('change', (event: DashKitChangeEvent) => {
      console.log(event.patches);

      if (event.patches.length > 0) {
        event.preventDefault();
      }
    });

    return () => unsubscribe?.();
  }, []);

  return <DashKit ref={dashkitRef} config={config} editMode={true} onChange={onChange} />;
}

type DashKitLayoutPatch = Pick<ConfigLayout, 'i'> &
  Partial<Pick<ConfigLayout, 'x' | 'y' | 'w' | 'h' | 'parent'>>;

type DashKitChangeEvent = {
  patches: DashKitLayoutPatch[];
  layout: ConfigLayout[];
  previousLayout: ConfigLayout[];
  preventDefault: () => void;
  readonly defaultPrevented: boolean;
};

§事件驱动的布局更新

如果您在 change 事件处理程序中使用了 preventDefault()，现在您可以处理布局更新而无需重新初始化 config prop。DashKit 会维护一个内部基线并逐步计算补丁：

function Dashboard() {
  const [config, setConfig] = useState(initialConfig);
  const dashkitRef = useRef<DashKit>(null);

  useEffect(() => {
    const unsubscribe = dashkitRef.current?.on('change', (event) => {
      event.preventDefault(); // 不调用 onChange

      // 只将增量补丁发送到您的后端
      sendPatches(event.patches);

      // 无需调用 setConfig({ ...config, layout: event.layout })
      // DashKit 会在内部维护视觉状态
    });

    return unsubscribe;
  }, []);

  return <DashKit ref={dashkitRef} config={config} editMode onChange={() => {}} />;
}

重要提示： 如果您之后从 props 更新 config.layout（例如，从服务器同步），DashKit 会重置其内部基线以匹配新的 prop。这确保了与事件驱动和受控工作流的兼容性。

§菜单

您可以在编辑模式下为 DashKit 小部件指定自定义覆盖菜单。

type MenuItem = {
  id: string; // 唯一 ID
  title?: string; // 字符串标题
  icon?: ReactNode; // 图标节点
  iconSize?: number | string; // 图标大小，以像素为单位的数字或带单位的字符串
  handler?: (item: ConfigItem) => void; // 自定义菜单项操作处理程序
  visible?: (item: ConfigItem) => boolean; // 用于过滤菜单项的可选可见性处理程序
  className?: string; // 自定义类属性
};

// 在

```css
.custom-theme-wrapper {
  --dashkit-grid-item-edit-opacit: 1;
  --dashkit-overlay-color: var(--g-color-base-float);
  --dashkit-overlay-border-color: var(--g-color-base-float);
  --dashkit-overlay-opacity: 0.5;

  --dashkit-action-panel-border-color: var(--g-color-line-info);
  --dashkit-action-panel-color: var(--g-color-base-float-accent);
  --dashkit-action-panel-border-radius: var(--g-border-radius-xxl);
}

// ....

const CustomThemeWrapper = (props: {
  dashkitProps: DashkitProps;
  actionPanelProps: ActionPanelProps;
}) => {
  return (
    <div className="custom-theme-wrapper">
      <Dashkit {...props.dashkitProps} />
      <ActionPanel {...props.actionPanelProps} />
    </div>
  );
};

§开发

§构建与监听

• 构建依赖 npm ci
• 构建项目 npm run build
• 构建 Storybook npm run start

默认情况下，Storybook 运行在 http://localhost:7120/。 当 Storybook 运行时，项目中的新更改不一定会被立即拾取，因此最好手动重新构建项目并重启 Storybook。

§在开发机上使用 Nginx 进行开发的示例配置

server {
    server_name dashkit.username.ru;

    include common/ssl;

    access_log /home/username/logs/common.access.log;
    error_log /home/username/logs/common.error.log;

    root /home/username/projects/dashkit;

    location / {
        try_files $uri @node;
    }

    location @node {
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_pass http://127.0.0.1:7120;
        proxy_redirect off;
    }
}

§许可证

在 MIT 许可下分发。详情请参阅 LICENSE。

§致 AI 代理

一个仪表盘网格组合器，通过插件系统以响应式网格排列可调整大小、可拖动的组件——当您构建一个用户可编辑的仪表盘（添加/移动/调整大小/删除组件）时，请使用它，而不是手动放置单个图表或面板。

§何时使用

• 渲染一个可配置的仪表盘，其中组件在网格上定位、调整大小和重新排列（基于 react-grid-layout 构建）。
• 用户可编辑的布局：从操作面板添加/删除组件，拖放，带有覆盖控件的编辑模式。
• 基于插件的组件，其中每种组件类型（标题、文本、图表、自定义）仅注册一次，并由 config 驱动。