0

0

如何用Stencil构建一个可复用的组件库?

夜晨

夜晨

发布时间:2025-09-29 19:23:01

|

738人浏览过

|

来源于php中文网

原创

Stencil通过类React语法构建跨框架Web Components,支持在Angular、React、Vue中使用。1. 初始化项目后,2. 创建带Prop和Slot的可复用组件如my-button,3. 配置stencil.config.ts输出多目标并启用Sass,4. 构建后发布至NPM,5. 在其他框架中引入即可使用,结合文档与类型提示提升体验。

如何用stencil构建一个可复用的组件库?

使用 Stencil 构建可复用的组件库是打造跨框架 Web Components 的高效方式。Stencil 是一个编译工具,能将类 React/TypeScript 语法转换为标准的自定义元素(Web Components),可在 Angular、React、Vue 或纯 HTML 中无缝使用。

1. 初始化 Stencil 项目

开始前确保已安装 Node.js 和 npm。运行以下命令创建一个新的 Stencil 组件库项目:

npm init stencil

选择 component 模板,输入项目名称,完成后进入项目目录。

项目结构包含:

  • src/components/:存放所有组件
  • stencil.config.ts:配置构建行为
  • package.json:定义包名、版本和发布信息

2. 创建可复用组件

src/components 中新建组件文件夹,例如 my-button,并创建 my-button.tsx

import { Component, Prop } from '@stencil/core';

@Component({
tag: 'my-button',
styleUrl: 'my-button.css',
shadow: true
})
export class MyButton {
@Prop() variant: 'primary' | 'secondary' = 'primary';
@Prop() disabled = false;

render() {
return (
<button class={this.variant} disabled={this.disabled}>
<slot></slot>
</button>
);
}
}

这个按钮支持变体和禁用状态,并通过 <slot> 接收内容,具备良好封装性和扩展性。

3. 配置输出目标与样式

编辑 stencil.config.ts,确保组件库输出适用于多环境:

import { Config } from '@stencil/core';
import { sass } from '@stencil/sass';

export const config: Config = {
outputTargets: [
{ type: 'dist' },
{ type: 'docs-readme' },
{ type: 'www', serviceWorker: null }
],
plugins: [sass()]
};

启用 Sass 插件可让你使用 SCSS 编写样式。Shadow DOM 提供样式隔离,避免外部样式干扰。

4. 构建与发布 NPM 包

运行构建命令生成最终产物:

吉卜力风格图片在线生成
吉卜力风格图片在线生成

将图片转换为吉卜力艺术风格的作品

下载
npm run build

输出位于 dist/ 目录,其中 dist/my-component-library 是主入口。

更新 package.json 中的字段:

  • name:如 @your-org/ui-components
  • main:指向 dist/index.cjs.js
  • module:指向 dist/index.esm.js
  • types:指向类型文件
  • files:包含 dist、README 等

登录 npm 后执行:

npm publish dist/

5. 在其他框架中使用

发布后,任何项目都可以安装并使用你的组件:

npm install @your-org/ui-components

在 React 中使用:

import '@your-org/ui-components';

function App() {
return <my-button variant="primary">Click me</my-button>;
}

在 Vue 或原生 HTML 中同样只需引入一次库即可全局注册组件。

基本上就这些。Stencil 让你用现代开发体验构建真正跨框架的 UI 库,核心在于合理设计组件 API 和正确配置打包输出。不复杂但容易忽略的是文档和类型提示,建议配合生成 README 和 Storybook 提升可用性。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

49

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

196

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

67

2026.03.13

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

457

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

549

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

337

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

Sass和less的区别
Sass和less的区别

Sass和less的区别有语法差异、变量和混合器的定义方式、导入方式、运算符的支持、扩展性等。本专题为大家提供Sass和less相关的文章、下载、课程内容,供大家免费下载体验。

216

2023.10.12

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Sass 教程
Sass 教程

共14课时 | 0.9万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

CSS教程
CSS教程

共754课时 | 43.4万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号