layui Documentation

Technical Documentation: layui/layui

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

Layui

中文 · English

原生态 Web UI 组件库

Layui 是一套开源免费的 Web UI 组件库，采用纯原生态的 HTML CSS JavaScript 开发模式，它为更便捷地构建现代 Web 界面而生。多年来，凭借别具一格的内外风格而被广泛应用。它给非前端开发者极大地降低了构建复杂网页界面的门槛，开发者只需面向浏览器，即可让页面所需呈现的元素与交互，变得信手拈来。

使用文档 Copy Chapter

• Layui 3 （正在开发中）
• Layui 2

项目参与 Copy Chapter

项目参与者

破旧立新 🌱 Copy Chapter

2016年10月14日，Layui 发布了 1.0.0 首版，此后多年被广泛应用于众多 Web 平台。

2021年10月13日，Layui 发布了原官网下线的公告（导读），并将文档站点切换到了 Gitee Pages，社区及日常维护亦全面转移到了 Gitee 和 Github 平台，以此呼吁大家拥抱其他更好的主流框架，导致大家误以为 Layui 停更了。事实上，自那以后，Layui 仍然在 Github 和 Gitee 保持活跃，并不存在所谓的停止更新，从当时的 2.6.8 一直连续迭代到如今的最新版本。

2023年4月24日，Layui 发布了 2.8.0 正式版，并上线了新的文档站点，这是一次朴实的回归，更是情怀的延续。 但我们仍然坚持两年前那则公告中的观点， 即仍然推荐大家去拥抱主流，始终保持对前沿技术的无限热爱，是开发者们都应具备的思维属性。 而 Layui 所做的，是为填补主流之外的那些略显狭小的空隙。Layui 虽不是前端主流，但也早已不是作者个人的 Layui，而是所有仍在坚持使用它的人的 Layui，它仍然支撑着许多项目，也代表着许多人的工作。作为开源创作者，应该要为这些坚持者而守望。

2025年10月24日，Layui 发布了 2.13.0 重要阶段版本，以致敬过去个中滋味的 10 年，并正式开启一个新的节点。

未来，Layui 会持续陪伴着所有为之热爱的人们，共同去论证 Layui 开发模式的可行性。

开源许可 Copy Chapter

Layui 采用 MIT 许可发布。其他相关协议亦可参考《免责声明》。

Overview (`docs/README.md`) Copy Section

Layui 文档

Layui 3 文档将在后续统一编写。

预览 Copy Chapter

• 最新
• 2.x

.Template Index (`docs/.template/index.md`) Copy Section

title: 组件中文名 组件名 toc: true Copy Chapter

组件中文名

组件介绍

示例

{{- d.include("/组件名/detail/demo.md") }}

API

渲染

组件名.render(options);

• 参数 options : 基础选项。#详见选项

选项

{{- d.include("/组件名/detail/options.md") }}

更多方法的详细介绍

方法传入的参数（opts）是一个 Object 类型的选项，需按照表格的方式展示，如：

| 选项 | 描述 | 类型 | 默认值 |
| --- | --- | --- | --- |
| 选项名 | 该选项的详细介绍 | 该选项支持的数据类型 | 该选项的默认值，若无则填写 `-` |

事件 Copy Chapter

若有的话

事件名

触发时机的描述，若事件支持阻断机制（return false），必须在文档中明确说明。

// 示例代码

💖 心语 Copy Chapter

通常是开发者开发该组件时的内心独白，通过带有感性化的文字与受众建立奇妙的意识沟通。

.Template Detail Demo (`docs/.template/detail/demo.md`) Copy Section

示例1

示例2

.Template Detail Options (`docs/.template/detail/options.md`) Copy Section

.Template Examples Demo (`docs/.template/examples/demo.md`) Copy Section

HTML 模板片段

--- METRICS ---

• Files Extracted: 6
• Estimated Token Budget: ~1058 tokens
• Canonical Reference: https://codewiki.google/github.com/layui/layui