Drag Types and Drop Targets
Using drag and drop in an application allows users to click and drag an item from location to another within the user interface (UI). This feature is an intuiative way for users to interact with content, rearrange items, and trigger actions by dropping the oitems onto a designated area. enahnce user experience and make the application more engaging and easier to use.
In a PhixFlow application, you can configure drag-and-drop actions using actionflows and table actions. Some examples of drag and drop actions are:
- Dragging a record from a grid onto a delete area to remove it.
- Dragging a contact from one grid onto a specific company on a company table to move that contact to that company.
- Dragging items into different sections on a Kanban board to change the state of the record. See Making Kanban Boards.
Drag and Drop: Screen Setup
To set up drag and drop on components, a Drag Type on the object you are dragging from and a Drop Target on the object you are dropping onto is required. Components that can have drag types are grids and card components. Any component which has an actions tab can be a drop target. The action is configured on the drop target.
For example, to assign a new company to a contact a user creates two grids on a screen
- The contact and company table have a relationship and linked by a CompanyID field. The contact can be dragged and dropped onto a company to update CompanyID. The contact is the Drag Type and the company grid is the Drop Target.
Creating a Drag Type
- Open the properties for the view from which data will be dragged.
For example, right-click on the grid and select Show the View Configuration - Navigate to the Actions tab
In Action Settings → Drag Type, select or create a drag type, e.g. Move Contact.
This drag type needs to match the drag type defined on the drop target.
If using an actionflow, it is essential to add Drag Mappings to attributes from the source table to attributes used within the actionflow. If using table-actions, skip this step. In this example, we need to know the ID of the contact to be updated. To add Drag Mappings
Open the editor for the Drag Type by clicking on the field label
- Add an attribute and name this ContactID
- Change the Type to Integer
- Save the attribute
- In Action Settings → Drag Type Mappings, click Add Mapping to open the mapping popup.
- Map the ContactID from the Grid to ContactID on the Drag Type
Components with a drag type can be dragged and dropped onto any component which has a drop target with a matching drag type. It is on the drop target where the action is configured.
Creating a Drop Target
- Open the properties for the component where the data will be dropped. In the above example, this would be the Company grid.
- Navigate to the Actions tab.
- In Drop Targets, click Create New to create a new one.
- Provide a descriptive name, such as Move Contact to New Company
- Select the drag type (e.g. Move Contact) which matches the drag type of the component being dragged.
- Select the action to run when something of the same drag type is dropped onto this component.
- If setting up a table-action see Using the Drag Type and Drop Target in a Record-Action below.
- If setting up an actionflow, see Using the Drag Type and Drop Target in an Actionflow below
Worked Examples
Here's a worked example using the Company Data (available from the Learning Centre).
In this example, we are using:
- A Company Approval Review screen containing:
- a grid backed by the Companies table
- with a Background Filter to only companies where their Status does not equal Approved or Rejected
- two areas containing Approve and Reject icons - this screen was created using the Multi-Tile template
- a grid backed by the Companies table
If you are completing this chapter as part of the Actionflow course and using a training instance, the data and screens have already been pre-loaded into the Actionflow Advanced Application. For this example, we'll be working on the Company Approval Review screen.
Example 1: Approve Company Using Drag and Drop
In this example, we'll configure company records on a grid to be draggable, and setup an area on a screen to as a drop target to receive the record(s). When a company is dropped in the area, its Status will be updated to Approved.
Drag Type Setup
- Open the Company Approval Review screen
- Right-click on the Companies Pending Review grid and select Show the View Configuration
- Click the Actions tab
- In the Action Settings section, click the icon next to Drag Type to create a new drag type:
- Name:
Company
- Attributes: select
- Name:
CompanyID
- Type:
Integer
- Name:
- Apply and Close
- Name:
- A Drag Mappings section will become available in the Action Settings
- Click the Configure Mappings button
- Map across the CompanyID attribute from the Companies View to the Drag Type
- Click Confirm Mappings
- Apply and Close the View
Drop Target Setup
- On the Company Approval Review screen
- Click on the area holding the icon
- Ensure the Properties for the area, OuterBorderTop, is selected
- Click the Actions tab
- In the Drop Targets section, click the icon to add a new drop target:
- Name:
CompanyApproval
- Drag Type: Select the Company Drag Type you set up above
- Drop Action:
Actionflow
- Actionflow: click to create a new Actionflow
- Name:
Company Approval
- Name:
- Name:
Actionflow Setup
- Connect the input of the Company Drag Type
- Map in the CompanyID attribute
- Create a Calculate action
- Name:
Update Status and Audit
- Name:
- Add three Output Attributes:
- NewApprovedStatus: this should contain the new
- NewUpdatedByName: this should contain details of the user making the change using the internal variable _user - see Internal Variables
- Review the existing table data to see the formatting of the attribute
NewUpdatedByTime: this should contain the date and time the user updates the record
- Connect the input to the Calculate action
- Hover over the Calculate action and click, out
- Click anywhere on the canvas to create a new Save action
- Name:
Save Company
- Type:
Update
- Table:
Companies
- Name:
- Map across the three attributes created by the Calculate action onto their relevant attributes in the Companies table, and the CompanyID from the input
Testing
- On the Company Approval Review screen, Lock the screen
- Drag a company from the Companies Pending Review grid onto the Approve icon
- The company should be removed from this screen and instead appear on the Companies screen
Example 2: Reject Company Using Drag and Drop (Optional)
Repeat the steps above to set up the Reject area as a Drop Target. Remember to change the Expression in the Output Attribute to "Rejected".