如何通过HTML的Web Components配合Lit库高效开发自定义元素

大杰吖_5294

大杰吖_5294

2026-05-01

797人浏览

原创

litelement已封装响应式属性、模板渲染、样式隔离和生命周期,直接使用可避免手动处理attribute同步、requestupdate调用及shadow dom样式注入等繁琐逻辑。

如何通过html的web components配合lit库高效开发自定义元素

直接用 LitElement 就行,别绕路写原生 Custom Elements + lit-html 组合——LitElement 已经把响应式属性、模板渲染、样式封装、生命周期钩子全打包好了,手动拼接反而容易漏掉 attributeChangedCallback 同步逻辑或忘记调用 requestUpdate()。

为什么不能直接用 lit-html + HTMLElement

你确实能用 lit-html 渲染到 shadowRoot,但会立刻撞上三个硬伤:

  • 属性变更不会自动触发重渲染:原生 HTMLElement 没有 reactive 系统,改了 this.count,render() 不会自己跑
  • HTML 属性(attribute)和 JS 属性(property)不同步:比如 <my-counter count="5"></my-counter>,你得手动在 observedAttributes 和 attributeChangedCallback 里 parse、赋值、再 requestUpdate()
  • 样式无法自动 scoped:lit-html 本身不处理 CSS,你得自己 appendChild style 标签或靠 adoptedStyleSheets,而 LitElement 的 static styles 会自动注入到 shadow root

必须用 @customElement 装饰器注册

不加 @customElement('my-button') 或等价的 customElements.define('my-button', MyButton),浏览器根本不认这是个合法自定义元素——哪怕类继承了 LitElement。常见错误是只写了类、忘了注册,然后在 HTML 里写 <my-button></my-button> 却没反应,控制台也无报错。

注意命名规则:my-button 合法,mybutton 或 MyButton 都非法,浏览器会直接抛 DOMException: "The element name must contain a hyphen"。

property 类型声明决定 attribute 可否序列化

static properties 不只是为了类型提示,它直接控制 Lit 如何同步 attribute ↔ property:

Wechat HTML Publisher
Wechat HTML Publisher

直接上传HTML富文本到微信公众号草稿箱。支持完整的HTML格式,无需Markdown转换。

下载
  • count: { type: Number } → 浏览器会把 count="42" 自动转成数字,且修改 this.count = 100 会反向更新 attribute(如果 reflect: true)
  • items: { type: Array } → attribute 不支持传数组,<my-list items='["a","b"]'></my-list> 会被当字符串解析;这种场景必须用 JS property 传值,比如 el.items = [1,2,3]
  • 没声明 type 的 property(如 @property() label)默认为 String,且不 reflect 到 attribute,适合内部状态

别指望 JSON.stringify 过的字符串能被自动还原成对象——Lit 不做这层解析,那是你自己的 attributeChangedCallback 该干的事(但用了 LitElement 就不该这么干)。

authentik 项目里必须继承 AKElement 而非 LitElement

如果你在 authentik 代码库中开发组件,AKElement 是封装好的基类,位于 web/src/elements/Base.ts。它已预置主题变量(--ak-color-primary)、全局样式重置、以及和 authentik 后端通信的快捷方法。

直接继承 LitElement 会导致:

  • 主题色失效:CSS 中的 var(--ak-color-primary) 没定义,显示为 fallback 值(通常是 inherit 或 initial)
  • 缺少 connectedCallback 中的初始化钩子(如 token 检查、i18n 加载),可能引发后续 API 调用失败
  • 构建时样式未被统一打包进 base.css,导致本地开发正常、CI 构建后样式丢失

正确写法是:import { AKElement } from '#elements/Base';,然后 export class AkLoginButton extends AKElement。

最常被忽略的是:LitElement 的 render() 方法必须返回 html 模板,不能返回字符串或空值;一旦返回 undefined 或 null,整个 shadow DOM 会清空,且不报错——这个静默失败很难定位。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

HTML速学教程(入门课程)
HTML速学教程(入门课程)

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

下载

相关标签:

html

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2949

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2228

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1180

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1138

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1316

5

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

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

2023.09.20

2058

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3260

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

14535

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
GDB 17.2 官方文档集合
GDB 17.2 官方文档集合

共0课时 | 0人学习

Bootstrap 入门安装配置
Bootstrap 入门安装配置

共0课时 | 0人学习

38+ PhpStorm 提示和技巧
38+ PhpStorm 提示和技巧

共1课时 | 220人学习