Beagle v1.6 is no longer actively maintained. The documented version you are viewing may contain deprecated functionality. For up-to-date documentation, see the latest version .
To use the Beagle library, it is necessary to create a Beagle Service setup to know where and how to search for server-driven screens.
On React you can easily create a Beagle Service through the function
On Angular the base code is automatically generated and the properties can be modify and added on beagle.module.ts.
The configuration object has the following properties:
|baseUrl||string||✓||URL to the server with screens (JSON) on Beagle format.|
|components||Map<string,Component>||✓||A components map that will be rendered through Beagle’s library. The values are key pairs and value where the key is identifier Beagle will always start by |
|strategy||Strategy||beagle-with-fallback-to-cache||Cache strategy applied on requests of the server screen.|
|fetchData||fetch||It allows to add a customized function t to make HTTP requests.|
|analytics||Analytics||It allows the use of handlers to the tag capture of some events.|
|customActions||Map<string,ActionHandler>||A customized action map that can be interpreted by Beagle’s library. It is a key and value map where the key will always be an identifier starting by |
|lifecycles||LifeCycleHook||A global map to add lifecycles behaviors of the components. Each cycle happens on the screen renderization process, before the components become HTML.|
|customStorage||Storage||localStorage||It replaces the localStorage default of the browsers.|
|useBeagleHeaders||boolean||true||It uses or not Beagle’s specific headers when it requests to the server screens.|
|navigationControllers||Map<string, NavigationController>||It allows you to add control options of the visual response, like show the no items of loading and errors components.|
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.