# Utilitários do Design System

Este é o repositório de utilitários para os projetos [GOVBR-DS](http://gov.br/ds/).

## Tecnologias

Esse projeto é desenvolvido usando:

- [Node.js](https://nodejs.org/)

## Dependências

As principais dependências do projeto são:

1. [*Tokens* de *Design*](https://gitlab.com/govbr-ds/govbr-ds)
2. [*Core* do *Design System*](https://gitlab.com/govbr-ds/bibliotecas/javascript/govbr-ds-core)

## Como usar os utilitários em seu projeto?

### Instalação

- Baixe o pacote de utilitários CSS usando o comando: `npm install --save @govbr-ds/utilities-css`;
- Carregue o CSS no seu projeto.

Exemplo **CSS**:

```html
<head>
  <link rel="stylesheet" href="diretorio-dos-utilitarios/dist/styles/utilities.css" />
</head>
```

Exemplo **SCSS**:

```scss
@import "diretorio-dos-utilitarios/src/styles/utilities";
```

### Tipos de utilitários

Os utilitários aplicam os Fundamentos do Design System de forma consistente.

Lista de utilitários:

- Cor de fundo, borda e texto;
- *Grid* e *Flexbox*;
- Espaçamentos;
- Espessuras de bordas e cantos;
- *Overflow* e opacidades;
- Textos, Fontes e Entrelinhas.

### Página de Exemplos

Estão disponíveis alguns exemplos de uso dos Utilitários no diretório "examples".

### Documentação

A documentação completa dos Utilitários está disponível no [Site do Design System](https://www.gov.br/ds/).

## Precisa de ajuda?

> Por favor **não** crie issues para fazer perguntas...

Use nossos canais abaixo para obter tirar suas dúvidas:

- Site do GovBR-DS <http://gov.br/ds>

- Pelo nosso email <govbr-ds@serpro.gov.br>

- Usando nosso canal no discord <https://discord.gg/U5GwPfqhUP>

## Commits

Nesse projeto usamos um padrão para branches e commits. Por favor observe a documentação na nossa [wiki](https://gov.br/ds/wiki/ 'Wiki') para aprender sobre os nossos padrões.

## Apêndice

## Créditos

Os Web Components do [GovBR-DS](https://gov.br/ds/ 'GovBR-DS') são criados pelo [SERPRO](https://www.serpro.gov.br/ 'SERPRO | Serviço Federal de Processamento de Dados') e [Dataprev](https://www.dataprev.gov.br/ 'Dataprev | Empresa de Tecnologia e Informações da Previdência') juntamente com a participação da comunidade.

## Licença

Nesse projeto usamos a licença MIT.
