§@gravity-ui/dashkit ·

§DashKit

대시보드 그리드 렌더링 라이브러리입니다.

§설치

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

§설명

이 라이브러리는 위젯을 그리드에 정렬하고, 크기를 조절하며, 새로 추가하거나 삭제하는 데 사용됩니다. 위젯은 React 컴포넌트입니다. 예를 들어, 텍스트, 그래픽, 이미지 등이 있습니다.

새로운 위젯은 플러그인 시스템을 통해 추가됩니다.

§플러그인

플러그인은 사용자 정의 위젯을 만드는 데 필요합니다.

§Props

type ItemManipulationCallback = (eventData: {
    layout: Layouts;
    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: Config입니다.
• editMode: 편집 모드가 활성화되었는지 여부입니다.
• onItemEdit: 위젯 편집을 클릭할 때 호출됩니다.
• onChange: config 또는 itemsStateAndParams가 변경될 때 호출됩니다.
• onDrop: ActionPanel에서 (#DashKitDnDWrapper)를 사용하여 항목을 드롭할 때 호출됩니다.
• 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가 정의된 상태로 호출되고, 그렇지 않으면 data 없이 error: Error와 함께 호출됩니다.

§사용법

§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 생성을 위한 salt
  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';

<ul>
  <li><a href="/en/dashkit/">English</a></li>
  <li><a href="/ko/dashkit/">Korean</a></li>
</ul>

§DashKit

DashKit는 대시보드 레이아웃을 생성하고 관리하기 위한 라이브러리입니다.

§설치

npm install @gravity-ui/dashkit
# or
yarn add @gravity-ui/dashkit

§사용법

import DashKit from '@gravity-ui/dashkit';
import { DashKitProps, ConfigItem } 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',
    // Optional. If new item needed to be inserted in current layout with predefined dimensions
    layout: { // Current item inseterted before 'Ea'
      h: 6,
      w: 12,
      x: 0,
      y: 2,
    },,
  },
  config: config,
  options: {
    // Optional. New layout values for existing items when new element is dropped from 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}[]; // queue
        version: number; // current version itemsStateAndParams
    };
}

또한 위젯 상태 및 매개변수:

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

type ItemsStateAndParams = StateAndParamsMeta & ItemsStateAndParamsBase;

§메뉴

편집 모드에서 사용자 지정 DashKit 위젯 오버레이 메뉴를 지정할 수 있습니다.

type MenuItem = {
  id: string; // uniq id
  title?: string; // string title
  icon?: ReactNode; // node of icon
  iconSize?: number | string; // icon size in px as number or as string with units
  handler?: (item: ConfigItem) => void; // custom item action handler
  visible?: (item: ConfigItem) => boolean; // optional visibility handler for filtering menu items
  className?: string; // custom class property
};

// use array of menu items in settings
<Dashkit overlayMenuItems={[] as Array<MenuItem> | null} />

[deprecated]
// overlayMenuItems property has greater priority over setSettings menu
DashKit.setSettings({menu: [] as Array<MenuItem>});

§ActionPanel에서 항목 드래그

§DashKitDnDWrapper

type DraggedOverItem = {
  h: number;
  w: number;
  type: string;
  parent: string;
  i?: number;
};

interface DashKitDnDWrapperProps {
  dragImageSrc?: string;
  onDragStart?: (dragProps: ItemDragProps) => void;
  onDragEnd?: () => void;
  onDropDragOver?: (draggedItem: DraggedOverItem, sharedItem: DraggedOverItem | null) => void | boolean;
}

• dragImageSrc: 드래그 이미지 미리보기. 기본적으로 투명한 1px png base64가 사용됩니다.
• onDragStart: ActionPanel에서 요소를 드래그할 때 호출되는 콜백입니다.
• onDragEnd: 요소를 드롭하거나 드래그를 취소할 때 호출되는 콜백입니다.

type ItemDragProps = {
    type: string; // 플러그인 타입
    layout?: { // 선택 사항. 미리보기 및 초기화를 위한 레이아웃 항목 크기
        w?: number;
        h?: number;
    };
    extra?: any; // 사용자 정의 컨텍스트
};

type ItemDropProps = {
    commit: () => void; // 모든 구성 작업이 완료된 후 콜백을 호출해야 합니다.
    dragProps: ItemDragProps; // 항목 드래그 속성
    itemLayout: ConfigLayout; // 계산된 항목 레이아웃 치수
    newLayout: ConfigLayout[]; // 요소를 드롭한 후의 새 레이아웃
};

§예시:

const overlayMenuItems = [
  {
    id: 'chart',
    icon: <Icon data={ChartColumn} />,
    title: '차트',
    qa: 'chart',
    dragProps: { // ItemDragProps
        type: 'custom', // 등록된 플러그인 타입
    },
  }
]

const onDrop = (dropProps: ItemDropProps) => {
  // ... 요소를 구성에 추가
  dropProps.commit();
}

<DashKitDnDWrapper>
  <DashKit editMode={true} config={config} onChange={onChange} onDrop={onDrop} />
  <ActionPanel items={overlayMenuItems} />
</DashKitDnDWrapper>

§CSS API

이름	설명
액션 패널 변수
--dashkit-action-panel-color	배경색
--dashkit-action-panel-border-color	테두리 색상
--dashkit-action-panel-border-radius	테두리 반경
액션 패널 항목 변수
--dashkit-action-panel-item-color	배경색
--dashkit-action-panel-item-text-color	텍스트 색상
--dashkit-action-panel-item-color-hover	호버 배경색
--dashkit-action-panel-item-text-color-hover	호버 텍스트 색상
오버레이 변수
--dashkit-overlay-border-color	테두리 색상
--dashkit-overlay-color	배경색
--dashkit-overlay-opacity	투명도
그리드 항목 변수
--dashkit-grid-item-edit-opacity	투명도
--dashkit-grid-item-border-radius	테두리 반경
플레이스홀더 변수
--dashkit-placeholder-color	배경색
--dashkit-placeholder-opacity	투명도

§사용 예시

.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
• 스토리북 빌드 npm run start

기본적으로 스토리북은 http://localhost:7120/에서 실행됩니다. 스토리북이 실행 중일 때 프로젝트의 새 변경 사항이 항상 반영되지 않을 수 있으므로, 프로젝트를 수동으로 다시 빌드하고 스토리북을 다시 시작하는 것이 좋습니다.

§개발 머신에서 개발을 위한 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;
    }
}