前天我們釋出了OpenDataV低代碼開源架構，有很多友友留言想要了解怎麼增加元件，為了友善大家快速上手，馬上趁熱釋出一篇。

OpenDataV計劃采用子庫的方式添加子元件，即每一個元件都當做一個子庫，子庫有自己的依賴，而項目本身的依賴隻針對架構，是以每一個元件我們都當做一個子庫來開發。下面我帶着大家一步步詳細地開發一個數字展示元件。

建立元件目錄和檔案

所有的可拖拽元件都存放在src/resource/components目錄下

cd src/resource/components

預設元件目錄是以元件的名稱命名，當然也可以根據自己的要求命名，元件可以放在components目錄下，也可以放在其子目錄的目錄下。

mkdir DigitalText

建立元件所需的固定檔案

每個元件必須的檔案有vue檔案xxx.vue、配置檔案config.ts、導出檔案index.ts，每個檔案有自己的用處，vue檔案不用說了是元件渲染的主體，導出檔案名稱固定為index.ts，主要是導出元件的資訊給外部引用，配置檔案主要是在編輯頁面右側展示的配置項，這個我們後面再詳述。是以這裡我們需要建立三個檔案：DigitalText.vue、config.ts、index.ts

以上我們就建立好了元件所需的檔案，下面就需要做元件的初始化了

初始化元件檔案

因為我們的元件都是以子庫的方式引入，是以需要進行包的初始化，執行以下指令

cd src/resource/components/Text/DigitalText

npm init

這裡使用npm初始化包會讓我們選擇填寫部分資料。

下面我們先初始化一下元件檔案DigitalText.vue，先初始化最簡單的元件資料

<template>
  <div>數字展示</div>
</template>

<script lang="ts" setup></script>

<style lang="less" scoped></style>

然後我們要初始化元件的配置檔案config.ts

import { ComponentGroup, FormType } from '@/enum'
import type { PropsType } from '@/types/component'
import { BaseComponent } from '@/resource/models'

export const componentName = 'Digital'
class DigitalComponent extends BaseComponent {
  constructor(id?: string, name?: string, icon?: string) {
    super({
      component: componentName,
      group: ComponentGroup.TEXT,
      name: name ? name : '數字文本',
      id,
      width: 100,
      height: 30,
      icon
    })
  }
}

export default DigitalComponent

這裡要說明的點：componentName是元件在項目中的注冊名稱，是以必須保證唯一，group是給元件分組，這裡的分組主要是展示在元件拖拽頁面，其類型的ComponentGroup是固定好的，可以自己增加，展示位置如下：

name是元件在拖拽頁面上顯示的名稱，width和height是元件拖拽到畫布上顯示的初始大小

配置完元件後資料後，就可以配置導出檔案index.ts了，主要是導出元件名、元件對象和配置項。

import DigitalTextComponent, { componentName } from './config'

export default {
  componentName,
  component: () => import('./DigitalText.vue'),
  config: DigitalTextComponent
}

初始化到這一步，我們的元件已經可以在編輯頁面正常使用了，看一下效果：

在右邊的編輯頁面我們看到有樣式和屬性，所有的元件都包含基礎樣式位置大小，包括元件的上下邊距和寬高，屬性包含公共屬性，其中元件群組件ID無法修改，主要是展示來看的，名稱可以修改，名稱屬性主要是展示在圖層上，修改名稱後圖層上會響應的顯示修改後的名稱。

這是最基礎的元件，隻能展示固定資料，不能進行任何配置，下面我們要做元件的配置項。

元件配置項

樣式配置

作為文字顯示元件，最基礎的字型相關屬性配置應該要有，比如字型、字型顔色、字型大小、字型寬度，配置項依然是在配置檔案中添加，繼承自基礎元件類的私有屬性_style

class DigitalTextComponent extends BaseComponent {
  constructor(id?: string, name?: string, icon?: string) {......}
  _style: PropsType[] = [
    {
      label: '字型設定',
      prop: 'font',
      children: [
        {
          prop: 'color',
          label: '顔色',
          type: FormType.COLOR,
          componentOptions: {
            defaultValue: 'skyblue'
          }
        },
        {
          prop: 'fontSize',
          label: '字型大小',
          type: FormType.NUMBER,
          componentOptions: {
            defaultValue: 20
          }
        },
        {
          prop: 'fontWeight',
          label: '字型寬度',
          type: FormType.FONT_WEIGHT,
          componentOptions: {
            defaultValue: 200
          }
        },
        {
          prop: 'fontFamily',
          label: '字型',
          type: FormType.FONT_STYLE,
          componentOptions: {
            defaultValue: 'Arial'
          }
        }
      ]
    }
  ]
}

樣式配置的格式已經定義好了，其中需要注意的是所有children下的子項中prop必須是html元素的css屬性，具體的css屬性名稱并不是我們在style檔案中填寫的，而是在js中對應的名稱，這個可以在網上搜尋：css3 中文手冊，類似如下：

我們再詳述一下各配置項的意義：

label：配置顯示的分組名
prop：唯一的屬性區分，此屬性要與同級别中的其他配置不同
children：此屬性組下面的配置項 label：每個屬性的名稱prop：css屬性值type：屬性編輯時顯示的元件類型，目前可顯示的元件是固定的，類型都定義在FormType中componentOptions：屬性對應的配置項，不同類型的元件有不同的配置項，具體可以在src/types/component.d.ts中檢視定義，所有配置都有defaultValue配置，作為屬性初始化時的預設值

配置完樣式後，我們在編輯頁面看一下效果：

搞清楚了樣式的配置，下面我們再說說屬性的配置，屬性配置與樣式配置格式一緻，有一些小細節需要注意。

屬性配置

屬性配置是繼承私有變量_prop，配置格式與樣式相同，我們這裡配置一個示例屬性：

class DigitalTextComponent extends BaseComponent {
  constructor(id?: string, name?: string, icon?: string) {......}
  _prop: PropsType[] = [
      {
        label: '資料配置',
        prop: 'dataconfig',
        children: [
          {
            prop: 'data',
            label: '資料',
            type: FormType.NUMBER,
            componentOptions: {
              defaultValue: 100000,
              max: 99999999,
              min: 0
            }
          }
        ]
      }
    ]
}

格式這裡就不解釋了，這裡我們用到了數值類型，是以可以配置最大最小值。

接下來就是要在vue檔案中使用屬性配置了，屬性不像樣式，樣式是html元素本身就支援的，是以隻要我們配置好，就可以生效了，但是屬性是元件專有的，什麼屬性要産生什麼效果全憑我們自己書寫邏輯，是以配置好屬性我們隻會在編輯頁面看到屬性展示和配置，但是實際配置後是沒有任何效果的，具體效果我們在vue中實作。

屬性使用

首先我們要添加一個類型定義檔案，因為ts最基礎的優勢就是類型提示，而我們封裝的元件基類是通用的，是以需要在每個元件中使用自己的屬性類型定義，定義如下：

// DigitalText/type.ts
export interface DigitalType {
  dataconfig: {
    data: number
  }
}

為了準确地進行提示，類型定義必須和屬性配置一緻，具體來講就是children下面的prop作為屬性值，children外面的prop作為屬性鍵，可以對比一下type.ts中的配置和_prop的配置。

元件的配置資訊是通過外部傳入的，是以所有元件都必須接收外部資料，我們已經定義好了固定的格式

const props = defineProps<{
  component: DigitalTextComponent
}>()

元件相關的所有資訊都将通過component傳入進來，為了監聽屬性變化和類型提示，我們封裝了一個hook，減少每個元件中通用的處理，useProp的使用如下：

const propChange = (prop: string, key: string, value: number) => {
  console.log(prop, key, value)
}

const { propValue } = useProp<DigitalType>(props.component, propChange)

useProp接收三個參數，一個是component，主要是為了添加類型提示，是以這裡也傳入了一個泛型定義，就是我們在type.ts中定義的類型，另外兩個參數是屬性變化回調函數和樣式變化回調函數。一般情況下我們隻需要處理屬性變化回調，樣式變化是自動生效的，是以基本上不用處理，如果有特殊需求才需要。屬性變化回調函數中有三個參數，prop對應的是屬性配置中外層的prop值，key對應的是屬性配置中children中的prop值，而value就是屬性變化的值。

最終我們的屬性處理結果如下：

<template>
  <div>{{ data }}</div>
</template>

<script lang="ts" setup>
import { ref } from 'vue'
import DigitalTextComponent from './config'
import { useProp } from '@/resource/hooks'
import { DigitalType } from './type'

const props = defineProps<{
  component: DigitalTextComponent
}>()

const propChange = (prop: string, key: string, value: number) => {
  if (prop === 'dataconfig' && key === 'data') {
    data.value = value
  }
}
const { propValue } = useProp<DigitalType>(props.component, propChange)

const data = ref<number>(propValue.dataconfig.data)
</script>

<style lang="less" scoped></style>

看一下頁面上的效果：

上面我們用了屬性回調去處理值變化響應，實際上還有其他的方式可以處理，我們要明白屬性回調的根本需求是什麼？主要就是為了編輯了對應的屬性後，我們在元件内能監測到變化回報到顯示上。相同這一點，可用的方法就多了。

直接使用props傳遞的屬性值在template中渲染資料

<template>
  <div>{{ propValue.dataconfig.data }}</div>
</template>

<script lang="ts" setup>
import DigitalTextComponent from './config'
import { useProp } from '@/resource/hooks'
import { DigitalType } from './type'

const props = defineProps<{
  component: DigitalTextComponent
}>()

const { propValue } = useProp<DigitalType>(props.component)

因為vue響應式的原因，props中的資料是可以響應變化的，那麼我們直接在template中使用即可，不需要做任何監測。

使用computed或者watch監聽屬性變化

這裡和上面是一樣的道理，vue會自動幫我們處理響應式資料，隻要用vue的計算屬性或者watch也可以監聽到屬性變化。

<template>
  <div>{{ data }}</div>
</template>

<script lang="ts" setup>
import { computed } from 'vue'
import DigitalTextComponent from './config'
import { useProp } from '@/resource/hooks'
import { DigitalType } from './type'

const props = defineProps<{
  component: DigitalTextComponent
}>()

const { propValue } = useProp<DigitalType>(props.component)

const data = computed<number>(() => {
  return propValue.dataconfig.data
})
</script>

<style lang="less" scoped></style>

屬性變化回調的另一種用法

<template>
  <div>{{ data }}</div>
</template>

<script lang="ts" setup>
import { ref } from 'vue'
import DigitalTextComponent from './config'
import { useProp } from '@/resource/hooks'
import { DigitalType } from './type'

const props = defineProps<{
  component: DigitalTextComponent
}>()

const propChange = () => {
  data.value = propValue.dataconfig.data
}

const { propValue } = useProp<DigitalType>(props.component, propChange)

const data = ref<number>(propValue.dataconfig.data)
</script>

<style lang="less" scoped></style>

屬性變化回調接收任何參數，我們可以選擇接收參數，也可以不接收參數，在一些配置項比較多的元件中，我們不想在屬性回調中去一個一個判斷變化的屬性，那麼就可以使用這種方式，在這種方式中我們隻是把屬性回調作為一個通知，即通知我們屬性發生變化了，而我們不關心哪一個屬性發生了變化，把所有的屬性都修改一遍即可，雖然聽起來比較麻煩，但是在一些複雜元件中确實很有作用。在這裡我們要明白，隻要屬性發生了變化，那麼prop中的資料也必定發生了變化，是以我們随時取prop中的資料它都是最新的。

總結

到這裡，一個元件的整個添加過程就講完了，根據目前的開發進度來看，基本上所有的部分都講到了，如果有人在使用過程中發現了什麼問題或者有哪些地方不夠清楚的，可以在項目的issue中提，也可以通過其他方式回報。

OpenDataV低代碼平台新增元件流程

建立元件目錄和檔案

初始化元件檔案

元件配置項

樣式配置

屬性配置

屬性使用

總結

繼續閱讀

這個低代碼平台讓企業管理效率翻倍！

DataV 輪播表單元格超長問題處理

低代碼平台選型，别再隻談“拖拉拽”式！

低代碼平台與大屏設計器：化繁為簡，創新無限！💡✨💻🎨大家有沒有聽說過低代碼平台和大屏設計器？這真是讓人眼前一亮的神器啊！

LeaRun低代碼平台提供滿足業務需求的單據、報告等表單列印功能。LeaRun低代碼開發平台提供兩種列印模闆，通用模闆打

[開源]可逆計算原理新一代低代碼平台，含工作流、報表、規則引擎

📱✨低代碼平台：助力移動端創新！快來探索無限可能！🚀随着移動應用市場的迅速發展，低代碼平台正成為創新的關鍵！😎📈🔹無需繁

這就是低代碼平台的弊端！朋友來求助，直接問sqlserver能不能分區，一問資料量多大，居然才1000多萬條！但就是很慢

JeecgBoot 低代碼平台 3.5.3 版釋出！重點更新Online線上開發功能

PaaS低代碼平台源碼：可視化流程開發引擎預置3000+應用內建插件

🚀💡高效生活新玩法！低代碼平台創新更新，全新月曆展示功能上線啦！🗓️🎉不用再為錯過重要事件而煩惱，現在可以一目了然地檢視

前端為什麼越來越不受歡迎呢？這是因為企業級軟體開發已經有十幾年的曆史了，随着時間的推移，需求變得越來越相似，代碼也變得越

React 大資料可視化（大屏展示）解決方案

低代碼開發平台排名，2023年比較受人歡迎的低代碼平台大盤點

🚀jabdp-pro（簡搭專業版）1.0.10版本釋出，企業級低代碼平台！！！🛠️jabdp-pro（簡搭專業版）是一款

百數攜手飛書，開啟企業低代碼辦公協作新方式