Visualização
Crie documentação que se adapta à escolha de framework ou idioma do leitor. Seções inteiras mudam conforme a seleção do usuário.
Visualizações alternam seções inteiras de uma página para corresponder ao framework ou idioma do leitor. Abas mostram as opções lado a lado. Visualizações ocultam completamente o conteúdo não selecionado. Use-as quando seções inteiras diferirem entre frameworks.
Use Visualizações quando:
- Seções inteiras da página diferirem por framework (e não apenas trechos de código)
- Tutoriais tiverem etapas diferentes para tecnologias diferentes
- Guias de primeiros passos diferirem por plataforma
Uso básico
Crie visualizações para diferentes linguagens:
<View title="JavaScript" icon="js">
This content is only visible when JavaScript is selected.
```javascript
console.log("Hello from JavaScript!");
```
</View>
<View title="Python" icon="python">
This content is only visible when Python is selected.
```python
print("Hello from Python!")
```
</View>
Como funciona
Uma página com componentes View funciona assim:
- Um seletor suspenso aparece no topo do conteúdo
- Os leitores alternam entre as visualizações pelo seletor suspenso
- Apenas o conteúdo da visualização selecionada fica visível
View vs Tabs vs CodeGroup
| Componente | Melhor para | Escopo |
|---|---|---|
| View | Seções inteiras que diferem por framework | Alternância de conteúdo em toda a página |
| Tabs | Comparações rápidas, gerenciadores de pacotes | Alternância de conteúdo em linha |
| CodeGroup | A mesma operação em múltiplas linguagens | Apenas blocos de código |
Exemplos de cenários:
- "Instalar com npm vs yarn" → Tabs (pequena diferença)
- "fetch em JavaScript vs requests em Python" → CodeGroup (comparação de código)
- "Tutorial React vs tutorial Vue" → View (seção inteira diferente)
Props
stringrequiredO título exibido no seletor suspenso. Deve ser único dentro da página.
stringUm ícone do Font Awesome, URL para um ícone ou caminho relativo para um ícone.
stringdefault: solidApenas para ícones do Font Awesome. Opções: regular, solid, light, thin, sharp-solid, duotone, brands.
