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 (

);
}
}

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

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 包

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

第一团购
第一团购

第一团购软件是基于Web应用的B/S架构的团购网站建设解决方案的建站系统。它可以让用户高效、快速、低成本的构建个性化、专业化、强大功能的团购网站。从技术层面来看,本程序采用目前软件开发IT业界较为流行的ASP.NET和SQLSERVER2000数据库开发技术架构。从功能层面来看,前台首页每天显示一个服务或插产品的限时限最低成团人数的团购项目,具有邮件订阅,好友邀请,人人网、开心网、新浪微博、MSN

下载
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 Click me;
}

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

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

相关专题

更多
json数据格式
json数据格式

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

408

2023.08.07

json是什么
json是什么

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

532

2023.08.23

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

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

309

2023.10.13

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

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

74

2025.09.10

css
css

css是层叠样式表,用来表现HTML或XML等文件样式的计算机语言,不仅可以静态地修饰网页,还可以配合各种脚本语言动态地对网页各元素进行格式化。php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

509

2023.06.15

css居中
css居中

css居中:1、通过“margin: 0 auto; text-align: center”实现水平居中;2、通过“display:flex”实现水平居中;3、通过“display:table-cell”和“margin-left”实现居中。本专题为大家提供css居中的相关的文章、下载、课程内容,供大家免费下载体验。

262

2023.07.27

css如何插入图片
css如何插入图片

cssCSS是层叠样式表(Cascading Style Sheets)的缩写。它是一种用于描述网页或应用程序外观和样式的标记语言。CSS可以控制网页的字体、颜色、布局、大小、背景、边框等方面,使得网页的外观更加美观和易于阅读。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

752

2023.07.28

css超出显示...
css超出显示...

在CSS中,当文本内容超出容器的宽度或高度时,可以使用省略号来表示被隐藏的文本内容。本专题为大家提供css超出显示...的相关文章,相关教程,供大家免费体验。

536

2023.08.01

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

97

2026.01.09

热门下载

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

精品课程

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

共14课时 | 0.8万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.9万人学习

CSS教程
CSS教程

共754课时 | 18.4万人学习

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

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