Skip to main content

Angular Material Drag And Drop UI Component(Part-1)


Angular Material Drag And Drop CDK provides a set of rich functionalities like as below:
  • Able to apply to drag functionality on any HTML elements with free motion over a page
  • Sorting list of HTML rendered items.
  • Custom drag handlers
  • Custom drag place holders
  • Limit the area to drag for an item.
This article is a series of parts where we going to discuss and understand all the features provided by drag and drop CDK.

Create An Angular Sample Application:

To understand step by step implementation of drag and drop functionalities, let's create a sample angular application.
Command to create angular application:

ng new your-project-name
Command to install angular material package:

ng add @angular/material

Import DragDropModule:

DragDropModule is loaded from '@angular/cdk/drag-drop' package. Now we need to import this DragDropModule on to the NgModule of the app module to get all features of it.
src/app/app.module.ts:
import { DragDropModule } from '@angular/cdk/drag-drop';

@NgModule({
  imports: [DragDropModule]
})
export class AppModule {}
// code hidden due to display purpose

cdkDrag Directive:

Adding cdkDrag Directive on an HTML element will get the ability to drag and drop.

Simple Example On Drag And Drop With cdkDrag Directive:

Let's create a simple example on drag and drop with cdkDrag directive as follows.
src/app/cdkDragSample/cdk.drag.sample.component.ts:
import { Component } from '@angular/core';

@Component({
    selector:'cdk-drag-sample',
    templateUrl:'cdk.drag.sample.component.html',
    styleUrls:['cdk.drag.sample.component.css']
})
export class CdkDragSampleComponent {

}
Now add the following CSS styles to the component styles file
src/app/cdkDragSample/cdk.drag.sample.component.css:
.my-box {
    width: 200px;
    height: 200px;
    border: solid 1px #ccc;
    color: rgba(0, 0, 0, 0.87);
    cursor: move;
    display: flex;
    justify-content: center;
    align-items: center;
    text-align: center;
    background: #fff;
    border-radius: 4px;
    position: relative;
    z-index: 1;
    transition: box-shadow 200ms cubic-bezier(0, 0, 0.2, 1);
    box-shadow: 0 3px 1px -2px rgba(0, 0, 0, 0.2),
                0 2px 2px 0 rgba(0, 0, 0, 0.14),
                0 1px 5px 0 rgba(0, 0, 0, 0.12);
  }
  
  .my-box:active {
    box-shadow: 0 5px 5px -3px rgba(0, 0, 0, 0.2),
                0 8px 10px 1px rgba(0, 0, 0, 0.14),
                0 3px 14px 2px rgba(0, 0, 0, 0.12);
  }
Now let add HTML element with cdkDrag directive on it.
src/app/cdkDragSample/cdk.drag.sample.component.html:
<div class="my-box" cdkDrag>
    Hey you can drag me!
    Because i use cdKDrag directive
</div>
#L1 at this line cdkDrag directive decorated on 'div' element. Now this 'div' element has the capability of drag and drops on any place on a page.

Now let's run the application and output shows as below.

cdkDropList Directive:

cdkDropList directive applied over the group of Html elements each is decorated with cdkDrag directive. By using the cdkDropList directive we can do list elements ordering within its range. So the cdkDropList directive will act as a parent to the group of cdkDrag directives.

Drag And Drop List Of Elements By Using cdkDropList Directive:

Let's start creating a sample application for the Html element list sorting using the cdkDropList Directive.
src/app/listOrder/list.order.component.ts:
import { Component } from '@angular/core';

@Component({
    selector:'list-order',
    templateUrl:'list.order.component.html',
    styleUrls:['list.order.component.css']
})
export class ListOrderComponent {
    players = [
       'Rohit Sharma',
       'Shikar Dhawan',
       'Virat Kohli',
       'Ms Dhoni',
       'Ambati Rayudu',
       'Hardik Pandya'
    ];
}
#L9-L16 at these lines array of data that is going to be rendered as a list.

Let's add the following styles in the component styles file.
src/app/listOrder/list.order.component.css:
.my-list {
    width: 500px;
    max-width: 100%;
    border: solid 1px #ccc;
    min-height: 60px;
    display: block;
    background: white;
    border-radius: 4px;
    overflow: hidden;
  }
  
  .my-box {
    padding: 20px 10px;
    border-bottom: solid 1px #ccc;
    color: rgba(0, 0, 0, 0.87);
    display: flex;
    flex-direction: row;
    align-items: center;
    justify-content: space-between;
    box-sizing: border-box;
    cursor: move;
    background: white;
    font-size: 14px;
  }
  
  .cdk-drag-preview {
    box-sizing: border-box;
    border-radius: 4px;
    box-shadow: 0 5px 5px -3px rgba(0, 0, 0, 0.2),
                0 8px 10px 1px rgba(0, 0, 0, 0.14),
                0 3px 14px 2px rgba(0, 0, 0, 0.12);
  }
  
  .cdk-drag-placeholder {
    opacity: 0;
  }
  
  .cdk-drag-animating {
    transition: transform 250ms cubic-bezier(0, 0, 0.2, 1);
  }
  
  .my-box:last-child {
    border: none;
  }
  
  .my-list.cdk-drop-list-dragging .my-box:not(.cdk-drag-placeholder) {
    transition: transform 250ms cubic-bezier(0, 0, 0.2, 1);
  }
Let's add the component Html as follows.
src/app/listOrder/list.order.component.html:
<div class="my-list" cdkDropList>
    <div class="my-box" *ngFor="let player of players" cdkDrag>
        {{player}}
    </div>
</div>
  • #L1 at this line parent div element decorated with cdkDropList directive.
  • #L2 at this line div element decorated with cdkDrag directive makes this element as draggable. Since it, parent element decorated with cdKDropList all the draggable elements inside of it will be sorted within its range. "players" is a component array of data property that will get render by looping the data.
Now, reference this list order component HTML selector on to the app component HTML as below.
src/app/app.component.html:
<list-order></list-order>
Now import the list order component to the app module as below.
import { ListOrderComponent } from './listOrder/list.order.component';

@NgModule({
  declarations: [
    ListOrderComponent,
  ]
})
export class AppModule {}
// code hidden for display purpose
Now run the application and output shows as below.

Above Example Result:

We can observe in above example we are able to drag and drop the element with in the cdkDropList range. But after drag and drop item, we can observe that items refreshed back to original positions, means the result looks same as on pageload. It looks like drog and drop not working. But what happens actually is html element gets drag and dropped successfully, but the data binded(players component property) will not get sorted automatically on using cdkDropList dirctive.

so to fix the result of this example we need to use 'cdkDropListDropped' event.

cdkDropListDropped Event:

cdkDropListDropped event used to update the component data on dragging and dropping of an element.

Let's add a method that will be invoked by the cdkDrpListDropped event as follows.
src/app/listOrder/list.order.component.ts:(update file)
import {CdkDragDrop, moveItemInArray} from '@angular/cdk/drag-drop';
@Component({
    selector:'list-order',
    templateUrl:'list.order.component.html',
    styleUrls:['list.order.component.css']
})
export class ListOrderComponent {
    drop(event:CdkDragDrop<string[]>){
        moveItemInArray(this.players, event.previousIndex, event.currentIndex);
    }
}
// code hidden for display purpose
  • #L1 at this line CdkDragDrop instance and moveItemInArry method are get imported from '@angular/cd/drag-drop' package
  • CdkDragDrop is an instance of the generic type where can capture event data of the cdkDropListDroped event.
  • moveItemInArray is a method, that takes our array of data as input it will sort the data as per drag and drop element indexing.
  • #L8-L10 at these lines 'drop' a component method is created and this method will be registered to listen for the cdkDropListDropped event.
  • #L9 at this line moveItemInArray method gets called by inputting our 'players' property which of type array of objects and then index values to as input values to sort the 'players' property data based on drag and drop position.
Let's register Html with cdkDropListDropped event as below
src/app/listOrder/list.order.component.html:(update file)
<div class="my-list" cdkDropList (cdkDropListDropped)="drop($event)">
    <div class="my-box" *ngFor="let player of players" cdkDrag>
        {{player}}
    </div>
</div>
#L1 at this line 'cdkDropListDropped' event registered with 'drop'(method in component)

Now run the application and output shows as below.
After dragging and dropping output shows as below
Now we observe data get successfully updated on dragging and dropping of an element.

Sample Example Using Data Object Array:

Previously we used data objects as an array of string values, now we going to replace it with an array of object models.

src/app/listOrder/list.order.component.ts:(update file)
import { Component } from '@angular/core';
import {CdkDragDrop, moveItemInArray} from '@angular/cdk/drag-drop';

@Component({
    selector:'list-order',
    templateUrl:'list.order.component.html',
    styleUrls:['list.order.component.css']
})
export class ListOrderComponent {
    players:any[]=[{
        id: 1,
        Name:"Rohit Sharma",
        Position:1 
    },{
        id:2,
        Name:"Virat Kohli",
        Position:2
    },{
        id:3,
        Name:"MS Dhoni",
        Position:3
    },{
        id:4,
        Name:"Shikar Dhawan",
        Position:4
    },{
        id:5,
        Name:"Ambati Rayudu",
        Position:5
    }]

    drop(event:CdkDragDrop<string[]>){
        moveItemInArray(this.players, event.previousIndex, event.currentIndex);
        this.players.forEach((value, index) => {
            value.Position = (index + 1);
        });
    }
}
  • #L10-L30 at these lines array of players object initialized(previously we used an array of string values).
  • #L33 at this line moveItemInArray sorts the object based on drag and drop indexes.
  • #L34-L36 at these lines since moveItemInArray method sorts "players" array object, after that we can update the correct 'Position' value using its index.
Let's update the Html code as follows.
src/app/listOrder/list.order.component.html:(update file)
<div class="my-list" cdkDropList (cdkDropListDropped)="drop($event)">
    <div class="my-box" *ngFor="let player of players" cdkDrag>
        Name: {{player.Name}},   Position:{{player.Position}}
    </div>
</div>
Now run the application and output shows as below.
After drag and drop, the output shows as below.

Wrapping Up:

Hopefully, I think this article delivered some useful information on the Drag and Drop Angular Material CDK. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:


Follow Me:

Comments

Popular posts from this blog

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo