dance ui

dance-ui

? A simple and elegant component library.

使用pnpm+vite+ts+tailwind 開發的React 組件庫， 採用monorepo 組織，文檔站使用Docusaurus 構建

文檔站在線地址：https://dance.cosine.ren/

Github 地址：https://github.com/dancing-team/dance-ui

NPM 包：https://www.npmjs.com/package/@dance-ui/ui

更新日誌：CHANGE_LOG

? 快速開始

pnpm i @dance-ui/ui

引入組件：組件全覽

 import { Button } from '@dance-ui/ui'

export default ( ) => {
  return < Button type = "primary" > Primary </ Button >
}

? 本地開發

 # install decencies
pnpm i
# build ui & start docs
pnpm start

script 說明

• start依次執行build:ui打包組件庫、 start:docs啟動文檔站
• start:docs不打包組件庫直接啟動文檔站，適用於已經打包過一次的情況
• start:demo打包組件庫後啟動演示項目
• build打包組件庫後打包文檔站
• build:ui單獨打包組件庫
• build:ui-watch單獨打包組件庫，並監視更改實時更新打包，與start:demo 配合可以實時監控組件修改效果
• serve:docs預覽文檔站
• change執行使用changeset add 記錄版本修改
• new新建組件的腳本
• lint對組件庫進行eslint 代碼檢查

新組件開發

• fork 本倉庫
• cd 根目錄， pnpm new來創建一個新組件，輸入組件中文名稱與英文名稱
• 創建完，進入packages/components/src目錄找到自己創建的組件進行開發即可，對應文檔位於packagesexampledocscomponents
• 組件開發完成後， pnpm change可進行更新日誌的記錄，此步也可不做（合併pr後再做調整）