Vue3 企業級優雅實戰 - 組件庫框架 - 3 搭建組件庫開發環境

来源:https://www.cnblogs.com/youyacoder/archive/2022/11/11/16880496.html
-Advertisement-
Play Games

前文已經初始化了 workspace-root,從本文開始就需要依次搭建組件庫、example、文檔、cli。本文內容是搭建 組件庫的開發環境。 ...


前文已經初始化了 workspace-root,從本文開始就需要依次搭建組件庫、example、文檔、cli。本文內容是搭建 組件庫的開發環境。

1 packages 目錄

前面在項目根目錄下創建了 packages 目錄,該目錄存放組件庫的所有組件組件庫的入口。該目錄中已經創建了兩個子目錄 fooyyg-demo-ui。這兩個目錄是幹嘛用的呢?

1.1 foo 目錄

foo 目錄代表一個示例組件,後面咱們會使用該組件來測試組件庫在 example 和組件庫文檔中是否能正常運行。後續要開發的所有組件(如高級卡片組件、JSON Schema 表單組件等)都與 foo 組件的文件目錄結構保持一致。

1.2 yyg-demo-ui 目錄

該目錄與整個組件庫工程的名稱相同,所以你本地的這個目錄不一定叫這個名稱。該目錄是組件庫的入口模塊,該模塊會安裝組件庫的所有組件(即 packages 目錄下的其他包)作為依賴,並引入全部組件,統一暴露。此外還是打包組件庫的入口。可以將它理解為組件庫的聚合模塊。

2 實現 foo 示例組件

2.1 初始化 package.json

foo 目錄存放示例組件,它也是一個包,所以需要在命令行中進入 packages/foo 目錄,使用 pnpm 初始化:

pnpm init

修改生成的 package.json 中的 name 屬性值為 foo,在 monorepo 中,子包的 name 屬性通常會命名為 @組織名/foo,由於咱是個組件庫,可以將其命名為 @組件庫名/foo,即 @yyg-demo-ui/foo。我修改了 package.json 的下麵幾個屬性:

{
  "name": "@yyg-demo-ui/foo",
  "version": "1.0.0",
  "description": "示例組件",
  "author": "程式員優雅哥 youyacoder",
  "main": "index.ts",
...
}

2.2 初始化 foo 目錄結構

在命令行中進入 foo 目錄:

  1. 創建 index.ts 文件,該文件為組件的入口文件:
touch index.ts
  1. 創建 src 目錄,該目錄存放組件的實現源碼。在 foo/src/ 中創建 index.tsxtypes.ts,前者是組件的具體實現,後者是組件的 props 定義及類型:
mkdir src
touch src/index.tsx src/types.ts

如此一來,示例組件 foo 的目錄結構便創建完成,目錄結構如下:

packages/
|- foo/
		|- index.ts
		|- src/
				|- index.ts
				|- types.ts
|- yyg-demo-ui/

2.3 定義 foo 組件的 props

foo/src/types.ts 中定義 foo 組件的 props,並提取其類型:

import { ExtractPropTypes } from 'vue'

export const fooProps = {
  msg: {
    type: String,
    required: false,
    default: ''
  }
}

export type FooProps = ExtractPropTypes<typeof fooProps>

上面的代碼定義了一個非必填的屬性 msg,並使用 vue 中提供的 ExtractPropTypes 提取 props 的類型。

2.4 實現 foo 組件

foo/src/index.tsx 中實現 foo 組件:

import { defineComponent } from 'vue'
import { fooProps } from './types'

const NAME = 'yyg-foo'

export default defineComponent({
  name: NAME,
  props: fooProps,
  setup (props, context) {
    console.log(props, context)
    const onBtnClick = () => {
      console.log('點擊按鈕測試', props.msg)
    }
    return () => (
      <div class={NAME}>
        <h1>yyg-demo-ui Foo</h1>
        <p class={NAME + '__description'}>msg is: { props.msg }</p>
        <el-button type='primary' onClick={onBtnClick}>點擊我</el-button>
      </div>
    )
  }
})

該組件僅簡單展示文本和 Element Plus 的按鈕,用於測試。

2.5 定義 foo 組件入口文件

foo/index.ts

import { App } from 'vue'
import Foo from './src'

Foo.install = (app: App) => {
  app.component(Foo.name, Foo)
}

export default Foo

該文件將組件導入並導出,並且為該組件提供 install 方法。這樣便完成了 foo 組件的代碼編寫。

3 實現 yyg-demo-ui

完成 foo 示例組件後,就需要開始開發組件庫入口 yyg-demo-ui 了。第一步仍是初始化 package.json

3.1 初始化 package.json

在命令行中進入 packages/yyg-demo-ui 目錄:

pnpm init

同上修改生成的 package.json 文件的 name 屬性:

{
  "name": "@yyg-demo-ui/yyg-demo-ui",
  "version": "1.0.0",
  "description": "組件庫入口",
  "author": "程式員優雅哥 youyacoder",
  "main": "index.ts",
  ...
}

3.2 安裝依賴

fooyyg-demo-ui 都是獨立的包,yyg-demo-ui 需要安裝 foo 到依賴中,才能引入 foo 組件。在 2.1 中將 foopackage.json name 屬性修改為 @yyg-demo-ui/foo,安裝時要使用該名稱。從控制臺中進入 packages/yyg-demo-ui ,執行命令:

pnpm install @yyg-demo-ui/foo

此時查看 packages/yyg-demo-ui/package.jsondependencies,會看到使用 workspace協議依賴了 foo

"dependencies": {
  "@yyg-demo-ui/foo": "workspace:^1.0.0"
}

同時在 node_modules 中也可以看到多了一個 @yyg-demo-ui/foo

image-20221105001615752

3.3 定義入口文件

packages/yyg-demo-ui 下創建 index.ts,導入組件並導出:

import { App } from 'vue'
import Foo from '@yyg-demo-ui/foo'
// import component end
import '../scss/index.scss'

const components = [
  Foo
] // components

// 全局動態添加組件
const install = (app: App): void => {
  components.forEach(component => {
    app.component(component.name, component)
  })
}

export default {
  install
}

到這裡咱們基本完成了組件的開發環境搭建,但遺留了三個問題:

  1. 組件及組件庫的樣式定義
  2. 如何查看組件的效果
  3. 組件庫如何構建打包發佈

這些問題在後面的文章中會依次解答。下一篇文章將分享組件庫的 CSS 架構和 example 搭建。

感謝你閱讀本文,如果本文給了你一點點幫助或者啟發,還請三連支持一下,點贊、關註、收藏,程式員優雅哥會持續與大家分享更多乾貨


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 在物聯網、監控、感測器、金融等應用領域,數據在時間維度上流式的產生,而且數據量非常龐大。 例如我們經常看到的性能監控視圖,就是很多點在時間維度上描繪的曲線。 又比如金融行業的走勢數據等等。 我們想象一下,如果每個感測器或指標每100毫秒產生1個點,一天就是864000個點。 而感測器或指標是非... ...
  • 你聽過多少款無伺服器架構(Serverless)資料庫? 什麼是Serverless呢?簡單理解,Serverless 分為 FaaS 和 BaaS 兩個部分,其中 FaaS 指的是函數即服務,BaaS 是後端即服務。 舉個例子,用戶瀏覽網頁,可能涉及CDN資源。如果是靜態內容,從對象存儲下載照片、 ...
  • 1 、MySQL資料庫的性能監控 1.1、如何查看MySQL資料庫的連接數 連接數是指用戶已經創建多少個連接,也就是MySQL中通過執行 SHOW PROCESSLIST命令輸出結果中運行著的線程個數的詳情,如圖所示。 SHOW PROCESSLIST預設情況下只顯示前100條記錄的詳情,如果超過1 ...
  • 一. 單行函數:可以理解為向函數傳入一個參數,返回一個值。 單行函數是指對每一題記錄輸入值進行計算,並得到相應的計算結果,然後返回給用戶,也就是說,每條記錄作為一個輸入參數,經過函數計算得到每條記錄的計算結果。 單行函數 -- 函數舉例: select empno,ename, lower(enam ...
  • 作為一個批流統一的數據集成框架,秉承著易用、穩定、高效的目標,ChunJun於2018年4月29日在Github上將內核源碼正式開放。 從還被叫作FlinkX,寫下第一行代碼開始,ChunJun已經走過了第六個年頭,經歷了從分散式離線/實時數據同步插件,晉級為批流統一數據集成框架的蛻變時刻。越來越多 ...
  • 3D儲能、3D配電站、3D太陽能、三維儲能、使用three.js(webgl)搭建智慧樓宇、3D園區、3D廠房、3D倉庫、設備檢測、數字孿生、物聯網3D、物業3D監控、物業基礎設施可視化運維、3d建築,3d消防,消防演習模擬,3d庫房,webGL,threejs,3d機房,bim管理系統 ...
  • 隨著移動互聯網的飛速發展,無數移動APP琳琅滿目;在移動App的發展的基礎上,衍生了小程式、輕應用技術,它隨時可用,但又無需安裝卸載。uni-app 是一個使用 Vue.js 開發所有前端應用的框架,開發者編寫一套代碼,可發佈到iOS、Android、Web(響應式)、以及各種小程式等多個平臺。AI... ...
  • 在這個系列文章里,我嘗試將自己開發唯一客服系統(gofly.v1kf.com)所涉及的經驗和技術點進行梳理總結。 文章寫作水平有限,有時候會表達不清楚,難免有所疏漏,歡迎批評指正 該系列將分成以下幾個部分 一. 需求分析 二. 初步技術方案選型,驗證 三. 資料庫結構設計 四. WEB訪客前端設計與 ...
一周排行
    -Advertisement-
    Play Games
  • 概述:在C#中,++i和i++都是自增運算符,其中++i先增加值再返回,而i++先返回值再增加。應用場景根據需求選擇,首碼適合先增後用,尾碼適合先用後增。詳細示例提供清晰的代碼演示這兩者的操作時機和實際應用。 在C#中,++i 和 i++ 都是自增運算符,但它們在操作上有細微的差異,主要體現在操作的 ...
  • 上次發佈了:Taurus.MVC 性能壓力測試(ap 壓測 和 linux 下wrk 壓測):.NET Core 版本,今天計劃準備壓測一下 .NET 版本,來測試並記錄一下 Taurus.MVC 框架在 .NET 版本的性能,以便後續持續優化改進。 為了方便對比,本文章的電腦環境和測試思路,儘量和... ...
  • .NET WebAPI作為一種構建RESTful服務的強大工具,為開發者提供了便捷的方式來定義、處理HTTP請求並返迴響應。在設計API介面時,正確地接收和解析客戶端發送的數據至關重要。.NET WebAPI提供了一系列特性,如[FromRoute]、[FromQuery]和[FromBody],用 ...
  • 原因:我之所以想做這個項目,是因為在之前查找關於C#/WPF相關資料時,我發現講解圖像濾鏡的資源非常稀缺。此外,我註意到許多現有的開源庫主要基於CPU進行圖像渲染。這種方式在處理大量圖像時,會導致CPU的渲染負擔過重。因此,我將在下文中介紹如何通過GPU渲染來有效實現圖像的各種濾鏡效果。 生成的效果 ...
  • 引言 上一章我們介紹了在xUnit單元測試中用xUnit.DependencyInject來使用依賴註入,上一章我們的Sample.Repository倉儲層有一個批量註入的介面沒有做單元測試,今天用這個示例來演示一下如何用Bogus創建模擬數據 ,和 EFCore 的種子數據生成 Bogus 的優 ...
  • 一、前言 在自己的項目中,涉及到實時心率曲線的繪製,項目上的曲線繪製,一般很難找到能直接用的第三方庫,而且有些還是定製化的功能,所以還是自己繪製比較方便。很多人一聽到自己畫就害怕,感覺很難,今天就分享一個完整的實時心率數據繪製心率曲線圖的例子;之前的博客也分享給DrawingVisual繪製曲線的方 ...
  • 如果你在自定義的 Main 方法中直接使用 App 類並啟動應用程式,但發現 App.xaml 中定義的資源沒有被正確載入,那麼問題可能在於如何正確配置 App.xaml 與你的 App 類的交互。 確保 App.xaml 文件中的 x:Class 屬性正確指向你的 App 類。這樣,當你創建 Ap ...
  • 一:背景 1. 講故事 上個月有個朋友在微信上找到我,說他們的軟體在客戶那邊隔幾天就要崩潰一次,一直都沒有找到原因,讓我幫忙看下怎麼回事,確實工控類的軟體環境複雜難搞,朋友手上有一個崩潰的dump,剛好丟給我來分析一下。 二:WinDbg分析 1. 程式為什麼會崩潰 windbg 有一個厲害之處在於 ...
  • 前言 .NET生態中有許多依賴註入容器。在大多數情況下,微軟提供的內置容器在易用性和性能方面都非常優秀。外加ASP.NET Core預設使用內置容器,使用很方便。 但是筆者在使用中一直有一個頭疼的問題:服務工廠無法提供請求的服務類型相關的信息。這在一般情況下並沒有影響,但是內置容器支持註冊開放泛型服 ...
  • 一、前言 在項目開發過程中,DataGrid是經常使用到的一個數據展示控制項,而通常表格的最後一列是作為操作列存在,比如會有編輯、刪除等功能按鈕。但WPF的原始DataGrid中,預設只支持固定左側列,這跟大家習慣性操作列放最後不符,今天就來介紹一種簡單的方式實現固定右側列。(這裡的實現方式參考的大佬 ...