Parâmetros Beagle Service
Aprenda aqui quais são os parâmetros do Beagle Service.
Beagle Service
Para usar a biblioteca Beagle se faz necessária a criação de um Beagle Service com as configurações de onde e como buscar as telas server-driven.
No React você pode facilmente criar um Beagle Service por meio da função
createBeagleService(beagleServiceOptions)
No Angular o código base é gerado automaticamente e as propriedades podem ser modificadas e adicionadas em beagle.module.ts
O objeto de configuração possui as propriedades a seguir:
| Atributo | Tipo | Default | Obrigatório | Descrição |
|---|---|---|---|---|
| baseUrl | string | ✓ | URL para o servidor com as telas (JSON) no formato Beagle | |
| components | Record<<string,Component> | ✓ | Um mapa de componentes que serão renderizados através da biblioteca Beagle. Os valores são pares chave e valor onde a chave é o identificador Beagle e sempre começará por beagle: ou custom:. Já o valor será o componente ligado ao identificador | |
| fetchData | fetch | Permite adicionar uma função customizada para fazer requisições HTTP. | ||
| analyticsProvider | Analytics | Permite o uso de handlers para a captura e tagueamento de alguns eventos. | ||
| customActions | Record<string, ActionHandler> | Um mapa de ações customizadas que podem ser interpretadas pela biblioteca Beagle. É um mapa chave e valor onde a chave será sempre um identificador começado por beagle: ou custom: e o valor será o ActionHandler ligado aquela ação. | ||
| customOperations | Record<string, (any[]) => any> | Um mapa de operações adicionais para se usar em expressões do Beagle | ||
| lifecycles | LifeCycleHook | Um mapa global para adicionar comportamentos aos ciclos de vida dos componentes. Cada ciclo ocorre no processo de renderização das telas, antes dos componentes se tornarem HTML | ||
| defaultNavigationController | NavigationController | NavigationController padrão | NavigationController para se usar como o padrão nas navegações | |
| navigationControllers | Record<string, NavigationController> | Permite controlar os eventos de loading, erro e sucesso das navegações a partir do backend (controllerId) | ||
| viewClient | ViewClient | ViewClient padrão | Serviço responsável por recuperar views (páginas) do backend. Útil para implementar sistemas de cache. |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.
Última modificação 31/01/2022: feature: beagle orange (#837) (a117de55)