Skip to content

kaioid/ui-components-workspace

Repository files navigation

ui-components-workspace

Workspace focado somente na lib Angular @kaioid/ui-components.

Criei essa lib principalmente para uso em aplicações pessoais, mas o repositório está aberto para melhorias e contribuições.

Instalar (em um projeto consumidor)

Instale o pacote:

npm i @kaioid/ui-components

Importar tokens de CSS (recomendado)

Em styles.css (ou equivalente) do seu projeto consumidor:

@import '@kaioid/ui-components/styles/tokens.css';

Isso disponibiliza as CSS variables usadas pelos componentes (inclui suporte a .dark).

Usar um componente (exemplo)

Os componentes são standalone, então você pode importar direto no componente consumidor.

import { Component } from '@angular/core';
import { ButtonComponent } from '@kaioid/ui-components';

@Component({
	standalone: true,
	selector: 'app-example',
	imports: [ButtonComponent],
	template: `<ui-button variant="primary">Salvar</ui-button>`,
})
export class ExampleComponent {}

Desenvolvimento (este workspace)

Pré-requisito: Node + npm instalados.

Instalar dependências:

npm install

Build da lib (dev):

npm run build:ui

Build da lib (prod):

npm run build:ui:prod

Testes:

npm test

Validar o pacote sem publicar (dry-run):

npm run dryrun:ui

Contribuições

Contribuições são bem-vindas.

  • Abra uma issue com bug/feature request (inclua passos para reproduzir e prints quando fizer sentido).
  • Envie PRs pequenos e focados (1 tema por PR) com descrição objetiva.
  • Antes do PR, rode npm test e pelo menos npm run build:ui:prod.

Se você usa essa lib e quer sugerir componentes/ajustes para fluxos de apps pessoais (ex.: admin, dashboard, forms), manda a ideia — vou tentar priorizar o que for mais útil.