A forward-thinking library of web components.
Go to file
Cory LaViska cf85d6af41 fix localize bug 2023-09-27 13:03:35 -04:00
.github remove default assignee 2023-08-09 16:13:52 -04:00
.husky update dependencies, cleanup, refine (#642) 2022-01-06 08:44:13 -05:00
.vscode sort this, eslint 2023-01-13 15:43:55 -05:00
docs fix localize bug 2023-09-27 13:03:35 -04:00
scripts clean up messaging 2023-09-07 21:38:16 -04:00
src rename private var; #1572 2023-09-26 09:05:17 -04:00
.editorconfig Update .editorconfig (#880) 2022-08-26 09:16:57 -04:00
.eslintignore Button tests (#667) 2022-03-11 08:56:24 -05:00
.eslintrc.cjs Lit a11y update (#1444) 2023-07-12 11:12:15 -04:00
.gitignore ignore package.json 2023-09-27 13:02:20 -04:00
.gitpod.yml Adding Gitpod support (#661) 2022-02-01 16:53:49 -05:00
.prettierignore ignore package.json 2023-08-16 14:57:03 -04:00
CONTRIBUTING.md update docs 2021-03-23 13:52:15 -04:00
LICENSE.md 2.0 cleanup 2020-07-15 17:30:37 -04:00
README.md new docs 2023-06-06 08:22:18 -04:00
cspell.json update docs 2023-08-18 12:05:22 -04:00
custom-elements-manifest.config.js simplify implementation 2023-09-07 23:04:31 -04:00
lint-staged.config.js feat: add ESLint, improve types, improve a11y 2022-01-15 21:47:14 -08:00
package-lock.json fix localize bug 2023-09-27 13:03:35 -04:00
package.json fix localize bug 2023-09-27 13:03:35 -04:00
prettier.config.cjs add env 2022-04-15 09:26:36 -04:00
tsconfig.json fix: use verbatimModuleSyntax and isolatedModules (#1534) 2023-08-23 10:34:40 -04:00
tsconfig.prod.json remove baseUrl from tsconfig for better dev experience (#1530) 2023-08-22 10:32:15 -04:00
web-test-runner.config.js fix regression; #1417 2023-07-03 15:49:25 -04:00



A forward-thinking library of web components.

  • Works with all frameworks 🧩
  • Works with CDNs 🚛
  • Fully customizable with CSS 🎨
  • Includes an official dark theme 🌛
  • Built with accessibility in mind
  • Open source 😸

Designed in New Hampshire by Cory LaViska.

Documentation: shoelace.style

Source: github.com/shoelace-style/shoelace

Twitter: @shoelace_style

Shoemakers 🥾

Shoemakers, or "Shoelace developers," can use this documentation to learn how to build Shoelace from source. You will need Node >= 14.17 to build and run the project locally.

You don't need to do any of this to use Shoelace! This page is for people who want to contribute to the project, tinker with the source, or create a custom build of Shoelace.

If that's not what you're trying to do, the documentation website is where you want to be.

What are you using to build Shoelace?

Components are built with LitElement, a custom elements base class that provides an intuitive API and reactive data binding. The build is a custom script with bundling powered by esbuild.

Forking the Repo

Start by forking the repo on GitHub, then clone it locally and install dependencies.

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


Once you've cloned the repo, run the following command.

npm start

This will spin up the dev server. After the initial build, a browser will open automatically. There is currently no hot module reloading (HMR), as browser's don't provide a way to reregister custom elements, but most changes to the source will reload the browser automatically.


To generate a production build, run the following command.

npm run build

Creating New Components

To scaffold a new component, run the following command, replacing sl-tag-name with the desired tag name.

npm run create sl-tag-name

This will generate a source file, a stylesheet, and a docs page for you. When you start the dev server, you'll find the new component in the "Components" section of the sidebar.


Shoelace is an open source project and contributions are encouraged! If you're interesting in contributing, please review the contribution guidelines first.


Shoelace is designed in New Hampshire by Cory LaViska. Its available under the terms of the MIT license.

Designing, developing, and supporting this library requires a lot of time, effort, and skill. Id like to keep it open source so everyone can use it, but that doesnt provide me with any income.

Therefore, if youre using my software to make a profit, I respectfully ask that you help fund its development by becoming a sponsor. There are multiple tiers to choose from with benefits at every level, including prioritized support, bug fixes, feature requests, and advertising.

👇 Your support is very much appreciated! 👇

Whether you're building Shoelace or building something with Shoelace — have fun creating! 🥾