UNPKG

uc-npm

Version:

统一配置包

97 lines (72 loc) 3.26 kB
# uc-npm [TOC] ## 介绍 该包主要用于统一多个子系统的通用部分,其中包括样式、logo、文字等公共部分。 使用 pnpm+workspace+turborepo 实现的 monorepo 管理方式的公共 npm 包 项目使用 pnpm 作为包管理工具。请自行全局下载。 ## 安装依赖 > pnpm install ## 打包发布 在登陆过 npm 情况下,发布需要修改**根下 version**,并关闭所有的 private 属性。 > pnpm run push ## 使用 > npm i uc-npm ```ts // main.ts import "uc-npm/packages/core/dist/index.css"; ``` ```vue // 使用方法 <script setup lang="ts"> import { getUCConfig } from "uc-npm"; </script> ``` ## 配置文件 main.config.ts 是整个配置中心的核心配置文件。 ### 文字 | 属性 | 用途 | 类型 | | ---------- | ------------ | ------ | | name | 首页项目名称 | string | | title | 页面标题 | string | | copyright | 版权信息 | string | | caseNumber | 备案号 | string | ### 图片 | 属性 | 用途 | 类型 | | ------------- | --------- | ---------------------------- | | logoImg | logo 图片 | {path:string, base64:base64} | | backgroundImg | 背景图片 | {path:string, base64:base64} | ### 样式 属性后缀含有特殊意义,代表要转换的样式名称。详情查看`generatecss.config.json`配置文件 | 属性 | 用途 | 类型 | | -------------- | ---------------------------- | ------ | | defaultTC | 默认字体颜色 | string | | clickTC | 点击字体颜色 | string | | markTC | 标记字体颜色(表格单位) | string | | focusTC | 重点字体颜色(标题) | string | | funcTC | 功能字体颜色(菜单增加按钮) | string | | aidTC | 辅助字体颜色(灰色) | string | | formItemTC | 表单控件描述字体颜色 | string | | whiteTC | 白字 | string | | blackTC | 黑字 | string | | themeBGC | 主题背景颜色 | string | | tabHeaderBGC | 选项卡头部背景颜色 | string | | whiteBGC | 白背景颜色 | string | | blackTCBGC | 黑背景颜色 | string | | tableHeaderBGC | 表格头部背景颜色 | string | | tableBC | 表格边框颜色 | string | | largeTitleTS | 大标题字体 | string | | mediumTitleTS | 中标题字体 | string | | defaultTitleTS | 默认标题字体大小 | string | | miniTitleTS | 小标题字体 | string | | largeTS | 大字体 | string | | mediumTS | 中字体 | string | | defaultTS | 默认字体大小 | string | | miniTS | 小字体 | string | **generatecss.config.rule** | 属性 | 用途 | | ---- | ---------------- | | TC | color | | BGC | background-color | | BC | border-color | | TS | font-size | | BGI | background-image |