BeagleWidget
O que é?
Um widget que mostra conteúdos do Beagle. Este é o ponto de entrada para carregar telas server-driven e componentes visuais server-driven para sua aplicação Flutter. O BeagleWidget é um StatefulWidget que renderiza widgets através de um JSON local ou uma requisição HTTP.
Veja como a estrutura é representada:
| Atributo | Tipo | Obrigatório | Definição |
|---|---|---|---|
| key | Key | Identificador para Widgets, Elements e SemanticsNodes. | |
| screenRequest | BeagleScreenRequest | Provê a url, method, headers e body para a requisição. | |
| screenJson | String | Representa uma tela local para ser mostrada. | |
| onCreateView | OnCreateViewListener | Função que retorna o BeagleView atual. |
BeagleScreenRequest
É uma classe usada para fazer requisições no Beagle Flutter. Ela implementa o BeagleNetworkOptions que traz os atributos method, headers e strategy. Também, a classe BeagleScreenRequest tem as propriedades url e body. Veja a estrutura abaixo:
| Atributo | Tipo | Obrigatório | Definição |
|---|---|---|---|
| url | String | ✓ | Representa a URL relativa do servidor da requisição. |
| body | String | Conteúdo que vai ser entregue pela requisição. | |
| headers | Map<String, String> | Headers para serem usados na requisição. | |
| method | BeagleHttpMethod | Método Http para indicar a ação desejada para ser perfomada por um dado recurso. Pode ser put, get, post, delete, patch e head. | |
| strategy | BeagleNetworkStrategy | Estratégia de cache aplicada para a requisição. Pode ser beagleCacheOnly, beagleWithFallbackToCache, networkWithFallbackToCache, cacheWithFallbackToNetwork, cacheOnly, networkOnly e cacheFirst. |
OnCreateViewListener
Uma função que segue a estrutura void Function(BeagleView view) e provê a atual BeagleView quando está disponível.
Como usar?
Voce pode usá-lo em qualquer lugar que exiba conteúdo server-driven.
- Posicione o
BeagleWidgetlá informando pelo menos um JSON local ou umaBeagleScreenRequestcom aurldo seu BFF.
No exemplo abaixo, você vai ver o BeagleWidget no corpo do widget Scaffold:
Scaffold(
appBar: AppBar(
title: const Text('Beagle Sample'),
),
body: BeagleWidget(
screenRequest: BeagleScreenRequest('components'),
),
);
BeagleSdk.init passando pelo menos a propriedade baseUrl antes de usar o BeagleWidget.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.