Shoelace: A forward-thinking library of web components.
Add the following code to your page.
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@email@example.com/cdn/themes/light.css" /> <script type="module" src="https://cdn.jsdelivr.net/npm/@firstname.lastname@example.org/cdn/shoelace-autoloader.js"></script>
Now you have access to all of Shoelace’s components! Try adding a button:
This will activate Shoelace’s experimental autoloader, which registers components on the fly as you use them. To learn more about it, or for other ways to install Shoelace, refer to the installation instructions.
TL;DR – we finally have a way to create our own HTML elements and use them in any framework we want!
Thanks to the popularity of frameworks such as Angular, Vue, and React, component-driven development has become a part of our every day lives. Components help us encapsulate styles and behaviors into reusable building blocks. They make a lot of sense in terms of design, development, and testing.
Unfortunately, framework-specific components fail us in a number of ways:
- You can only use them in the framework they’re designed for 🔒
- Their lifespan is limited to that of the framework’s ⏳
- New frameworks/versions can lead to breaking changes, requiring substantial effort to update components 😭
This is the technology that Shoelace is built on.
Shoelace provides a collection of professionally designed, highly customizable UI components built on a framework agnostic technology. Why spend hundreds of hours (or more) building a design system from scratch? Why make a component library that only works with one framework?
With Shoelace, you can:
- Start building things faster (no need to roll your own buttons)
- Build multiple apps with different frameworks that all share the same UI components
- Fully customize components to match your existing designs
- Incrementally adopt components as needed (no need to ditch your framework)
- Upgrade or switch frameworks without rebuilding foundational components
If your organization is looking to build a design system, Shoelace will save you thousands of dollars. All the foundational components you need are right here, ready to be customized for your brand. And since it’s built on web standards, browsers will continue to support it for many years to come.
Whether you use Shoelace as a starting point for your organization’s design system or for a fun personal project, there’s no limit to what you can do with it.
Shoelace is tested in the latest two versions of the following browsers.
Critical bug fixes in earlier versions will be addressed based on their severity and impact.
If you need to support IE11 or pre-Chromium Edge, this library isn’t for you. Although web components can (to some degree) be polyfilled for legacy browsers, supporting them is outside the scope of this project. If you’re using Shoelace in such a browser, you’re gonna have a bad time. ⛷
Special thanks to the following projects and individuals that help make Shoelace possible.
- Components are built with Lit
- Component metadata is generated by the Custom Elements Manifest Analyzer
- Documentation is powered by 11ty
- CDN services are provided by jsDelivr
- Color primitives are inspired by Tailwind
- Icons are courtesy of Bootstrap Icons
- The homepage illustration is courtesy of unDraw
- Positioning of dropdowns, tooltips, et al is handled by Floating UI
- Animations are courtesy of animate.css
- Search is powered by Lunr
- The Shoelace logo was designed with a single shoelace by Adam K Olson