# Menu Institucional

📢 Use este projeto, [contribua](https://github.com/agencia-e-plus/institutional-menu) para ele ou abra questões para ajudar a evoluí-lo.

![Preview](https://iili.io/pciMSp.png)

## Menu Institucional

[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)

Este aplicativo tem como objetivo renderizar o menu institucional que deve ser cadastrado através do master data.

Lembre-se este aplicativo é uma pequena parte do institucional, para montar uma página completa confira este guia.

### Passo a Passo

1. Adicione o aplicativo como dependência de tema no arquivo `manifest.json`

```
"dependencies": {
    "{vendor}.institutional-menu": "0.x"
  }
```

1. Declarar o bloco principal do aplicativo em um determinado modelo de tema ou dentro de outro bloco do tema.

No exemplo abaixo estamos declarando o institucional menu dentro do aplicativo container.

```
	"container": {
		"children": ["institutional-menu"]
	},
```

#### `institutional-menu` props

| Prop name | Type     | Description                              | Default value |
| --------- | -------- | ---------------------------------------- | ------------- |
| `acronym` | `string` | Acrônimo da tabela criada no master data | `MI`          |

1. Configuração no master data

Obs. Caso não saiba criar tabelas no master data consulte esta documentação.

1. Crie uma data entities com o acronym desejado. `(default: 'MI')`
2. Configure as tabelas da seguinte maneira.

![Preview](https://iili.io/pUKo0u.png)

1. Salve, indexe e publique.
2. Popule os dados, exemplo abaixo.

![Preview](https://iili.io/pUKxUb.png)

### Estilização

Para uma perfeita estilização utilize as classes abaixo, perceba que todas são genéricas e devem possuir um contexto de wrapper em sua volta.

| CSS Handles  |
| ------------ |
| `item`       |
| `link`       |
| `identifier` |
| `active`     |
| `standby`    |
| `error`      |

### Contributors ✨

Obrigado a essas pessoas maravilhosas:

Este projeto segue a especificação [all-contributors](https://github.com/all-contributors/all-contributors). Contribuições de qualquer tipo são bem-vindas!

***
