z-ui-pc

适用于pc端的前端组件库

开发注意事项

• ！！！组件不要使用 useTemplateRef 否者打包出来部分代码会有警告：Set operation on key "value" failed: target is readonly
• 因为 vite-plugin-dts 启用了 @microsoft/api-extractor 合并声明文件所以不支持 export default xxx 语法，所以如果有导出默认需求的，请使用

const defaultExportData = {
  test: "test",
};
/**
 * 使用 export default xxx 会导致编译失败：The "default" symbol has a ts.SyntaxKind.ExportAssignment declaration which is not (yet?) supported by API Extractor
 * 下面两种方式选一种即可。
 */
export { defaultExportData as default };
// or
export default defaultExportData;

快速开始

安装依赖

  npm i

本地开发

  # dev 跑的话是跑 monorepo 打包出来的，play下所有的组件指向的都是dist目录下的内容，跑 dev 需要先跑 build:dev
  npm run dev
  # dev:local 跑的话是直接指向源码，即 src 下目录的组件
  npm run dev:local

打包代码

  npm run build

查找、修复代码问题

  z run eslint
  # 或者
  z r e

格式化代码

  z run prettier
  # 或者
  z r p

检测类型问题

  z run type-check
  # 或者
  z r tc

检测依赖更新

  z run dependency-check
  # 或者
  z r dc

常见问题

列出开发中常见的问题和解决方案

了解更多

在此处放入飞书文档链接。请在组件手册中按照分类新建文档。