Pular para o conteúdo principal

icon()

Função auxiliar que carrega um ícone SVG do diretório de ícones do template e retorna o conteúdo pronto para ser inserido no HTML. O arquivo SVG é mantido em cache durante a execução para evitar novas leituras do arquivo quando o mesmo ícone for utilizado novamente.

Os atributos width e height do SVG são ajustados automaticamente. Quando height não é informado, o mesmo valor de width é utilizado para ambos.

Parâmetros:
$name string Nome base do arquivo SVG localizado em assets/icons/, sem a extensão .svg.
$width int Largura do ícone. Padrão: 20.
$height int Altura do ícone. Padrão: 20. Se vazio, utiliza o valor de $width

Retorno: string
Conteúdo SVG do ícone com os atributos de dimensão ajustados.

Exemplo de uso:
<?= icon('search') ?>

<?= icon('user', 24) ?>

<?= icon('arrow-right', 16, 20) ?>
Exemplo de saída:
<svg aria-hidden="true" width="20" height="20" viewBox="0 0 24 24">
    ...
</svg>
Notas
  • Os arquivos dos ícones devem estar localizados em assets/icons/ dentro do template.
  • A extensão .svg não deve ser informada no parâmetro $name

Setor: FunctionsResources