Referência da API
Cada página mostra a assinatura, os parâmetros, o retorno e um exemplo.
vitral
| Função | Para |
|---|---|
configure | Registrar remotes e opções do host |
register | Registrar um remote depois |
defineRemote | Escrever um remote à mão |
mountRemote | Montar sem componente |
createSlot | Montar com estado e nova tentativa |
loadModule | Baixar sem montar |
events | Eventos entre host e remotes |
navigate | Trocar de página |
provide | Criar estado compartilhado |
shared | Ler e alterar estado compartilhado |
persist | Guardar estado no navegador |
component | Remote em JS puro |
watchUpdates | Trocar de versão sem reload |
RemoteError | Erros |
Frameworks
| Import | Host | Remote |
|---|---|---|
vitral/react | <Remote> | reactRemote, hooks |
vitral/vue | <VitralRemote> | vueRemote |
vitral/angular | provideVitral | angularRemote |
vitral/svelte | use:remote | svelteRemote |
vitral/solid | <Remote> | solidRemote |
vitral/preact | <Remote> | preactRemote |
vitral/element | <vitral-remote> | elementRemote |
Ferramentas
| Import | Para |
|---|---|
vitral/vite | Plugin de build do remote |
vitral/routes | Rotas sem framework |
vitral/prefetch | Pré-carregar o remote da próxima rota |
vitral/iframe | Isolamento em iframe |
vitral/testing | Remotes falsos em testes |
vitral/devtools | Trocar URLs em desenvolvimento |
vitral/sentry | Erros no Sentry |
vitral/otel | Erros e Web Vitals no OpenTelemetry |
vitral/vitals | Web Vitals por remote e por rota |
vitral/single-spa | App do single-spa como remote |
vitral/federation | Remote do Module Federation no host |
vitral/dict | Servidor com dicionários de compressão (delta entre deploys) |
vitral/edge | Gateway de edge: uma origem só, Early Hints e SSR dos remotes |
| CLI | Tipos das props e migração |
A referência gerada pelo TypeDoc, com todos os tipos, está em /api/.