如何创建可安装且可定制的组件库(如 shadcn)

夏杰大大_5300

夏杰大大_5300

2026-08-08

982人浏览

原创

如何创建可安装且可定制的组件库(如 shadcn)

本文介绍如何构建一个类似 shadcn 的、源码可直接安装到项目中并自由修改的组件库,核心是通过 npm 包发布 + 本地源码分发实现高度可定制性。

本文介绍如何构建一个类似 shadcn 的、源码可直接安装到项目中并自由修改的组件库,核心是通过 npm 包发布 + 本地源码分发实现高度可定制性。

要打造一个真正“可安装、可编辑、可定制”的组件库(如 shadcn-ui),关键不在于打包成黑盒式二进制包,而在于将组件源码以模块化形式发布为 npm 包,让开发者能直接 npm install 后在项目中看到并修改原始 JSX/TSX 文件。

✅ 正确做法:发布为 ESM + TypeScript 源码包

  • package.json 中设置:
    {
      "name": "@yourorg/ui",
      "version": "1.0.0",
      "main": "./dist/index.js",
      "types": "./dist/index.d.ts",
      "exports": {
        ".": {
          "import": "./dist/index.js",
          "require": "./dist/index.js"
        },
        "./button": {
          "import": "./src/components/button/index.tsx",
          "require": "./src/components/button/index.tsx"
        },
        "./input": {
          "import": "./src/components/input/index.tsx",
          "require": "./src/components/input/index.tsx"
        }
      },
      "files": ["src", "dist", "types", "package.json", "README.md"],
      "typesVersions": {
        "*": {
          "*": ["types/*"]
        }
      }
    }
  • 使用 tsc --buildtsup 构建类型声明与 ESM/CJS 兼容输出,但务必保留 src/ 目录并包含在 files 字段中——这是实现“源码可编辑”的前提。

? 安装后即可直接修改:

npm install @yourorg/ui
# 安装后,node_modules/@yourorg/ui/src/components/button/ 下即为可编辑源码

你甚至可通过 pnpm linknpm link 在本地开发时实时调试;配合 @types/react 和严格 tsconfig,确保类型安全不丢失。

⚠️ 注意事项:

  • ❌ 避免仅发布编译后代码(如只含 dist/)——这会让用户无法修改逻辑或样式;
  • ✅ 推荐使用 "type": "module" + .mjs 或现代 ESM 路径映射,提升 tree-shaking 与路径解析准确性;
  • ? 若需 CLI 支持(如 shadcn 的 npx shadcn-ui@latest add button),需额外开发基于 create-xxxexeca 的命令行工具,读取模板并复制源码到项目 components/ 目录——这才是 shadcn “复制而非安装”的本质;但本方案更轻量、更透明,适合设计系统团队统一维护源码。

总结:真正的可定制组件库 = 源码即包 + 显式路径导出 + 类型完备 + 构建友好。它不是“不可变依赖”,而是“可复刻、可演进的设计契约”。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

20

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

0

15

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

2026.09.23

0

15

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

2026.09.22

0

12

Conan二进制包配置指南
Conan二进制包配置指南

本专题介绍Conan根据操作系统、编译器、架构和构建类型生成二进制包的方法,讲解Profile、Settings、Options及Package ID的作用,帮助管理不同平台和编译环境下的包版本。

2026.09.22

20

13

Conan私有仓库搭建教程
Conan私有仓库搭建教程

本专题系统的讲解Conan私有仓库的搭建流程,涵盖仓库服务部署、存储目录配置、用户认证、权限划分和远程地址添加,并介绍内部C++依赖包的上传、下载及版本维护方法。

2026.09.22

0

19

loomy官网入口地址合集
loomy官网入口地址合集

本专题汇总了 Loomy 桌面 AI 助理的官方入口地址合集及使用指南。提供 macOS 与 Windows 客户端下载 。Loomy 是讯飞推出的桌面级 AI 工作搭子,支持文件整理、数据分析、网页操作及通过飞书/钉钉远程操控电脑,助你高效完成本地办公任务 。

2026.09.22

0

19

NumPy常见函数使用方法
NumPy常见函数使用方法

本专题整理 NumPy 常见函数使用方法相关教程,覆盖函数大全、参数用法、数组运算、统计聚合、排序处理、where 条件筛选、linspace 创建数列等常用场景,帮助读者快速掌握 NumPy 函数调用思路和实际数据处理技巧。

2026.09.22

0

21

NumPy性能优化版本更新与常见报错排查
NumPy性能优化版本更新与常见报错排查

本专题整理 NumPy 性能优化、版本更新与常见报错排查相关教程,覆盖向量化计算、广播性能、内存布局、NumPy 2.0 升级、版本兼容冲突、安装导入报错、dtype 溢出、矩阵运算异常和 broadcasting 报错修复,帮助读者系统掌握 NumPy 性能调优与问题定位方法。

2026.09.22

20

25

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.1万人学习