Jamdesk Documentation logo

Ícones

O Jamdesk inclui o Font Awesome Pro. Use ícones em cards, callouts, navegação da barra lateral e texto inline com várias variantes de estilo.

O Jamdesk inclui o Font Awesome Pro: milhares de ícones gratuitos e pro.

Usar ícones em componentes

A maioria dos componentes aceita uma propriedade icon com o nome de um ícone do Font Awesome:

<Card title="Quickstart" icon="rocket" href="/quickstart">

  Learn how to set up your documentation site.

</Card>
Quickstart

Learn how to set up your documentation site.

Os ícones funcionam em Cards, Accordions, Tabs e itens de navegação.

O componente de ícone

Use o componente <Icon> para exibir ícones inline com o texto:

<Icon icon="check" color="green" /> Task completed

Task completed

Propriedades de ícones

PropriedadeTipoPadrãoDescrição
iconstringobrigatórioNome do ícone do Font Awesome
colorstring-Cor nomeada (red, blue, green) ou hex (#FF5733)
sizenumber16Tamanho em pixels

Exemplos

<Icon icon="star" color="yellow" size={24} />
<Icon icon="circle-check" color="green" />
<Icon icon="triangle-exclamation" color="orange" />
<Icon icon="heart" color="#E91E63" size={20} />

Encontrar ícones

Navegue pela biblioteca completa de ícones em fontawesome.com/icons. Pesquise o que você precisa e use o nome do ícone na sua documentação.

No site do Font Awesome, encontre o nome exibido abaixo do ícone (por exemplo, "circle-check", "arrow-right"). Use exatamente esse nome na sua documentação.

Ícones de marcas

O Jamdesk detecta automaticamente logos de tecnologias e empresas:

<Icon icon="github" size={24} />
<Icon icon="discord" size={24} />
<Icon icon="react" size={24} />
<Icon icon="python" size={24} />

Ícones de marcas comuns incluem:

CategoriaÍcones
Redes sociaisgithub, discord, twitter, linkedin, youtube, slack
Linguagenspython, react, vuejs, angular, node-js, php, java
Serviçosaws, docker, google, microsoft, stripe, shopify

Variantes de ícones

Os ícones do Font Awesome vêm em várias variantes de estilo que controlam o peso visual. Adicione um prefixo ao nome do ícone para escolher uma variante.

Variantes disponíveis

VariantePrefixoExemploDescrição
Solidsolid/solid/starÍcones preenchidos, peso mais forte
Regularregular/regular/starÍcones com contorno, peso médio
Lightlight/light/starÍcones com contorno mais finos
Thinthin/thin/starÍcones com contorno mais finos ainda
Duotoneduotone/duotone/starÍcones de dois tons com camadas de cor

A família Sharp do Font Awesome também está disponível, com cantos retos: sharp-solid/, sharp-regular/, sharp-light/, sharp-thin/ e sharp-duotone-solid/ (por exemplo, sharp-duotone-solid/star).

Exemplos

<Icon icon="solid/bell" size={24} />
<Icon icon="regular/bell" size={24} />
<Icon icon="light/bell" size={24} />
<Icon icon="thin/bell" size={24} />
<Icon icon="duotone/bell" size={24} />

Usar variantes em componentes

As variantes funcionam em qualquer lugar onde ícones são usados: componentes, navegação e frontmatter.

<Card title="Callouts" icon="light/bell" href="/components/callouts">

  Add important notices to your documentation.

</Card>
page.mdx
---
title: Settings
icon: light/gear
---
docs.json
{
  "group": "Account",
  "icon": "regular/user",
  "pages": ["profile", "settings"]
}

Formato de objeto de ícone

Em qualquer lugar onde o docs.json aceita um ícone (grupos de navegação, tabs, âncoras, ícones de páginas e popularPages da busca), você pode escrevê-lo como objeto em vez de string. O seletor de ícones do painel gera esta forma:

docs.json
{
  "group": "Security",
  "icon": { "name": "shield", "style": "duotone" }
}
CampoTipoDescrição
namestringNome do ícone do Font Awesome (obrigatório)
stylestringUma das variantes acima: solid, regular, light, thin, duotone ou uma variante sharp-*
librarystringfontawesome ou lucide, aceitos por compatibilidade; os ícones são renderizados via Font Awesome

{ "name": "shield", "style": "duotone" } é equivalente à string "duotone/shield". Use a que preferir. O icon do frontmatter (ícones de páginas) aceita apenas a forma de string.

Variante padrão

Os ícones são renderizados na variante Solid por padrão. Substitua-a em cada ícone com um prefixo de estilo (light/gear) ou, no docs.json, com o campo style da forma de objeto.

Comparar variantes

O mesmo ícone em cada variante:

VarianteÍconeIdeal para
SolidAções principais, ênfase
RegularElementos secundários da interface
LightDesigns minimalistas, navegação
ThinEstéticas ultraminimalistas
DuotoneInteresse visual, identidade de marca

Ícones duotone usam duas cores: uma tonalidade primária e uma secundária. A camada secundária é definida automaticamente com uma opacidade mais clara da cor primária.

Ícones de navegação

Ícones podem aparecer na navegação da barra lateral em três níveis: âncoras, grupos e páginas individuais.

Ícones de páginas

Adicione um ícone a qualquer página usando o frontmatter:

authentication.mdx
---
title: Authentication
icon: lock
---

O ícone aparece na barra lateral ao lado do título da página.

Ícones de grupos

Adicione ícones a grupos de navegação no docs.json:

docs.json
{
  "group": "Security",
  "icon": "shield",
  "pages": ["authentication", "api-keys"]
}

Ícones de âncoras

Adicione ícones a âncoras de nível superior no docs.json:

docs.json
{
  "navigation": {
    "anchors": [
      {
        "anchor": "Docs",
        "icon": "book-open",
        "groups": [...]
      },
      {
        "anchor": "API",
        "icon": "code",
        "groups": [...]
      }
    ]
  }
}

Ícones gratuitos e profissionais

O Jamdesk inclui o Font Awesome Pro, o que significa:

  • 7.000+ ícones disponíveis (contra cerca de 2.000 na versão gratuita)
  • Todos os ícones gratuitos funcionam sem nenhuma alteração
  • Ícones exclusivos do Pro, como as variantes duotone, estão incluídos
  • Ícones com peso light e thin disponíveis

Ícones de uma plataforma de documentação que usava o Font Awesome Free continuam funcionando após a migração.

O que vem a seguir?

Otimização de SEO

Melhore a descoberta e os metadados

Frontmatter

Defina títulos, descrições e campos de SEO