Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/viur-framework/vi-shoelace
A collection of professionally designed, every day UI components built on a framework-agnostic technology. 🥾
https://github.com/viur-framework/vi-shoelace
javascript shoelace viur webcomponents
Last synced: 3 months ago
JSON representation
A collection of professionally designed, every day UI components built on a framework-agnostic technology. 🥾
- Host: GitHub
- URL: https://github.com/viur-framework/vi-shoelace
- Owner: viur-framework
- License: mit
- Fork: true (shoelace-style/shoelace)
- Created: 2021-10-26T05:22:38.000Z (about 3 years ago)
- Default Branch: viur
- Last Pushed: 2024-05-29T07:26:11.000Z (5 months ago)
- Last Synced: 2024-07-11T12:31:05.572Z (4 months ago)
- Topics: javascript, shoelace, viur, webcomponents
- Language: TypeScript
- Homepage: https://serene-allen-537100.netlify.app/
- Size: 44.6 MB
- Stars: 7
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
- awesome-viur - Vi Shoelace - Web Component library with ignite style (Official ViUR Resources / <img src="https://github.com/viur-framework/viur-artwork/raw/main/icons/icon-vi.svg" height="32"> Vi Repositories)
README
[](https://serene-allen-537100.netlify.app)
# ViUR-Shoelace
Viur-shoelace is a fork of the great web component library [shoelace.style](https://shoelace.style) by [Cory LaViska](https://twitter.com/claviska).
The fork adapts style, components and some behavior for the [ViUR-Framework](https://github.com/viur-framework). If you don't use the Viur-Framework, please have a look at the [original repo](https://github.com/shoelace-style/shoelace) of Cory LaViska.
If you use this fork in a profit way please support it by [fund its development](https://github.com/sponsors/claviska)
---
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](https://twitter.com/claviska).
---
Documentation: [shoelace.style](https://shoelace.style)
Source: [github.com/shoelace-style/shoelace](https://github.com/shoelace-style/shoelace)
Twitter: [@shoelace_style](https://twitter.com/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](https://shoelace.style) is where you want to be.
### What are you using to build Shoelace?
Components are built with [LitElement](https://lit-element.polymer-project.org/), 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](https://esbuild.github.io/).
### Forking the Repo
Start by [forking the repo](https://github.com/shoelace-style/shoelace/fork) on GitHub, then clone it locally and install dependencies.
```bash
git clone https://github.com/YOUR_GITHUB_USERNAME/shoelace
cd shoelace
npm install
```
### Developing
Once you've cloned the repo, run the following command.
```bash
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.
### Building
To generate a production build, run the following command.
```bash
npm run build
```
### Creating New Components
To scaffold a new component, run the following command, replacing `sl-tag-name` with the desired tag name.
```bash
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.
### Contributing
Shoelace is an open source project and contributions are encouraged! If you're interesting in contributing, please review the [contribution guidelines](CONTRIBUTING.md) first.
## License
Shoelace was created by [Cory LaViska](https://twitter.com/claviska) and is available under the terms of the MIT license.
Whether you're building Shoelace or building something _with_ Shoelace — have fun creating! 🥾