Overview

This article is aimed at InLong-Dashboard plug-in developers, trying to describe the process of developing a Dashboard plug-in as comprehensively as possible, helping developers quickly add a data storage LoadNode, and making plug-in development easier.

Before

The InLong Dashboard itself acts as a front-end console, built with the React framework.

Extend a new sink

In the /inlong-dashboard/src/components/MetaData directory, create a new StorageExample.tsx file, and at the same time export the file in the index.ts file in the current directory (refer to the existing LoadNode writing method ), which completes a new sink named Example.

  1. // export in index
  2. export const Storages: StoragesType[] = [
  3.   // ... omit existing code
  4.   {
  5.     label: 'Example',
  6.     value: 'Example',
  7.     ...StorageExample,
  8.   },
  9. ];

Next, we will introduce how to define the internal structure of the LoadNode.

In the definition of LoadNode, we can view the unified specification of our agreement through the type declaration in the import type { GetStorageFormFieldsType, GetStorageColumnsType } from '@/utils/metaData'; file, here we show a simplest LoadNode definition (emphasis inside the --Focus-- tag):

  1. import { getColsFromFields, GetStorageFormFieldsType } from '@/utils/metaData';
  2. import { ColumnsType } from 'antd/es/table';
  3. import { excludeObject } from '@/utils';
  5. const getForm: GetStorageFormFieldsType = (
  6.   type: 'form' | 'col' = 'form',
  7.   { currentValues, isEdit } = {} as any,
  8. ) => {
  9.   // -- Focus Start --
  10.   const fileds = [
  11.     {
  12.       name: 'name',
  13.       type: 'input',
  14.       label: 'Name',
  15.       _inTable: true,
  16.     },
  17.     {
  18.       name: 'sex',
  19.       type: 'radio',
  20.       label: 'Sex',
  21.       initialValue: 'female',
  22.       props: {
  23.         options: [
  24.           {
  25.             label: 'female',
  26.             value: 'female',
  27.           },
  28.           {
  29.             label: 'male',
  30.             value: 'male',
  31.           },
  32.         ],
  33.         disabled: isEdit && [110, 130].includes(currentValues?.status),
  34.       },
  35.       _inTable: true,
  36.     },
  37.     {
  38.       name: 'age',
  39.       type: 'inputnumber',
  40.       label: 'Age',
  41.       props: {
  42.         min: 1,
  43.         max: 200,
  44.       },
  45.     },
  46.     // -- Focus End --
  47.   ];
  48.   // The following is a generic return
  49.   return type === 'col'
  50.     ? getColsFromFields(fileds)
  51.     : fileds.map(item => excludeObject(['_inTable'], item));
  52. };
  53. // The following is a generic export
  54. const tableColumns = getForm('col') as ColumnsType;
  56. export const StorageExample = {
  57.   getForm,
  58.   tableColumns,
  59. };

In the above example, we define a sink of Example, which consists of three fields: name, sex, age. The field name corresponds to the name attribute (the API interface field that interacts with the manager), and the type attribute represents the display on the front-end page. The input form usually includes input, inputnumber, radio, select and other forms. More complex display forms or the complete definition of the entire object can be obtained through the ts type description.