Overview

Here you’ll find all about action’s components and its attributes details.

What is it?

On Beagle, an action deals with behaviours (functions), that are performed in your application when an event is triggered. These actions can be a Beagle’s default or customized by you.

Any Beagle’s event must be associated with an action list. See below a button’s component example, that associates with a default action alert to its onPress event:

{
   "_beagleComponent_": "beagle:button",
   "text": "click to show alert",
   "onPress": [{
      "_beagleAction_": "beagle:alert",
      "title": "Hello",
      "message": "World"
   }]
}

An action is map key/value with at least a _beagleAction_ property. Its value indicates which action must be performed when the event it is triggered. The other properties specify the parameters expected by the indicated action.

There are several default implemented actions on Beagle and all of them start with “beagle:” prefix and the customized actions start with “custom:”.

To learn how to create custom actions, check out Beagle’s customization section.

Action types

Below, you will find a complete description of the attributes that are part of the Standard Actions on Beagle.


AddChildren

You will find here AddChildren definition and its attributes details

Alert

You will find here Alert definition and its attributes details

Condition

You will find here the definition of Condition and more details about its attributes

Confirm

You will find here Confirm definition and its attributes details

FormLocalAction

You will find here the definition of FormLocalAction and details about its attributes.

FormRemoteAction

You will find here the definition of FormRemoteAction and details about its attributes.

FormValidation

You will find here the definition of FormValidation and details about its attributes.

Navigate

Here you’ll find action Navigate definition and pages for each of its attributes

SendRequest

You will find here SendRequest definition and its attributes details

SetContext

Here you’ll find a definition for SetContext and its attributes details

SubmitForm

You will find here the definition of SubmitForm and more details about its attributes


Last modified March 11, 2021: feat: section overview (#391) (2c91101e)