Exports
import {
Github, // e qualquer outra marca (import nomeado)
Glifo, // componente dinâmico por string
registry, // Record<slug, GlifoIcon>
} from 'glifo';
import type { GlifoProps, GlifoIcon, GlifoIconProps } from 'glifo';Props de um ícone (GlifoIconProps)
Toda variante (mono, Color, Avatar, ...) aceita:
| Prop | Tipo | Padrão | Descrição |
|---|---|---|---|
size |
number | string |
24 |
largura e altura |
title |
string |
— | adiciona <title> (acessibilidade). Sem ele, o SVG é aria-hidden |
| ...rest | SVGProps |
— | className, style, onClick, fill, etc. |
GlifoIcon
Cada entrada do registry (e cada import nomeado) é o componente mono com propriedades extras:
| Campo | Tipo | Descrição |
|---|---|---|
.Color .Avatar .Text .Combine .Tag |
componentes | as variantes |
.slug |
string |
slug da marca |
.iconTitle |
string |
nome legível (ex: "GitHub") |
.hex |
string? |
cor da marca, sem # |
registry
import { registry } from 'glifo';
Object.values(registry).length; // +3.958
registry['github'].hex; // "181717"