@platformbuilders/react-elements
Version:
Platform Builders Shared Components Library For React Web
51 lines (33 loc) • 2.22 kB
Markdown
---
id: component.icon
title: Icon
---
<!-- Component declaration begin -->
import { Icon } from '@platformbuilders/react-elements';
<!-- Component declaration end -->
<!-- Documentation begin -->
Esse componente tem como função auxiliar na manipulação, manutenção e padronização dos ícones dentro de uma aplicação.
## Exemplo
### Fonte
```javascript
import { Icon } from '@platformbuilders/react-elements';
<Icon name="erroneousName" color="#fff" size="default" />;
```
### Visualização
> O componente Icon tem dependência com o _@material-ui/core_ portanto quando um ícone não é encontrado, as duas primeiras letras do nome declarado são renderizadas.
<Icon
name="erroneousName"
color="#fff"
size="default"
/>
## Ícones
Para saber os ícones possíveis do _@material-ui/core_, podemos consultar [aqui](https://material-ui.com/pt/components/material-icons/).
## Atributos
| Formato | Conceito | Tipo |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| **name** | É o atributo que define o nome do componente. | **string** |
| **children?** | Elemento filho do componente. | **React.ReactNode** |
| **color** | É a cor do ícone, podendo seguir um _theme_ usando as opções: _"inherit", "primary", "secondary", "action", "error", "disabled", undefined_ | **string** |
| **key?** | Geralmente utilizado em listas, onde cada elemento tem sua chave. | **string** |
| **size?** | Define o tamanho do ícone, podendo ser: _"small", "inherit", "default", "large", undefined_ . | **string** |
<!-- Documentation end -->