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:

AtributoTipoDefaultObrigatórioDescrição
baseUrlstringURL para o servidor com as telas (JSON) no formato Beagle
componentsMap<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
strategyStrategybeagle-with-fallback-to-cacheEstratégia de cache aplicada nas requisições de telas ao servidor
fetchDatafetchPermite adicionar uma função customizada para fazer requisições HTTP.
analyticsAnalyticsPermite o uso de handlers para a captura e tagueamento de alguns eventos.
customActionsMap<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.
lifecyclesLifeCycleHookUm 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
customStorageStoragelocalStorageSubstitui o localStorage padrão dos browsers
useBeagleHeadersbooleantrueUsar ou não headers específicos do Beagle ao fazer as requisições de telas para o servidor
navigationControllersMap<string, NavigationController>Permite adicionar opções de controle de reposta visual, como mostrar ou não itens de carregamento e componentes de erro