讲师中心 微信公众号
AI工具推荐 视频效率加速

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

风瑶姑娘_8596

风瑶姑娘_8596

发布时间:2026-08-08 10:17:08

|

148人浏览过

|

来源于php中文网

原创

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

本文介绍如何构建一个类似 shadcn 的、源码可直接集成到项目的 npm 组件库,使开发者能自由修改组件实现,而非仅使用编译后的产物。

本文介绍如何构建一个类似 shadcn 的、源码可直接集成到项目的 npm 组件库,使开发者能自由修改组件实现,而非仅使用编译后的产物。

要打造一个“可安装、可定制、源码可见”的组件库(如 shadcn/ui),核心思路并非发布编译后的 dist 文件,而是将原始 TypeScript/JSX 源码以 npm 包形式分发,并通过合理的包结构与导出配置,确保用户安装后能直接 import 并修改组件源码。

✅ 正确做法:发布源码包(Source-first Library)

  • 将组件源码(.tsx、.css、类型定义 .d.ts)直接纳入 package.json 的 "files" 字段(例如:["src", "types", "package.json", "README.md"]);
  • 设置 "main" 指向入口文件(如 src/index.ts),并启用 "types": "src/index.d.ts";
  • 关键:不运行 tsc 构建,也不生成 dist/ 目录——让用户项目中的 TypeScript 和 bundler(如 Vite、Next.js)直接处理你的源码,从而支持 HMR、调试和就地编辑。

? 示例 package.json 片段:

{
  "name": "@myorg/my-design-system",
  "version": "0.1.0",
  "files": ["src", "types", "LICENSE", "README.md"],
  "main": "src/index.ts",
  "types": "src/index.d.ts",
  "exports": {
    ".": {
      "types": "./src/index.d.ts",
      "import": "./src/index.ts"
    },
    "./components/button": {
      "types": "./src/components/button/index.d.ts",
      "import": "./src/components/button/index.tsx"
    }
  },
  "peerDependencies": {
    "react": "^18.0.0",
    "react-dom": "^18.0.0"
  }
}

? 用户端集成示例(Vite + React):

npm install @myorg/my-design-system
// src/App.tsx
import { Button } from "@myorg/my-design-system";
// ✅ 可直接跳转到 node_modules/@myorg/my-design-system/src/components/button/index.tsx 修改样式或逻辑

⚠️ 注意事项:

  • 确保 tsconfig.json 中 "declaration": true 且 tsc --noEmit 或配合 tsc -b 生成类型声明(推荐使用 typescript-project-references 或 @rushstack/eslint-patch 保证类型一致性);
  • 避免在包中硬编码 CSS-in-JS 运行时逻辑(如 emotion/styled-components 的动态样式),否则会增加用户 bundle 体积;shadcn 风格推荐使用 clsx + tailwindcss 的原子类组合,完全零运行时;
  • 提供清晰的 postinstall 脚本或 CLI(如 npx my-ds init)帮助用户复制组件模板(类似 npx shadcn-ui@latest init),进一步强化“源码即资产”体验。

总结:这不是传统 UI 库(如 Material UI)的黑盒式分发,而是一种设计系统交付范式——把组件当作可复刻、可演进的代码模板。npm 是基石,但真正价值在于源码透明、零构建耦合、与用户工程深度协同。

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

热门AI工具

更多
蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

相关专题

更多
LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

80

2026.09.30

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

80

2026.09.30

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

40

2026.09.30

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

60

2026.09.29

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

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

280

2026.09.23

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

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

160

2026.09.23

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

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

140

2026.09.23

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

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

80

2026.09.22

热门下载

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

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn