Shoelace

一个前瞻性的 Web 组件库。

• 适用于所有框架 🧩
• 支持 CDN 🚛
• 可通过 CSS 完全自定义 🎨
• 包含官方深色主题 🌛
• 注重可访问性设计 ♿️
• 开源 😸

由 Cory LaViska 在新罕布什尔州设计。

文档：shoelace.style

源码：github.com/shoelace-style/shoelace

Twitter：@shoelace_style

鞋匠 🥾

鞋匠，或称"Shoelace 开发者"，可以使用此文档学习如何从源码构建 Shoelace。您需要 Node >= 14.17 来在本地构建和运行项目。

使用 Shoelace 不需要执行以下任何操作！ 本页面适用于想要为项目贡献、修改源码或创建自定义 Shoelace 构建的人。

如果这不是您想做的，文档网站才是您需要的地方。

您使用什么来构建 Shoelace？

组件使用 LitElement 构建，这是一个自定义元素基类，提供直观的 API 和响应式数据绑定。构建过程是一个自定义脚本，由 esbuild 提供打包支持。

复刻仓库

首先在 GitHub 上复刻仓库，然后在本地克隆并安装依赖。

git clone https://github.com/YOUR_GITHUB_USERNAME/shoelace
cd shoelace
npm install

开发

克隆仓库后，运行以下命令。

npm start

这将启动开发服务器。初始构建完成后，浏览器将自动打开。目前没有热模块重载（HMR），因为浏览器不提供重新注册自定义元素的方法，但对源码的大多数更改都会自动重新加载浏览器。

构建

要生成生产构建，运行以下命令。

npm run build

创建新组件

要搭建新组件，运行以下命令，将 sl-tag-name 替换为所需的标签名。

npm run create sl-tag-name

这将为您生成源文件、样式表和文档页面。启动开发服务器后，您可以在侧边栏的"Components"部分找到新组件。

贡献

Shoelace 是一个开源项目，欢迎贡献！如果您有兴趣贡献，请先查看贡献指南。

许可证

Shoelace 由 Cory LaViska 创建，并根据 MIT 许可证条款提供。

无论您是构建 Shoelace 还是使用 Shoelace 构建项目 — 祝您创作愉快！🥾