shoelace

Cadarço

Uma biblioteca de componentes da Web com visão de futuro.

• Funciona com todas as estruturas?
• Funciona com CDNs?
• Totalmente personalizável com CSS?
• Inclui um tema sombrio oficial?
• Construído com acessibilidade em mente ♿️
• Código aberto?

Projetado em New Hampshire por Cory Laviska.

---

Documentação: Shoelace.style

Fonte: github.com/shoelace-style/shoelace

Twitter: @shoelace_style

---

Sapateiros?

Sapateiros, ou "Shoelace Developers", podem usar esta documentação para aprender a construir Shoelace a partir da fonte. Você precisará de nó> = 14.17 para construir e executar o projeto localmente.

Você não precisa fazer nada disso para usar o Shoelace! Esta página é para pessoas que desejam contribuir para o projeto, mexer com a fonte ou criar uma construção personalizada de cadarço.

Se não é isso que você está tentando fazer, o site de documentação é onde você deseja estar.

O que você está usando para construir Shoelace?

Os componentes são construídos com o LITELEMENT, uma classe base de elementos personalizados que fornece uma API intuitiva e ligação de dados reativos. A compilação é um script personalizado com pacote movido pela Esbuild.

Batendo o repositório

Comece comprando o repositório no Github, clone -o localmente e instale dependências.

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

Em desenvolvimento

Depois de clonar o repositório, execute o seguinte comando.

npm start

Isso aumentará o servidor dev. Após a compilação inicial, um navegador abrirá automaticamente. Atualmente, não existe recarregamento de módulo quente (HMR), pois o navegador não fornece uma maneira de reiniciar elementos personalizados, mas a maioria das alterações na fonte recarregará o navegador automaticamente.

Prédio

Para gerar uma construção de produção, execute o seguinte comando.

npm run build

Criando novos componentes

Para andaime um novo componente, execute o seguinte comando, substituindo sl-tag-name pelo nome de tag desejado.

npm run create sl-tag-name

Isso gerará um arquivo de origem, uma folha de estilo e uma página de documentos para você. Ao iniciar o servidor de desenvolvimento, você encontrará o novo componente na seção "Componentes" da barra lateral.

Contribuindo

Shoelace é um projeto de código aberto e as contribuições são incentivadas! Se você é interessante em contribuir, revise as diretrizes de contribuição primeiro.

Licença

Shoelace foi criado por Cory Laviska e está disponível nos termos da licença do MIT.

Se você está construindo cadarço ou construindo algo com cadarço - divirta -se criando! ?