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 提升可用性。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

420

2023.08.07

json是什么
json是什么

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

536

2023.08.23

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

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

311

2023.10.13

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

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

77

2025.09.10

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

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

203

2023.10.12

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

237

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

458

2024.03.01

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

531

2023.09.20

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

9

2026.01.30

热门下载

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

精品课程

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

共14课时 | 0.8万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.1万人学习

CSS教程
CSS教程

共754课时 | 25.2万人学习

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

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