Introduction

Component Events enables interactions between page components with event triggering and event listening using AJAX, a technology that allows web pages to communicate with a server behind the scenes. This means that specific parts of a web page can update or exchange data without requiring the entire page to reload, making the user experience more seamless and responsive.

Example - Meeting Date Management

Expected Outcome

When a user clicks on the "Edit" button, a "Edit Meeting Details" form appears below the table without reloading the entire webpage.

Figure 1: The expected outcome through the proper implementation of a component event.

You may learn more about Component Events by visiting the Joget DX Showcase application in the App Center, then clicking on New In DX 8 > Component Events.

Figure 2: How to get to the Component Events showcase in the Joget DX Showcase application.

Required Components

Steps

1. Make sure all the required components exist within an application.
2. (From component 3) Click "Edit Page Components".
   
   Figure 9: The location to find the "Edit Page Component" button.
   
   
3. Add 2 components to the Design: CRUD and Form.
   
   Figure 10: The location to find and add the CRUD and Form component in the Design page.
   
   
4. Configure the CRUD component's properties as such:
   

   1. Under Configure CRUD:
      

      Form Label	Value
      Label *	Manage Meeting
      List *	List - Calendar - Meeting
      Form (Edit)	Calendar - Meeting

      
      Figure 11: The required configuration in the Configure CRUD property.
      
      

   2. Under AJAX & Events:

      Form Label		Value
      Handle Component with AJAX?		(Checked) - Checking this label will enable the following sub-properties.
      Event Listening
      Row 1	Component Object	*Form This Form Component Object can only be properly configured after configuring the Event Triggering sub-property of the Form component. This instruction can be found in step 8 (c).
      	Event Name *	reload_table
      	Matched Action	Show and Reload Component
      	The application listens for a 'reload_table' event. When the event is triggered, it shows and reloads the Form component object.
      Event Triggering
      Row 1	Event Name *	load_form
      	Trigger Method *	Link Clicked
      	Parameters Changed Rules Row Parameter Name * Operator Value 1 _mode Equals To edit These parameters are required to trigger the "Link Clicked" Trigger Method. For instance, in this context, when the parameter name "_mode" is equals to "edit", then the "Link Clicked" Trigger Method is triggered.
      	When Not Match Trigger Event Name	hide_form
      	When the "Link Clicked" trigger method is activated, it initiates the "load_form" event.

      
      Figure 12: The required configuration in the AJAX & Events property.
      
      

5. Result (with added data) after completing step 4 as shown in the below figure 13.
   

   This Form Component Object can only be properly configured after configuring the Event Triggering sub-property of the Form component. This instruction can be found in step 8.

   
   Figure 13: The outcome after properly configuring the CRUD component.
   
   

6. Save the new configuration.
7. Add a Form component to the Design.
   
   Figure 14: The outcome after properly configuring the CRUD component.
   
   
8. Configure the Form component's properties as such:

   1. Under Configure Form:

      Form Label	Value
      Label *	Form
      Form *	Calendar - Meeting
      Display Field as Label When Readonly?	(unchecked)

      
      Figure 15: The required configuration in the Configure Form property.
      
      

   2. Under Redirection:

      Form Label	Value
      URL Redirect on Cancellation	?close=true

      
      Figure 16: The required configuration in the Redirection property.
      
      

   3. Under AJAX & Events:

      Form Label		Value
      Handle Component with AJAX?		(Checked) - Checking this label will enable the following sub-properties.
      Event Listening
      Row 1	Component Object	Manage Meeting
      	Event Name *	hide_form
      	Matched Action	Hide Component
      	The application listens for a 'hide_form' event. When the event is triggered, it hides the "Manage Meeting" component object.
      Row 2	Component Object	Manage Meeting
      	Event Name *	load_form
      	Matched Action	Show and Change Component URL Parameters
      	Parameters * Row Parameter Name * Parameter Value 1 id {id} 2 close false 3 _action edit 4 _mode edit
      	The application listens for a 'load_form' event. When the event is triggered, it shows and changes the component URL parameters in the "Manage Meeting" component object.
      Row 3	Component Object	Main Menu Component
      	Event Name *	page_loaded
      	Matched Action	Hide Component
      	The application listens for a 'page_loaded' event. When the event is triggered, it hides the Main Menu Component component object.
      Row 4	Component Object	*Form This Form Component Object can only be properly configured after configuring the Event Triggering sub-property of the Form component. This instruction can be found in step 8 (c).
      	Event Name *	hide_form
      	Matched Action	Hide Component
      	The application listens for a 'hide_form' event. When the event is triggered, it hides the Form component object.
      Event Triggering
      Row 1	Event Name *	hide_form
      	Trigger Method *	GET Request
      	Parameters Changed Rules Row Parameter Name * Operator Value 1 close Equals To true These parameters are required to trigger the "GET Request" Trigger Method. For instance, in this context, when the parameter name "close" is equals to "true", then the "GET Request" Trigger Method is triggered.
      	When the "GET Request" trigger method is activated, it initiates the "hide_form" event.
      Row 2	Event Name *	reload_table
      	Trigger Method *	POST Request
      	When the "Link Clicked" trigger method is activated, it initiates the "reload_table" event.

      
      Figure 17: The required configuration in the AJAX & Events property (partial).
      
      
      Figure 18: The required configuration in the AJAX & Events property (partial).
      
      
      Figure 19: The required configuration in the AJAX & Events property (partial).
      
      

9. Result from completing step 8 as shown in the below figure 20.
   
   Figure 20: The outcome after properly configuring the Form component.
   
   
10. Remember to revisit steps 4 (b) and 8 (c) to change the Component Objects from 'Main Menu Component' to 'Form'.
11. Save the new configuration.
12. You have completed all the required steps to achieve the expected outcome.