Manipulate ListView as Grid Layout

17 Feb 202218 minutes to read

In Listview, list items can be rendered in grid layout with following data manipulations.

  • Add Item

  • Remove Item

  • Sort Items

  • Filter Items

Grid Layout

In this section, we will discuss about rendering of list items in grid layout.

  • Initialize and render ListView with dataSource which will render list items in list layout.

  • Now, add the below CSS to list item. This will make list items to render in grid layout

#element .e-list-item {
        height: 100px;
        width: 100px;
        float: left;
}

In the below sample, we have rendered List items in grid layout.

@using Syncfusion.EJ2
@using Syncfusion.EJ2.Lists;
@{
    var template = "<img id='listImage' src='./apple.png' alt='apple' />";
}

<!-- ListView element -->
@Html.EJS().ListView("element").DataSource((IEnumerable<object>)ViewBag.dataSource).Template(template).Render()

<style>

#element {
    display: block;
    max-width: 303px;
    margin: auto;
    border: 1px solid #dddddd;
    border-radius: 3px;
}

#element .e-list-item {
    height: 100px;
    width: 100px;
    float: left;
    padding: 0;
}

#listImage {
    width: 55px;
    height: 55px;
    margin-left: 20px;
    margin-top: 20px;

}

</style>
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;

namespace WebApplication1.Controllers
{
    public class ListViewController : Controller
    {
        public IActionResult list()
        {   
            string[] listdata = { "1","2", "3", "4", "5", "6", "7", "8", "9" };
            ViewBag.dataSource = listdata;
            return View();
        }       
    }
}

Data manipulation

In this section, we will discuss about ListView data manipulations.

Add Item

We can add list item using addItem API. This will accept array of data as argument.

 listViewInstance.addItem([{text: 'Apricot', id: '32'}]);

In the below sample, you can add new fruit item by clicking add button which will open dialog box with fruit name and image URL text box. After entering the item details, click the add button. This will add your new fruit item.

Remove item

We can remove list item using removeItem API. This will accept fields with id or list item element as argument.

 listViewInstance.removeItem({id: '32'});

In the below sample, you can remove fruit by hovering the fruit item which will show delete button and click that delete button to delete that fruit from your list.

Sort Items

Listview can be sorted either in Ascending or Descending order. To enable sorting in your ListView, set sortOrder as Ascending or Descending.

@Html.EJS().ListView("element").SortOrder(SortOrder.Ascending).Render()

We can also set sorting after component initialization.

listViewInstance.sortOrder = 'Ascending'

In the below sample, we have sorted fruits in Ascending order. To sort it in descending, click on sort order icon and vice versa.

@using Syncfusion.EJ2
@using Syncfusion.EJ2.Lists;
@using Syncfusion.EJ2.Popups;
@{
    var template = "<div class='fruits'><div class='first'><img id='listImage' src='${ imgUrl}' alt='fruit' /><button class='delete e-control e-btn e-small e-round e-delete-btn e-primary e-icon-btn' data-ripple='true'><span class='e-btn-icon e-icons delete-icon'></span></button></div><div class='fruitName'>${text}</div></div>";
}
<div id="container">
    <div class="headerContainer">
        <div class="e-input-group">
            <input id="search" class="e-input" type="text" placeholder="Search fruits" />
            <span class="e-input-group-icon e-input-search"></span>
        </div>
        <button id="sort" class="e-control e-btn e-small e-round e-primary e-icon-btn" title="Sort fruits" data-ripple="true">
            <span class="e-btn-icon e-icons e-sort-icon-ascending"></span>
        </button>
        <button id="add" class="e-control e-btn e-small e-round e-primary e-icon-btn" title="Add fruit" data-ripple="true">
            <span class="e-btn-icon e-icons e-add-icon"></span>
        </button>
        @Html.EJS().Dialog("dialog").ShowCloseIcon(true).Buttons(ViewBag.DialogButtons).Content("<div id='listDialog'><div class='input_name'><label for='name'>Fruit Name: </label><input id='name' class='e-input' type='text' placeholder='Enter fruit name' /></div><div><label for='imgurl'>Fruit Image: </label><input id='imgurl' class='e-input' type='text' placeholder='Enter image url' /></div></div>").Header("Add fruit").Width("300px").Visible(false).Render()
        <!-- ListView element -->
        @Html.EJS().ListView("element").DataSource((IEnumerable<object>)ViewBag.dataSource).ActionComplete("wireEvents").Template(template).SortOrder(SortOrder.Ascending).Render()
    </div>
</div>
 <style>
    #listImage {
        width: 55px;
        height: 55px;
        margin-left: 25px;
    }

    #container {
        max-width: 440px;
        margin: auto;
        margin-top: 130px;
        box-shadow: 0 3px 6px lightgray;
    }
    #dialog {
    top:auto !important;
    }
    .headerContainer {
        height: 48px;
        line-height: 48px;
        background: rgb(2, 120, 215);
        color: white;
        margin-bottom: 3px;
    }

    .headerContainer .e-input-group {
        margin-left: 20px;
        width: 200px;
        background: white;
        height: 31px;
    }

    .headerContainer #search {
        height: 21px;
        margin-left: 10px;
    }

    #listDialog .input_name {
        margin-bottom: 20px;
    }

    .headerContainer #add,
    .headerContainer #sort {
        float: right;
        margin-right: 15px;
        margin-top: 7px;
        background: white;
        color: black;
    }

    .headerContainer .e-input-search::before {
        font-family: 'e-icons';
        content: '\e961';
        margin-top: 3px;
    }

    .headerContainer .e-input-group .e-input-group-icon.e-input-search {
        padding: 0 10px 0 10px;
    }

    #element .e-list-item {
        height: 110px;
        width: 110px;
        float: left;
        padding: 0;
        position: relative;
        user-select: none;
    }

    #element .e-delete-btn {
        float: right;
        visibility: hidden;
        margin-top: -10px;
    }

    #element .e-delete-btn.e-btn.e-small.e-round {
        width: 2em;
        height: 2em;
    }

    #element .e-btn.e-small.e-round .e-btn-icon.delete-icon {
        font-size: 9px;
    }

    #element .e-list-item:hover .e-delete-btn {
        visibility: visible;
        background: red;
        border-radius: 50%;
    }

    #element .fruits {
        height: inherit;
        width: inherit;
        padding: 10px 0 10px 0;
    }

    #element .fruitName {
        text-align: center;
    }

    .headerContainer .e-add-icon::before {
        content: '\e823';
    }

    #element .delete-icon::before {
        content: '\e7fc';
        color: white;
    }

    .headerContainer .e-sort-icon-ascending::before {
        content: '\e840';
    }

    .headerContainer .e-sort-icon-descending::before {
        content: '\e83f';
    }
</style>
<script>
    var fruitsdata  = @(Html.Raw(Newtonsoft.Json.JsonConvert.SerializeObject(ViewBag.dataSource)));

    var listViewInstance;
    window.onload = function () {
        listViewInstance = document.getElementById("element").ej2_instances[0];
    }

    function addItem() {
        var dialogObj = document.getElementById("dialog").ej2_instances[0];
        (document.getElementById("name")).value = "";
        (document.getElementById("imgurl")).value = "";
        dialogObj.show()
    }

    function wireEvents() {
        Array.prototype.forEach.call(document.getElementsByClassName('e-delete-btn'), (ele) => {
            ele.addEventListener('click', onDeleteBtnClick);
        });
        document.getElementById("add").addEventListener('click', addItem);
        document.getElementById("sort").addEventListener('click', sortItems);
        document.getElementById("search").addEventListener("keyup", onKeyUp);
    }

    //Here we are removing list item
    function onDeleteBtnClick(e) {
        e.stopPropagation();
        var li = e.currentTarget.closest(".e-list-item");
        var data = listViewInstance.findItem(li);
        listViewInstance.removeItem(data);
        new ej.data.DataManager(fruitsdata).remove('id', { id: (data)["id"] });
    }

    //Here we are adding list item
    function dlgButtonClick() {
        var dialogObj = document.getElementById("dialog").ej2_instances[0];
        var name = (document.getElementById("name")).value;
        var url = (document.getElementById("imgurl")).value;
        var id = Math.random() * 10000;
        listViewInstance.addItem([{ text: name, id: id, imgUrl: url }]);
        fruitsdata.push({ text: name, id: id, imgUrl: url });
        listViewInstance.element.querySelector('[data-uid="' + id + '"]').getElementsByClassName('e-delete-btn')[0].addEventListener('click', onDeleteBtnClick);
        dialogObj.hide();
    }

    //Here we are sorting list item
    function sortItems() {
        var ele = document.getElementById("sort").firstElementChild;
        var des = ele.classList.contains('e-sort-icon-descending') ? true : false;
        if (des) {
            ele.classList.remove('e-sort-icon-descending');
            ele.classList.add('e-sort-icon-ascending');
            listViewInstance.sortOrder = 'Ascending'
        } else {
            ele.classList.remove('e-sort-icon-ascending');
            ele.classList.add('e-sort-icon-descending');
            listViewInstance.sortOrder = 'Descending'
        }
        listViewInstance.dataBind();
        wireEvents();
    }

    //Here, the list items are filtered using the DataManager instance.
    function onKeyUp() {
        var value = (document.getElementById("search")).value;
        var data = new ej.data.DataManager(fruitsdata).executeLocal(
            new ej.data.Query().where("text", "startswith", value, true)
        );
        if (!value) {
            listViewInstance.dataSource = fruitsdata.slice();
        } else {
            listViewInstance.dataSource = data;
            listViewInstance.dataBind();
        }
    }
</script>
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Syncfusion.EJ2.Popups;

namespace WebApplication1.Controllers
{
    public class ListViewController : Controller
    {
        public IActionResult list()
        {
            List<DialogDialogButton> button = new List<DialogDialogButton>();
            List<object> listdata = new List<object>();
            listdata.Add(new { text = "Date", id = "1", imgUrl = "./dates.jpg" });
            listdata.Add(new { text = "Fig", id = "2", imgUrl = "./fig.jpg" });
            listdata.Add(new { text = "Apple", id = "3", imgUrl = "./apple.png" });
            listdata.Add(new { text = "Apricot", id = "4", imgUrl = "./apricot.jpg" });
            listdata.Add(new { text = "Grape", id = "5", imgUrl = "./grape.jpg" });
            listdata.Add(new { text = "Strawberry", id = "6", imgUrl = "./strawberry.jpg" });
            listdata.Add(new { text = "Pineapple", id = "7", imgUrl = "./pineapple.jpg" });
            listdata.Add(new { text = "Melon", id = "8", imgUrl = "./melon.jpg" });
            listdata.Add(new { text = "Lemon", id = "9", imgUrl = "./lemon.jpg" });
            listdata.Add(new { text = "Cherry", id = "10", imgUrl = "./cherry.jpg" });
            ViewBag.dataSource = listdata;
            button.Add(new DialogDialogButton() { Click = "dlgButtonClick", ButtonModel = new ButtonModel() { isPrimary = true, content = "Add" } });
            ViewBag.DialogButtons = button;
            return View();

        }
        public class ButtonModel
        {
            public string content { get; set; }
            public bool isPrimary { get; set; }

        }
    }
}